Get-SCSMQueue
Get-SCSMQueue
Retrieves queues that are defined in Service Manager.
Syntax
Parameter Set: FromDisplayName
Get-SCSMQueue [[-DisplayName] <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromId
Get-SCSMQueue [-Id] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCSMQueue cmdlets retrieves queues that are defined in Service Manager.
Parameters
-ComputerName<String[]>
Specifies the server on which the System Center Data Access service is running.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credential to use when you are connecting to the System Center Data Access service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-DisplayName<String[]>
Specifies the display name of the queue to retrieve.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
true |
-Id<Guid[]>
Specifies the ID of the queue to retrieve.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies the object that represents the session to a Service Manager management server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
System.String
You can pipe a name to the DisplayName parameter of the
Get-SCSMQueue
cmdlet.System.Guid
You can pipe a GUID to the Id parameter of the
Get-SCSMQueue
cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
WorkItemGroup
This cmdlet returns a unique WorkItemGroup queue object.
Examples
------------------------- EXAMPLE 1 --------------------------
This command retrieves all the queues that are available in Service Manager.
PS C:\>Get-SCSMQueue
------------------------- EXAMPLE 2 --------------------------
This command retrieves the queues in which DisplayName is like 'queue*'.
PS C:\>Get-SCSMQueue -displayname queue*