Connect-SrmServer
This cmdlet establishes a connection to an SRM server. To access the SRM API, use the ExtensionData property of the output of this command.
Syntax
[-IgnoreCertificateErrors]
[-NotDefault]
[-Password <SecureString>]
[-Port <Int32>]
[-Protocol <String>]
[-RemoteCredential <PSCredential>]
[-RemotePassword <SecureString>]
[-RemoteUser <String>]
[-Server <VIServer[]>]
[-User <String>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
optional |
|
PSCredential | named |
|
Specifies the credentials to be used to log in to the SRM server. This parameter is an alternative to the user/password pair of parameters. | optional |
|
SwitchParameter | named |
|
If specified, any errors related to a bad server certificate of the SRM server are ignored. | optional |
|
SwitchParameter | named |
|
If specified, the resulting connection is not listed in the list of default connections to SRM servers and must be manually specified when used with a cmdlet. | optional |
|
SecureString | named |
|
Specifies the password for the connection to the SRM server. | optional |
|
Int32 | named |
|
Specifies the port on the server you want to use for the connection. If not specified, a protocol-specific default value is used. | optional |
|
String | named |
|
Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used. | optional |
|
PSCredential | named |
|
Specifies the credentials for a remote SRM server. | optional |
|
SecureString | named |
|
Specifies the password for the connection to the remote SRM server. | optional |
|
String | named |
|
Specifies the user name that is used to log on in to the remote SRM server. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server system that the SRM server is associated to. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | optional |
|
String | named |
|
Specifies the user name that is used to log in to the SRM server. |
[-Credential <PSCredential>]
[-IgnoreCertificateErrors]
[-Locale <String>]
[-NotDefault]
[-Password <SecureString>]
[-Port <Int32>]
[-Protocol <String>]
[-RemoteCredential <PSCredential>]
[-RemotePassword <SecureString>]
[-RemoteUser <String>]
[-User <String>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
String | named |
|
Specifies the IP address or fully qualified domain name (FQDN) of the SRM server. | optional |
|
PSCredential | named |
|
Specifies the credentials to be used to log in to the SRM server. This parameter is an alternative to the user/password pair of parameters. | optional |
|
SwitchParameter | named |
|
If specified, any errors related to a bad server certificate of the SRM server are ignored. | optional |
|
String | named |
|
If specified, defines the locale of the strings produced by the server for this connection. | optional |
|
SwitchParameter | named |
|
If specified, the resulting connection is not listed in the list of default connections to SRM servers and must be manually specified when used with a cmdlet. | optional |
|
SecureString | named |
|
Specifies the password for the connection to the SRM server. | optional |
|
Int32 | named |
|
Specifies the port on the server you want to use for the connection. If not specified, a protocol-specific default value is used. | optional |
|
String | named |
|
Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used. | optional |
|
PSCredential | named |
|
Specifies the credentials for a remote SRM server. | optional |
|
SecureString | named |
|
Specifies the password for the connection to the remote SRM server. | optional |
|
String | named |
|
Specifies the user name that is used to log on in to the remote SRM server. | optional |
|
String | named |
|
Specifies the user name that is used to log in to the SRM server. |
Output
VMware.VimAutomation.Srm.Types.V1.SrmServer
Examples
Example 1
Connects to a vCenter Server system, that has an SRM server associated with it. Then, invokes the cmdlet without specifying any parameters to establish a connection to the SRM server registered with the connected vCenter Server system. If you have previously connected to other vCenter Server systems configured with SRM server support, this cmdlet invocation will establish a connection to their corresponding SRM servers as well.
Example 2
Connects to an SRM server with an IP address of 192.0.2.1 by passing a valid user name and password.
Example 3
Connects to a vCenter Server system associated with an SRM server. Then, establishes a connection to that SRM server by passing valid credentials for connection to the remote SRM server.
Example 4
Connects to a vCenter Server system, that has an associated SRM server. Then, establishes an SRM server connection by ignoring any errors related to bad server certificates. The newly created SRM server connection is not added to the default list of SRM server connections.
Related Commands