Share via


New-SmaConnection

Creates a connection instance in SMA.

Syntax

Default (Default)

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.

Parameter properties

Type:String
Default value:None
Accepted values:Basic, Windows
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConnectionTypeName

Specifies a connection type.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the connection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies a name for the connection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Port

Specifies the port number of the SMA web service.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WebServiceEndpoint

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.