rm process-SFTP adapter

The rm process deletes a specified file from the remote server. The following table describes the process inputs for the SFTP adapter with the rm process.

SFTP adapter rm process inputs

Input

Description

Required

<adapter name>

Specifies the name of the adapter to use for this process

Default value: SFTPActorAdapter

No

<target>

Identifies the target defined in the SFTP adapter configuration (in Grid Manager)

If you do not specify a value for this input, the first node in the adapter configuration is used.

No

<host name>

Specifies the host name or the IP address of the remote host

This input applies to a dynamic target.

Conditional; required if a dynamic target is used

<port>

Specifies the port on which the remote host listens

This input applies to a dynamic target.

Default value: 22

Conditional

<user name>

Specifies the user name to be used for remote host authentication

This input applies to a dynamic target.

Conditional; required if a dynamic target is used

<password>

Specifies the password that corresponds to the user name provided

This input applies to a dynamic target.

Conditional; required if a dynamic target is used

<password encryption type>

Specifies the method of encryption used for the password provided

This input applies to a dynamic target.

Valid values: Base64, Plain (default)

Note

  • If the <password-encryption-type> element is Base64, provide a Base64-encoded value.
  • If the <password-encryption-type> element is Plain, provide a value in plain text.

Conditional

<known hosts config>

Identifies the path to the local known_hosts file

This file is used when performing key verification. This input applies to a dynamic target.

Default value: homeDir/.ssh/known_host

Conditional

<allow unknown hosts>

Indicates whether a connection must continue if key verification fails

This input applies to a dynamic target.

Valid values: true, false (default)

Note

With a value of true, the connection is maintained when connecting to an unknown or mismatched system. Else, the connection is dropped and the adapter response returns an error.

Conditional

<preferred pk algorithm>

Specifies the preference of the algorithm used to encrypt the public key

This input applies to a dynamic target.

Valid values: ssh-dss, ssh-rsa (default)

Conditional

<file name>

Indicates the remote path, including the directory or the file name to be removed

Yes

<character set>

Specifies the name of the Character set used to encode or decode the characters

This input applies to a dynamic target and is required if a dynamic target is used.
For example, Shift_JIS supports the Japanese character set and Big5 supports the traditional Chinese character set.

Default value: ISO-8859-2

No

<establish connection timeout>

Specifies the timeout, in seconds, for the connection to be established on the target

Default value: 60 seconds

No

<timeout secs>

Specifies the time, in seconds, to wait for the expected prompt to return

If the expected prompt is not returned before the specified period has elapsed, an error message is returned. This element applies to a dynamic target specified in an adapter request.

Default value: 60 seconds

No

The following table describes the process output parameter for the SFTP adapter with the rm process.

SFTP adapter rm process output

Output

Description

<adapter response>

Specifies the SFTP adapter's response

Was this page helpful? Yes No Submitting... Thank you

Comments