Update-SCSMSetting
Update-SCSMSetting
Updates the configuration settings for Service Manager.
Syntax
Parameter Set: Default
Update-SCSMSetting [-Setting] <ISetting[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Update-SCSMSetting cmdlet updates the configuration settings for Service Manager.
Parameters
-PassThru
Indicates that this cmdlet returns the settings that it updates. You can pass this object to other cmdlets.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Setting<ISetting[]>
Specifies an object which contains the updated settings for Service Manager.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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.
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
The output type is the type of the objects that the cmdlet emits.
None.
This cmdlet does not generate any output.
Examples
Example 1: Update activity settings
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.
PS C:\>$Setting = Get-SCSMSetting -DisplayName "Activity"
PS C:\> $Setting.ManualActivityPrefix = "MA_"
PS C:\> Update-SCSMSetting -Setting $Setting