Set-SmaConnectionFieldValue

Modifies a connection field value for a connection object in SMA.

Syntax

Set-SmaConnectionFieldValue
   -ConnectionName <String>
   -ConnectionFieldName <String>
   -Value <Object>
   [-Force]
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SmaConnectionFieldValue cmdlet modifies a connection field value for a connection object in Service Management Automation (SMA).

Examples

Example 1: Modify a connection field value

PS C:\> $Password = ConvertTo-SecureString -String "PassWord01!" -Force
PS C:\> Set-SmaConnectionFieldValue -WebServiceEndpoint "https://contoso.com/app01" -ConnectionName "MyConnection" -ConnectionFieldName "Password" -Value $Password

The first command converts the string provided into a secure string, and then stores the SecureString object in the $Password variable.

The second command modifies the connection field value named Password.

Required Parameters

-ConnectionFieldName

Specifies the name of a connection field.

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

Specifies the name of a connection.

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

Specifies a value for the connection field.

Type:Object
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Optional 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
Parameter Sets:Basic, Windows
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False