< Back
Get-ComponentStatus
Post
NAME Get-ComponentStatus
SYNOPSIS
SYNTAX
Get-ComponentStatus [[-ComponentType] <String>] [-ComponentId] <Int32> [-RestServer] <String> [<CommonParameters>]
DESCRIPTION
This function will gather Status information from PembrokePS web/rest.
PARAMETERS
-ComponentType <String>
A Component type is required.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComponentId <Int32>
An ID is required.
Required? true
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RestServer <String>
A Rest Server is required.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Collections.Hashtable
NOTES
This will return a hashtable of data from the PPS database.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ComponentStatus -ComponentType Queue_Manager -ComponentId 1 -RestServer localhost
RELATED LINKS
SYNOPSIS
SYNTAX
Get-ComponentStatus [[-ComponentType] <String>] [-ComponentId] <Int32> [-RestServer] <String> [<CommonParameters>]
DESCRIPTION
This function will gather Status information from PembrokePS web/rest.
PARAMETERS
-ComponentType <String>
A Component type is required.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComponentId <Int32>
An ID is required.
Required? true
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RestServer <String>
A Rest Server is required.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Collections.Hashtable
NOTES
This will return a hashtable of data from the PPS database.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ComponentStatus -ComponentType Queue_Manager -ComponentId 1 -RestServer localhost
RELATED LINKS