Get-SCSMSetting

Get-SCSMSetting

Retrieves configuration settings of System Center Service Manager.

Syntax

Parameter Set: FromDisplayName
Get-SCSMSetting [[-DisplayName] <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromId
Get-SCSMSetting [-Id] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Get-SCSMSetting cmdlet retrieves configuration settings of System Center 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

-DisplayName<String[]>

Specifies the value of the DisplayName property of the setting to retrieve.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Id<Guid[]>

Specifies the ID of the setting to retrieve.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

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 (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 one of the following solution settings to the DisplayName parameter of the Get-SCSMSetting cmdlets:

    "Activity Settings", "Release Management Settings", "Knowledge Management Settings", "Problem Settings", "Data Retention Settings", "Service Request Settings", "Incident Settings", or "Change Request Settings".

  • System.Guid

    You can pipe a GUID of a solution settings object to the Id parameter of the Get-SCSMSetting cmdlet. You can retrieve that GUID from the __EnterpriseManagementObject property of a solution settings object by using the following command:

    Get-SCSMSetting | %{$_.__enterprisemanagementobject}|ft id,displayname -au

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.WorkItem.Incident.GeneralSetting

    This cmdlet returns configuration settings of System Center Service Manager.

Examples

------------------------- EXAMPLE 1 --------------------------

This command retrieves configuration settings for the Service Manager Problem feature.

PS C:\>Get-SCSMSetting Problem*

------------------------- EXAMPLE 2 --------------------------

This command retrieves the configuration settings for the Service Manager Data Retention feature.

PS C:\>Get-SCSMSetting *Retention*

------------------------- EXAMPLE 3 --------------------------

This command retrieves the configuration settings for the Service Manager Knowledge Managements feature.

PS C:\>Get-SCSMSetting Knowledge*

------------------------- EXAMPLE 4 --------------------------

This command retrieves the configuration settings for the Service Manager Change Request feature, using the GUID of solution settings.

PS C:\>("Change Request Settings" | Get-SCSMSetting ).__EnterpriseManagementObject.Id | Get-SCSMSetting

------------------------- EXAMPLE 5 --------------------------

This command retrieves the configuration settings for the Service Manager Activity Management feature.

PS C:\>Get-SCSMSetting Activity*

------------------------- EXAMPLE 6 --------------------------

This command retrieves the configuration settings for the Service Manager Incident Management feature.

PS C:\>Get-SCSMSetting Incident*

------------------------- EXAMPLE 7 --------------------------

This command retrieves all the configuration settings for Service Manager.

PS C:\>Get-SCSMSetting

Update-SCSMSetting