Sun N1 Service Provisioning System 5.2 Installation Guide

SSH Advanced Parameters and Command Reference

Advanced Parameters Reference

On the Host Details page in the Advanced Parameters field, you can specify additional SSH configuration information. The Advanced Parameters that are accepted are as follows. If you want to use more than one parameter, separate the parameters with a comma. Do not add any unnecessary spaces in the Advanced Parameters field.

cprefix

The cprefix parameter is required for all Local Distributors and Remote Agents. The syntax of the parameter in the Advanced Parameters field is as follows:


cprefix=/N1SPS5.2-Home/application

N1SPS5.2–Home is the home directory of the application. application is agent if you are configuring a Remote Agent or ld if you are configuring a Local Distributor.


Example 7–1 cprefix Example

If the Sun N1 Service Provisioning System 5.2 is installed in /opt/SUNWn1sps/ and you are configuring a Remote Agent, the text you add to the Advanced Parameters field is:


cprefix=/opt/SUNWn1sps/N1_Service_Provisioning_System/agent

sshpath

If you have not added and do not want to add the path to the SSH executable to the PATH on the target server, you can specify the path to the SSH executable with this parameter. The syntax of the parameter in the Advanced Parameters field is as follows:


sshpath=/path-to-SSH

path-to-SSH is the directory in which the SSH executable is installed.


Example 7–2 sshpath Example

If the SSH executable is installed in the /usr/local/bin/ssh directory, the text that you add to the Advanced Parameters field is:


sshpath=/usr/local/bin/ssh

sshargs

If you want to supply additional command line arguments to the ssh command when it runs on a specific Host, you can supply those arguments in the Advanced Parameters field for that Host. The syntax of the parameter in the Advanced Parameters field is as follows:


sshargs=-option|-option

option is the command line option that you want supplied to the ssh command. Add more than one option by separating the options with a |.


Example 7–3 sshargs Example

If you want the ssh command to enable authentication agent forwarding, supply the -A option in the Advanced Parameters field:


sshargs=-o|BatchMode yes|-A

OpenSSH 2.0 Command Reference

This section describes the OpenSSH 2.0 commands and options that are used in the instructions in this chapter. If you are using a different version of SSH, determine the commands and options that are available in that version of SSH that are equivalent to the following commands. Then, use the equivalent commands when following the instructions to configure SSH.

Table 7–1 OpenSSH 2.0 Commands

Tool 

Description 

ssh

Enables the calling application to invoke another application remotely. When configured to use SSH for communications, the software uses the ssh command to invoke the remote application, either a Remote Agent or a Local Distributor, and uses the standard input and output streams of SSH to communicate with it.

ssh-agent

Used when you want to use private keys with passwords. Upload your keys with the ssh-agent so that SSH invocations of the applications communicate with the ssh-agent for authentication.

ssh-add

Uploads private keys into ssh-agent.

ssh-keygen

Generates the public-private key pair to secure an SSH connection. 

The following options can be used with the ssh command:

-A

Enables authentication agent forwarding

-o `BatchMode yes'

Disables passphrase querying

-t

Allocates a tty even if a command is given

The following option can be used with the ssh-keygen command:

-t rsa

Specifies RSA as the type of key to generate.

The following option can be used with the ssh-agent command:

-k

Kills the agent using the pid set in the environment variable SSH_AGENT_PID. Other implementations might use a different environment variable.