ssftpdeploy utility command

The ssftpdeploy command uses the SSH File Transfer Protocol (SFTP) to deploy an IBM Transformation Extender Launcher system to a remote host. The remote host must have an SSH server configured to accept remote SFTP requests. The computer that runs the ssftpdeploy command must be configured for SSH communication with the remote host. To establish SSH communication when SSH host key verification is in effect, the SSH public keys of the remote host must be specified in the %userprofile%\.ssh\known_hosts file on the host that deploys the system.

ssftpdeploy [deployment_options] sys_def.msd system deployment_script

Required parameters

sys_def.msd: The name and path of the system definition file, relative to the current directory. This parameter is required and positional.
system: The name of the system. This parameter is required and positional.
deployment_script: The name of the deployment script in the system definition (.msd) file. This parameter is required and positional.

Deployment options

The deployment_options of the ssftpdeploy command are:


[-EMODE {ES | CS}]
[-MRC resource_cfg.mrc]
[-SERVER server_name] [-USER user_name] [-PW password] [-IP IP_address]
[-R  [results_file_location] [results_file_name]] 
[-LOG [log_file_location] [log_file_name]
[-VERIFYHOSTKEY]
[-H]

-EMODE mode

The processing mode for running the systems:

ES: Launcher mode. This is the default.
CS: Command server mode.

-MRC resource_cfg.mrc

The name and path of the resource registry configuration file, relative to the current directory. The resource registry configuration file resolves the aliases used in the systems.

-SERVER server_name

The server to which to deploy the system. The server specified on the -SERVER keyword must be defined in the system definition (.msd) file. The -SERVER keyword is optional. If specified, the -SERVER keyword overrides a server specified in the deployment definition script.

-USER user_name

The user name required to log in to the SFTP server to which the system is deployed. The -USER keyword is optional. The -USER keyword overrides the user name of a server specified by the -SERVER keyword or a server specified by the deployment definition script. You can use the -USER keyword together with the -PW and -IP keywords to specify a server that is not defined in the system definition (.msd) file. A server specified by the -USER, -PW and -IP keywords overrides a server specified on the -SERVER keyword or in the deployment definition script.

-PW password

The password required to log in to the SFTP server to which the system is deployed. The -PW keyword is optional. The -PW keyword overrides the password of a server specified by the -SERVER keyword or a server specified by the deployment definition script. You can use the -PW keyword together with the -USER and -IP keywords to specify a server that is not defined in the system definition (.msd) file. A server specified by the -USER, -PW and -IP keywords overrides a server specified on the -SERVER keyword or in the deployment definition script.

-IP IP_address

The IP address required to log in to the SFTP server to which the system is deployed. The -IP keyword is optional. The -IP keyword overrides the IP address of a server specified by the -SERVER keyword or a server specified by the deployment definition script. You can use the -IP keyword together with the -USER and -PW keywords to specify a server that is not defined in the system definition (.msd) file. A server specified by the -USER, -PW and -IP keywords overrides a server specified on the -SERVER keyword or in the deployment definition script.

-R [results_file_location] [results_file_name]

Logs the result of each ssftpdeploy operation for each system to a results file. In addition to the status of the deployment, the results log includes map processing details such as number of successful builds. This keyword is optional. If you omit it, the results are written to the default MSEsftdeploy.txt file in the current directory. If you omit the results file name and location, the -R keyword creates a results file with path where the system definition (.msd) file is located. You can specify the name or location of the results file in the following ways:

Variable	Results file location and name
`directory_name`	`directory_name`\MSEsftdeploy.txt
`full_path`\*.err	`full_path`\MSEsftdeploy.err
`full_path\results_filename`	`full_path\results_filename`

-LOG [log_file_location] [log_file_name]

Enables logging of all ssftpdeploy processes to a log file. This keyword is optional. If you omit it, the log messages are written to the default MSEsftpdeploy.log file in the current directory. You can specify the name or location of the log file in the following ways:

Variable	Log file location and name
`directory_name`	`directory_name`\MSEsftpdeploy.log
`full_path`\*.err	`full_path`\MSEsftpdeploy.err
`full_path\log_filename`	`full_path\log_filename`

-VERIFYHOSTKEY

Restricts SSH communication to remote hosts that are defined in the %userprofile%\.ssh\known_hosts file on the local server. This keyword is optional. If you omit it, the local server accepts any public key from a remote SSH hosts to establish SSH communication.

-H

Displays the ssftpdeploy command help to the console.

Examples

The examples use the following common artifacts:

Server:	`tx-bld-cloud1`
System definition (.msd) file:	decypher_big.msd
System name:	`System1`
System deployment definition script:	`tx-bld-cloud-def1`
Resource registry configuration file:	decypher.mrc

Use the SSH protocol to deploy System1 to the tx-bld-cloud1 server:

ssftpdeploy -SERVER tx-bld-cloud1 decypher_big.msd System1 tx-bld-cloud-def1

Use the SSH protocol to deploy System1 to the tx-bld-cloud1 server. Override the IP address and password of the server, and use the specified resource registry configuration file to resolve aliases in System1:

ssftpdeploy -SERVER tx-bld-cloud1 -MRC decypher.mrc -IP 10.134.55.79 -PW hclpnp123 decypher_big.msd System1 tx-bld-cloud-def1

Use the SSH protocol to deploy System1 to the tx-bld-cloud1 server. Override the IP address and password of the server. Use the specified resource registry configuration file to resolve aliases in System1. Verify that the SSH key of the remote host is defined in the %userprofile%\.ssh\known_hosts file on the local server:

ssftpdeploy -SERVER tx-bld-cloud1 -MRC decypher.mrc -IP 10.134.55.79 -PW hclpnp123 -VERIFYHOSTKEY decypher_big.msd System1 tx-bld-cloud-def1