Share via

New-SmaConnection

  • Reference
Module:
Microsoft.SystemCenter.ServiceManagementAutomation

Creates a connection instance in SMA.

Syntax

New-SmaConnection
   -Name <String>
   -ConnectionTypeName <String>
   [-ConnectionFieldValues <Hashtable>]
   [-Description <String>]
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

Description

The New-SmaConnection cmdlet creates a connection instance in Service Management Automation (SMA).

Examples

Example 1: Create a connection

PS C:\> New-SmaConnection -WebServiceEndpoint "https://contoso.com/app01" -Name "MyConnection" -ConnectionTypeName "MyConnectionType" -Description "This is a new connection" -ConnectionFieldValues @{ "Hostname"="Computer01"; "Username"="PattiFuller"; Password="passw0rd!"}

This command creates a connection named MyConnection by using the Name, ConnectionTypeName, and ConnectionFieldValues parameters.

Caution

Microsoft recommends that you use the most secure authentication flow available. The authentication flow described in this example requires a very high degree of trust in the application, and carries risks that are not present in other flows.

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

-ConnectionFieldValues

Specifies a hash table that contains key and value pairs. The keys represent the connection fields on the specified connection type. The values represent the specific values to store for each connection field for the connection instance.

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

-ConnectionTypeName

Specifies a connection type.

Type:String
Position:Named
Default value:None
Required:True
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

Specifies a description for the connection.

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

-Name

Specifies a name for the connection.

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

-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