Share via


Update-SCSMSetting

Updates the configuration settings for Service Manager.

Syntax

Default (Default)

Update-SCSMSetting
    [-Setting] <ISetting[]>
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-SCSMSetting cmdlet updates the configuration settings for Service Manager.

Examples

Example 1: Update activity settings

PS C:\>$Setting = Get-SCSMSetting -DisplayName "Activity"
PS C:\> $Setting.ManualActivityPrefix = "MA_"
PS C:\> Update-SCSMSetting -Setting $Setting

The first command gets the activity settings for Service Manager by using the Get-SCSMSetting cmdlet. The command stores those settings in the $Setting variable.

The second command modifies the ManualActivityPrefix property of $Setting.

The final command updates the setting to have the current value of $Setting.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Indicates that this cmdlet returns the settings that it updates. You can pass this object to other cmdlets.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Setting

Specifies an object which contains the updated settings for Service Manager.

Parameter properties

Type:

Microsoft.EnterpriseManagement.ServiceManager.Sdk.Settings.ISetting[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.EnterpriseManagement.ServiceManager.Sdk.Settings.ISetting

You can pipe configuration settings to the Settings parameter. You can use the Get-SCSMSetting cmdlet to retrieve a settings object.

Outputs

None.

This cmdlet does not generate any output.