Set-SmaAdminConfiguration

Article
01/15/2015

Applies To: System Center 2012 R2 Orchestrator, Windows Azure Pack for Windows Server

Set-SmaAdminConfiguration

Modifies administrative configuration settings in Service Management Automation.

Syntax

Parameter Set: Default
Set-SmaAdminConfiguration -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-CEIP <Boolean> ] [-ChartTimeSliceSampleSize <ChartTimeSliceSampleSize> ] [-Credential <PSCredential> ] [-DrainTimeInSeconds <Int32> ] [-Force] [-MaxJobRecords <Int32> ] [-Port <Int32> ] [-PurgeJobsOlderThanCountDays <Int32> ] [-ScriptExecutionPolicy <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SmaAdminConfiguration cmdlet modifies administration configuration settings in Service Management Automation. Specify the web service endpoint and, if necessary, a port.

Use this cmdlet to configure the following settings :

-- Participation in the Customer Experience Improvement Program (CEIP)
-- Drain time
-- Script execution policy
-- Chart time slice sample size
-- The maximum job records to store before purging the oldest jobs
-- The maximum age of a job before it is purged

Parameters

-AuthenticationType<String>

Specifies the authentication type. Valid values are: Basic, Windows.

Windows is the default value. If you use Basic authentication, you must provide credentials by using the Credential parameter.

Aliases	none
Required?	false
Position?	named
Default Value	Windows
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CEIP<Boolean>

Indicates whether CEIP is enabled.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ChartTimeSliceSampleSize<ChartTimeSliceSampleSize>

Specifies the chart time slice sample size. Valid values are:

-- Small

-- Medium

-- Large

-- ExtraLarge

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies user credentials, as a PSCredential object, to use for the connection to the Service Management Automation web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DrainTimeInSeconds<Int32>

Specifies the time, in seconds, after which the runbook worker hosts terminate running jobs after a runbook worker service stop has been initiated. While the host is draining, existing jobs are given the specified drain time seconds to suspend or terminate naturally, and no new jobs are accepted.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Modifies the configuration without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaxJobRecords<Int32>

Specifies the maximum number of job records that are retained.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Port<Int32>

Specifies the port number of the Service Management Automation web service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PurgeJobsOlderThanCountDays<Int32>

Specifies the number of days job history is kept. Jobs older than this number of days are purged.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ScriptExecutionPolicy<String>

Determines the Windows PowerShell execution policy for runbook jobs on the worker hosts. For information about execution policies, type Get-Help about_Execution_Policies. Valid values for this parameter are:

-- Restricted. You cannot run scripts. You can use Windows PowerShell only in interactive mode.
-- AllSigned. You can run only scripts signed by a trusted publisher.
-- RemoteSigned. Downloaded scripts must be signed by a trusted publisher before you can run the scripts.
-- Unrestricted. No restrictions; you can run all Windows PowerShell scripts.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WebServiceEndpoint<String>

Specifies the endpoint, as a URL, of the Service Management Automation web service. Include the protocol, for example, http:// or https://.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

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

Examples

Example 1: Modify an administrative configuration setting

This command sets the drain time to 60 seconds.

PS C:\> Set-SmaAdminConfiguration -WebServiceEndpoint "https://contoso.com/app01" -DrainTimeInSeconds 60

Get-SmaAdminConfiguration

Set-SmaAdminConfiguration