Reference Guide › AutoShell › AutoShell Core Reference › General AutoShell Commands › del, rm Commands--Delete Files (Funclets)

del, rm Commands--Delete Files (Funclets)

These commands (funclets) delete files or directories. To specify a remote host, prefix the pathname with the hostname followed by two colons (::). The operation is performed through SFTP. Thus the remote system does not necessarily have the client AutoShell installed, an SSH server with SFTP access is sufficient.

The command has the following syntax:

{del|rm} src [-silent] [-retval] [-R] [-user username] [-pass password] [-key key phrase] [-port portnumber]

src

Defines the files or directories to delete.

-silent

(Optional) Suppresses output to the active output stream.

-retval

(Optional) Creates an array representing the return value. The array contains information about new file names. Each element consists of a string representing the fully qualified name of one destination file.

-R

(Optional) Copies directories recursively.

-user username

(Optional) Specifies the user name to log in to the remote node. A user name is required for password or public key authentication. If no user name is specified, the user name entered during AutoShell login is used. Unquoted argument tokens are automatically stringified. Prevent automatic quoting for expressions by placing expression code in parentheses.

Default: $$User

-pass password

(Optional) Specifies password to use to log in to the remote node. If no password is specified, the password entered during AutoShell login is used. To enter a hidden password after issuing this command, specify PW_GET() with an optional prompt as argument. Unquoted argument tokens are automatically stringified. Prevent automatic quoting for expressions by placing expression code in parentheses.

Default: $$Pass

-key key

(Optional) Specifies an absolute or relative path to a file containing a private RSA key to use to log in to the remote node. If a private key and a password are specified, AutoShell attempts a public key logon first, and if that fails, a password logon. Unquoted argument tokens are automatically stringified. Prevent automatic quoting for expressions by placing expression code in parentheses. This parameter is only required when creating an SSH session on the fly using public key authentication.

Default: ""

phrase

Specifies the passphrase for a private key. If the key is not encrypted, the phrase is not required. To enter a hidden password after issuing this command, specify PW_GET() with an optional prompt as argument. Unquoted argument tokens are automatically stringified. Prevent automatic quoting for expressions by placing expression code in parentheses.

Default: ""

-port portnumber

(Optional) Port on which to connect to the target system.

Default: SSH standard port 22.

Examples

Delete file c:/test/test1.log:

del c:/test/test1.log

Remove entire directory c:/test:

rm c:/test -R

Delete entire directory c:/test on the remote host remotesys:

del remotesys::c:/test1/ -R