Host Authentication Information (hostAuthInfo)

Host Authentication Information (hostAuthInfo)

hostAuthInfo provides connection details to allow for the collective controller to authenticate to the server's host.

Name Type Default Description

rpcHost string localhost The fully qualified host name or IP address. A '*' wildcard will result in host name detection; this is not recommended for multi-homed systems and may result in unexpected behaviour. The host name must be unique within the network and must be the host name on which the remote connection protocol is listening (SSH, or OS specific RPC). This value will inherit from the defaultHostName variable if not set. The host name set here will directly control where the server's information is stored within the collective controller repository.

rpcPort int 22 The port on which the remote connection protocol is listening (SSH, or OS specific RPC).

rpcUser string The operating system user ID to use to connect to the host. If the host does not support SSH or the use of SSH keys is not wanted, we can use this parameter to specify an operating system login user.

rpcUserHome string The home directory of the user login ID. Only required to be set if sudo is to be used and SSH generation is to be done automatically.

rpcUserPassword (string) Reversably encoded password for the operating system user. If this property is not set, key-based authentication will be used. Use of key-based authentication is recommended for hosts which support SSH. If this property is set and sshPrivateKeyPath is also set, the key will take precedence.

sshPrivateKeyPassword (string) Reversably encoded password for the SSH private key.

sshPrivateKeyPath string The path to the SSH private key file. If the key pair does not exist, a key pair will be generated automatically. The private key is required for key-based authentication.

sshPublicKeyPath string The path to the SSH public key file. If the key pair does not exist, a key pair will be generated automatically. The public key will be placed into the configured userId's authorized_keys file if it is not present. Set the path to the public key is not required.

sudoUser string The sudo user ID. Do not set when useSudo=false.

sudoUserPassword (string) Reversably encoded password for the sudo user. Do not set when useSudo=false.

useCollectiveSSHKey boolean If this property is set, then the product uses a single SSH Pair created by the Collective Controller to invoke commands. The public key will be placed into the configured userId's authorized_keys file if it is not present.

useHostCredentials boolean If true, then the product uses the RPC credentials of the host to invoke commands and ignores other parameters in the 'Host Authentication Information' element.

useSudo boolean If true, then sudo will be used to invoke commands. The user to sudo as can be controlled by setting sudoUser attribute. If sudoUser is not set, then the user to sudo as will be the configured default sudo user for the host. If this property is not set, and either sudoUser or sudoUserPassword are set, then useSudo is assumed to be true. If this property is set to false, and either sudoUser or sudoUserPassword are set, then a warning will be printed and the sudo options will be ignored.

Name	Type	Default	Description
rpcHost	string	localhost	The fully qualified host name or IP address. A '*' wildcard will result in host name detection; this is not recommended for multi-homed systems and may result in unexpected behaviour. The host name must be unique within the network and must be the host name on which the remote connection protocol is listening (SSH, or OS specific RPC). This value will inherit from the defaultHostName variable if not set. The host name set here will directly control where the server's information is stored within the collective controller repository.
rpcPort	int	22	The port on which the remote connection protocol is listening (SSH, or OS specific RPC).
rpcUser	string		The operating system user ID to use to connect to the host. If the host does not support SSH or the use of SSH keys is not wanted, we can use this parameter to specify an operating system login user.
rpcUserHome	string		The home directory of the user login ID. Only required to be set if sudo is to be used and SSH generation is to be done automatically.
rpcUserPassword	(string)		Reversably encoded password for the operating system user. If this property is not set, key-based authentication will be used. Use of key-based authentication is recommended for hosts which support SSH. If this property is set and sshPrivateKeyPath is also set, the key will take precedence.
sshPrivateKeyPassword	(string)		Reversably encoded password for the SSH private key.
sshPrivateKeyPath	string		The path to the SSH private key file. If the key pair does not exist, a key pair will be generated automatically. The private key is required for key-based authentication.
sshPublicKeyPath	string		The path to the SSH public key file. If the key pair does not exist, a key pair will be generated automatically. The public key will be placed into the configured userId's authorized_keys file if it is not present. Set the path to the public key is not required.
sudoUser	string		The sudo user ID. Do not set when useSudo=false.
sudoUserPassword	(string)		Reversably encoded password for the sudo user. Do not set when useSudo=false.
useCollectiveSSHKey	boolean		If this property is set, then the product uses a single SSH Pair created by the Collective Controller to invoke commands. The public key will be placed into the configured userId's authorized_keys file if it is not present.
useHostCredentials	boolean		If true, then the product uses the RPC credentials of the host to invoke commands and ignores other parameters in the 'Host Authentication Information' element.
useSudo	boolean		If true, then sudo will be used to invoke commands. The user to sudo as can be controlled by setting sudoUser attribute. If sudoUser is not set, then the user to sudo as will be the configured default sudo user for the host. If this property is not set, and either sudoUser or sudoUserPassword are set, then useSudo is assumed to be true. If this property is set to false, and either sudoUser or sudoUserPassword are set, then a warning will be printed and the sudo options will be ignored.