Set-SCACAdminSetting
Set-SCACAdminSetting
Sets an administrator setting to a specified value.
Syntax
Parameter Set: AdminSettingBySettingObject
Set-SCACAdminSetting [-AdminSetting] <ACAdminSetting> [-Value] <Int32> [ <CommonParameters>]
Parameter Set: CEIP
Set-SCACAdminSetting [-CEIPEnabled] <Boolean> [ <CommonParameters>]
Parameter Set: JobHistoryPeriod
Set-SCACAdminSetting [-JobHistoryPeriodInDays] <Int32> [ <CommonParameters>]
Parameter Set: RefreshInterval
Set-SCACAdminSetting [-RefreshIntervalInSeconds] <Int32> [ <CommonParameters>]
Detailed Description
The Set-SCACAdminSetting cmdlet sets an administrator setting to a specified value.
Parameters
-AdminSetting<ACAdminSetting>
Specifies an admin setting object. To get an admin setting object, use the Get-SCAdminSetting cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-CEIPEnabled<Boolean>
Specifies, when set to $True, that participation in the Microsoft Customer Experience Improvement Program (CEIP) is enabled.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobHistoryPeriodInDays<Int32>
Specifies the number of days for the job history period.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RefreshIntervalInSeconds<Int32>
Specifies the number of seconds for the refresh interval.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Value<Int32>
Specifies the value for an administrator setting. Valid values are integers.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
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.SystemCenter.CloudManager.PowerShell.ACAdminSetting, System.String, System.Int32
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.SystemCenter.CloudManager.PowerShell.ACAdminSetting
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command sets the JobHistoryPeriodInDays admin setting to 60.
PS C:\> Set-SCACAdminSetting -JobHistoryPeriodInDays 60
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command enables the CEIP setting by setting the CEIPEnabled admin setting to $True.
PS C:\> Set-SCACAdminSetting –CEIPEnabled $True
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
The first command gets the administrator setting object named RefreshIntervalInSeconds and stores the object in the $Setting variable.
The second command sets the value for the administrator setting stored in $Setting (RefreshIntervalInSeconds) to 30.
PS C:\> $Setting = Get-SCACAdminSetting -RefreshIntervalInSeconds
PS C:\> Set-SCACAdminSetting -AdminSetting $Setting -Value 30