Configure an RDP Start Program

To establish a connection through PSM, configure your RDP connection Start Program setting.

Start Program Settings

Configure the setting as follows:

  
psm /u target-user /a target-address /c connection-component

 

 

Spaces in the command are required.
Parameter Description Required
psm

Specify: psm

This keyword, including the rest of the syntax, allows PSM to distinguish between the connections routed through PSM to the target systems and the regular maintenance user connections, to the PSM server itself.

 

There must be a space after psm.
Yes
/u target-user The name of the user that will be used to logon to the target system.

  • When using a domain account, add the domain name to the username in the following format:

    username@domain-name

    The domain name should be specified exactly as it appears in the address of the domain account that is used to authenticate to the target server.

  • When using a shared account to connect to vCenter machine, add the vCenter address to the username in the following format:

    username@vCenter-address

    The vCenter address should be specified exactly as it appears in the address of the shared account that is used to authenticate to the vCenter machine.

 Yes
/a target-address

The address of the target system. The address must be specified exactly as it is defined in the account address setting. It can be defined in any of the following formats:

  • IPv4 – For example, 1.1.1.1

  • IPv6 – For example, 1000:1000:1000:1000:1000:1000:1000:0055

  • DNS – For example, ‘myhost’

You cannot use a DNS name if the account address is defined as an IP address, or an IP address if the account address is defined as a DNS name.

 Yes
/c connection-component

The type of the connection that will be established to the target system.

Specify the ID of any connection component that is configured in the PVWA for the account that will be used to establish the connection, for example, PSM-RDP, PSM-SSH, PSM-WinSCP and others.

For details, see Supported connection components.

 Yes

/ti ticketing ID

The ticket ID for validation, if you integrate with a ticketing system.

No

/ts ticketing system

The name of the configured ticketing system, if you integrate with a ticketing system.

If the ticketing system name contains spaces, it must be in quotes. For example, “Ticketing one”.

No
 

If there are additional parameters that are required for establishing the connection, they must be pre-configured for the account or its’ platform. These additional parameters cannot be provided by the user during the connection process.

Examples

To connect to a Windows server with the address of 10.10.2.145, with the user admin and with the RDP protocol, use the following configuration in the Start Program setting:

  
psm /u admin /a 10.10.2.145 /c PSM-RDP

To connect to a Windows server with the address of 10.10.2.145, which belongs to the domain mycompany.com, with the domain user domainadmin and with the RDP protocol, use the following configuration in the Start Program setting:

  
psm /u domainadmin@mycompany.com /a 10.10.2.145 /c PSM-RDP

 

 

To allow the connection, a domain account with the address of mycompany.com and the username domainadmin must pre-exist in the Vault.

To connect to a Unix server with the address of 10.10.2.145, with the user root and with the SSH protocol, use the following configuration in the Start Program setting:

  
psm /u root /a 10.10.2.145 /c PSM-SSH

To connect to a Unix server with the address of 10.10.2.145, with the user root and with the WinSCP client, use the following configuration in the Start Program setting:

  
psm /u root /a 10.10.2.145 /c PSM-WinSCP