Get-SCSMSubscription
Updated: January 14, 2013
Applies To: System Center 2012 - Service Manager, System Center 2012 SP1 - Service Manager
Get-SCSMSubscription
Syntax
Parameter Set: Default Get-SCSMSubscription [[-DisplayName] <String> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Description <String> ] [-ManagementPack <ManagementPack> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCSMSubscription cmdlet retrieves subscriptions that are configured in Service Manager.
Parameters
-ComputerName<String[]>
Specifies the name of the computer on which the System Center Data Access service is running. The user account that is defined in the Credential parameter must have access rights to the specified computer.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
localhost |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the credentials to use when you are connecting to the server on which the System Center Data Access service is running. The provided user account must have access to that server.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Description<String>
Specifies the description of the subscription to retrieve.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-DisplayName<String>
Specifies the name of the subscription to retrieve. This can be a regular expression.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-ManagementPack<ManagementPack>
Specifies the management pack in which the subscription to retrieve is defined in.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an 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.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
-
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.Subscriptions.Subscription
This cmdlet retrieves subscriptions that are configured in Service Manager.
Examples
------------------------- EXAMPLE 1 --------------------------
This command retrieves available subscriptions.
PS C:\>Get-SCSMSubscription | Format-List
TargetClass : System.WorkItem.Incident
ManagementPack : [Microsoft.EnterpriseManagement.ServiceManager.Default]
Groups : {}
Condition : Updated
Enabled : False
DisplayName : Subscription1
Description :
Template :
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.EmailTemplate
RecipientUsers : {Contoso.administrator}
SubscriptionCriteria :
ManagementPackName : Microsoft.EnterpriseManagement.ServiceManager.Default
