Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


1.6.1 deleteremoteconnection (deleting a connection destination definition)

Description

This command deletes a connection destination definition stored in JP1/AO.

You can execute the command with the ID of a connection destination definition that you want to delete to delete the specified connection destination definition.

Syntax

deleteremoteconnection
     /id ID-of-the-connection-destination-definition
     /user user-ID
     {/password password | /passwordfile password-file-path}

Arguments

/id

This option specifies the ID of the connection destination definition that you want to delete. Note that you need to execute the listremoteconnections command beforehand to check the ID of the connection destination definition.

The number of possible characters is in the range from 1 to 64 characters.

The possible characters are half-width numeric characters.

/user

This option specifies the user ID for JP1/AO.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are half-width alphanumeric characters, !, #, $, %, &, ', (, ), *, +, -, ., =, @, \, ^, _, and |.

This option is not case sensitive.

/password

This option specifies the password of the user indicated by the user option.

You must specify either this option or the passwordfile option. If both options are specified, or if neither is specified, then you will get an error.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are the same as those for the user option.

/passwordfile

This option specifies the absolute or relative path to the password file for the user specified in the user option. You can create a password file by using the encryptpassword command.

You must specify either this option or the password option. If both options are specified, or if neither is specified, then you will get an error.

Located in

In Windows:

JP1/AO-installation-folder\bin

In Linux:

/opt/jp1ao/bin

Execute permission

Execute the command as a user with both Administrator or root permissions for the OS and with the Admin role for JP1/AO. If a user without Administrator or root permissions executes the command, a message appears asking the user to elevate the permission level.

Remarks

This command can delete one connection destination definition each time the command is executed.

Return code

The following table lists the return codes from the command.

Return code

Description

0

The command succeeded.

1

The argument is invalid.

2

The command execution has been interrupted.

3

The service status is invalid.

4

One of the other commands is running.

5

Communication failed.

6

Authentication failed.

14

You do not have permission to execute the command.

240

Deleting the connection destination definition failed.

255

The command execution has been interrupted due to an error other than the above.

Example

The following example shows how to use the command to delete, in Windows, the specified connection destination definition (whose connection destination definition ID is 12345):

deleteremoteconnection /id 12345 /user user01 /password pass01