Share via

Set-SmaVariable

  • Reference
Module:
Microsoft.SystemCenter.ServiceManagementAutomation

Creates or modifies a variable in SMA.

Syntax

Set-SmaVariable
   -Name <String>
   -Value <Object>
   [-Description <String>]
   [-Encrypted]
   [-Force]
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SmaVariable cmdlet creates or modifies a variable in System Management Automation (SMA). Specify the name of the variable and a value.

To encrypt the variable, use the Encrypted parameter. You cannot modify the encrypted state of a variable after creation. This cmdlet will fail if you use the Encrypted parameter on an existing, non-encrypted variable.

Examples

Example 1: Assign a value to a variable

PS C:\> Set-SmaVariable -Name "Variable01" -Value "String07" -WebServiceEndpoint "https://contoso.com/app01" -Encrypted

This command assigns the value String07 to the variable named Variable01 for the specified web service endpoint. Because the command specifies the Encrypted parameter, it encrypts the variable.

Parameters

-AuthenticationType

Specifies the authentication type. Valid values are:

  • Basic
  • Windows

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

Type:String
Accepted values:Basic, Windows
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies a PSCredential object for the connection to the SMA web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Provides a description for the variable.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypted

Indicates that this cmdlet encrypts the variable.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Modifies the variable without prompting you for confirmation. The cmdlet prompts you for confirmation before it proceeds if you provide a SecureString as the value for the Value parameter. This cmdlet also prompts you if the value contains an object with SecureString as a field and you do not use the Encrypted parameter.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of a variable.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Port

Specifies the port number of the SMA web service.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

Specifies a value for the variable.

Type:Object
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WebServiceEndpoint

Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False