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 runs. The user account that is specified 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 that this cmdlet uses to connect to the server on which the System Center Data Access service runs. The specified user account must have access rights 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 display name 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:

    -- Activity Settings
    -- Release Management Settings
    -- Knowledge Management Settings
    -- Problem Settings
    -- Data Retention Settings
    -- Service Request Settings
    -- Incident Settings
    -- Change Request Settings

  • System.Guid

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

    PS C:\> Get-SCSMSetting | ForEach-Object {$_.__EnterpriseManagementObject} | Format_Table -Property ID,DisplayName -AutoSize

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: Get configuration settings for the Problem feature

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

PS C:\>Get-SCSMSetting -DisplayName "Problem*"

Example 2: Get configuration settings for the Data Retention feature

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

PS C:\>Get-SCSMSetting -DisplayName "*Retention*"

Example 3: Get configuration settings for the Knowledge feature

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

PS C:\>Get-SCSMSetting -DisplayName "Knowledge*"

Example 4: Get configuration settings for the Change Request feature

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: Get configuration settings for the Activity Management feature

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

PS C:\>Get-SCSMSetting -DisplayName "Activity*"

Example 6: Get configuration settings for the Incident Management feature

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

PS C:\>Get-SCSMSetting -DisplayName "Incident*"

Example 7: Get configuration settings for Service Manager

This command retrieves all the configuration settings for Service Manager.

PS C:\>Get-SCSMSetting

Update-SCSMSetting