Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


1.6.2 deleteservicetemplate (deleting a service template)

Description

This command deletes a service template stored in JP1/AO.

You can execute the command with the service template ID, vendor ID, and version number of a service template that you want to delete to delete the specified service template.

Syntax

deleteservicetemplate
     /name service-template-ID
     /vendor vendor-ID-of-the-service-template
     /version version-number-of-the-service-template
     /user user-ID
     {/password password | /passwordfile password-file-path}

Arguments

/name service-template-ID

This option specifies the service template ID of the service template that you want to delete.

This option is not case sensitive.

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

The possible characters are half-width alphanumeric characters, -, _, and ..

/vendor vendor-ID-of-the-service-template

This option specifies the vendor ID of the service template that you want to delete.

This option is not case sensitive.

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

The possible characters are half-width alphanumeric characters, -, _, and ..

/version version-number-of-the-service-template

This option specifies the version number of the service template that you want to delete in XX.YY.ZZ format.

The possible characters for XX, YY, and ZZ are two-digit half-width numeric characters, which are from 00 through 99.

  • XX: Major version number

  • YY: Minor version number

  • ZZ: Revision number

/user user-ID

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 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 are 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 password-file-path

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 are 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 or Develop 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

Use this command to delete a release service template. Note that you need to use the Editor window to delete a development service template.

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.

7

An invalid path is specified.

9

The specified path does not exist.

14

You do not have permission to execute the command.

190

Deleting the service template 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 service template (whose service template ID is nameA, vendor ID is vendorB, and version number is 01.00.00):

deleteservicetemplate /name nameA /vendor vendorB /version 01.00.00 /user user01 /password pass01