Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


A.1 Version changes

Organization of this subsection

(1) Changes in version 12-60

(2) Changes in version 12-01

(3) Changes in version 12-00

(4) Changes in version 11-50

(5) Changes in version 11-10

(6) Changes in version 11-01

(7) Changes in version 11-00

(a) Changes from the manual (3021-3-088-20)

  • The following OSs were added to the supported OSs:

    • Linux 7

    • Oracle Linux 6 (x64)

    • Oracle Linux 7

    • CentOS 6 (x64)

    • CentOS 7

    • SUSE Linux 12

  • The following OSs were deleted from the supported OSs:

    • Linux 5 (AMD/Intel 64)

    • Linux 5 Advanced Platform (AMD/Intel 64)

  • Windows was migrated from the 32-bit version to the 64-bit version.

  • The installation folders of JP1/AO for Windows and Common Component were changed.

  • A description for when JP1/AO is used in an English or Chinese environment was added.

  • The port number used between JP1/AO and a web browser was changed.

  • JP1/AJS3 and JP1/AO whose versions are 11 can now coexist.

  • For the names of the commands that can be executed in Windows, the hcmds part was changed to hcmds64.

  • The deleteremoteconnection command that deletes a connection destination definition registered in JP1/AO was added.

  • The listremoteconnections command that outputs a list of connection destination definitions registered in JP1/AO was added.

  • The setremoteconnection command that adds or updates a connection destination definition was added.

  • The items that can be output by the listservices command were changed.

  • The items that can be output by the listtasks command were changed.

  • The following API functions were added:

    Service template-related API functions

    • Acquisition of a list of service templates

    • Acquisition of information about a service template

    • Deletion of a service template

    • Acquisition of a list of operations for a service template

    • Acquisition of the HTML file necessary for importing a service template

    • Import of a service template

    • Acquisition of information necessary for exporting a service template

    • Export of a service template

    • Acquisition of the URL for displaying the details of a service template

    • Acquisition of information necessary for creating a service based on a service template

    • Creation of a service based on a service template

    Service-related API functions

    • Editing a service

    • Deletion of a service

    • Acquisition of information necessary for resetting the counter for a service

    • Reset of the counter for a service

    • Acquisition of information necessary for the operation to change the status of a service to release

    • Change of the status of a service to release

    • Acquisition of information necessary for the operation to change the status of a service to maintenance

    • Change of the status of a service to maintenance

    • Acquisition of information necessary for the operation to change the status of a service to disabled

    • Change of the status of a service to disabled

    • Acquisition of the URL for the details of a service

    • Acquisition of information necessary for changing the version of the service template used by a service

    • Change of the version of the service template used by a service

    Task-related API functions

    • Editing a task

    • Deletion of a task

    • Acquisition of information necessary for forcibly stopping a task

    • Forced stoppage of a task

    • Acquisition of information necessary for responding to a task that is in the status Waiting for Response

    • Response to a task that is in the status Waiting for Response

    • Acquisition of information necessary for archiving a task

    • Archiving a task

    List of history-related API functions

    • Acquisition of a list of history records

    • Deletion of history records (with conditions specified)

    • Acquisition of a history record

    • Deletion of history records (with an ID specified)

    • Acquisition of a list of operations for a history record

    Property-related API functions

    • Acquisition of lists of property definitions and property values

    • Batch update of property values

    • Update of a property value

    • Acquisition of a list of property groups

    Service group-related API functions

    • Acquisition of a list of service groups

    • Acquisition of information about a service group

    • Acquisition of a list of operations for a service group

    Tag-related API functions

    • Acquisition of a list of tag groups

    • Acquisition of a list of tags

  • According to the addition of the API functions, the following items were added or changed:

    • Domain names and resources that can be managed by API functions

    • Query parameter

    • Request header

    • Response header

    • Members of resources

    • Members to be returned for API functions that execute JP1/AO operations

    • Members to be returned for API functions that acquire executable operations

  • Descriptions of the status codes were added.

(b) Changes from the manual (3021-3-366(E))

  • Linux was added to the supported OSs.

  • The installation folders of JP1/AO for Windows and Common Component were changed.

  • The port number used between JP1/AO and a web browser was changed.

  • Windows was migrated from the 32-bit version to the 64-bit version.

  • JP1/AJS3 and JP1/AO whose versions are 11 can now coexist.

  • For the names of the commands that can be executed in Windows, the hcmds part was changed to hcmds64.

  • The deleteremoteconnection command that deletes a connection destination definition registered in JP1/AO was added.

  • The listremoteconnections command that outputs a list of connection destination definitions registered in JP1/AO was added.

  • The setremoteconnection command that adds or updates a connection destination definition was added.

  • The items that can be output by the listservices command were changed.

  • The items that can be output by the listtasks command were changed.

  • A member that can be acquired by the operation Acquisition of a list of tasks or Acquisition of a list of steps was changed from endTime to completionTime.

  • The following API functions were added:

    Service template-related API functions

    • Acquisition of a list of service templates

    • Acquisition of information about a service template

    • Deletion of a service template

    • Acquisition of a list of operations for a service template

    • Acquisition of the HTML file necessary for importing a service template

    • Import of a service template

    • Acquisition of information necessary for exporting a service template

    • Export of a service template

    • Acquisition of the URL for displaying the details of a service template

    • Acquisition of information necessary for creating a service based on a service template

    • Creation of a service based on a service template

    Service-related API functions

    • Editing a service

    • Deletion of a service

    • Acquisition of information necessary for resetting the counter for a service

    • Reset of the counter for a service

    • Acquisition of information necessary for the operation to change the status of a service to release

    • Change of the status of a service to release

    • Acquisition of information necessary for the operation to change the status of a service to maintenance

    • Change of the status of a service to maintenance

    • Acquisition of information necessary for the operation to change the status of a service to disabled

    • Change of the status of a service to disabled

    • Acquisition of the URL for the details of a service

    • Acquisition of information necessary for changing the version of the service template used by a service

    • Change of the version of the service template used by a service

    Task-related API functions

    • Editing a task

    • Deletion of a task

    • Acquisition of information necessary for forcibly stopping a task

    • Forced stoppage of a task

    • Acquisition of information necessary for responding to a task that is in the status Waiting for Response

    • Response to a task that is in the status Waiting for Response

    • Acquisition of information necessary for archiving a task

    • Archiving a task

    List of history-related API functions

    • Acquisition of a list of history records

    • Deletion of history records (with conditions specified)

    • Acquisition of a history record

    • Deletion of history records (with an ID specified)

    • Acquisition of a list of operations for a history record

    Property-related API functions

    • Acquisition of lists of property definitions and property values

    • Batch update of property values

    • Update of a property value

    • Acquisition of a list of property groups

    Service group-related API functions

    • Acquisition of a list of service groups

    • Acquisition of information about a service group

    • Acquisition of a list of operations for a service group

    Tag-related API functions

    • Acquisition of a list of tag groups

    • Acquisition of a list of tags

  • According to the addition of the API functions, the following items were added or changed:

    • Domain names and resources that can be managed by API functions

    • Query parameter

    • Request header

    • Response header

    • Members of resources

    • Members to be returned for API functions that execute JP1/AO operations

    • Members to be returned for API functions that acquire executable operations

  • A description stating that the hcmds64getlogs command can be executed even on the standby server of a cluster environment was added.

  • A description stating that the hcmds64getlogs command can be executed even if the JP1/AO server is stopped was added.

(8) Changes in version 10-54

(a) Changes in the manual (3021-3-088-20)

  • A member that can be acquired by the operation Acquisition of a list of tasks or Acquisition of a list of steps was changed from endTime to completionTime.

(9) Changes in version 10-52

(a) Changes in the manual (3021-3-088-10)

  • Linux was added to the supported OSs.

  • According to the addition of the function that manages plug-in versions, the following windows were added:

    • Plug-in Version Management dialog box (Apply to All tab)

    • Plug-in Version Management dialog box (Individual apply tab)

  • A description of how to take action if a message dialog box indicating an unexpected error appears or windows are not displayed correctly when you log in to JP1/AO was added.

  • Keyboard interactive authentication is now supported as an authentication method that can be used for SSH connection with operation-target devices.

  • A description stating that the Required check box cannot be edited if you select the reserved plug-in property plugin.publicKeyAuthentication or plugin.keyboardInteractiveAuthentication was added.

  • A description stating that the hcmdsgetlogs or hcmds64getlogs command can be executed even on the standby server of a cluster environment was added.

  • A description stating that the hcmdsgetlogs or hcmds64getlogs command can be executed even if the JP1/AO server is stopped was added.

(10) Changes in version 10-50

(a) Changes in the manual (3021-3-088)

  • A function that links with Active Directory to manage users was added.

  • HTTPS connections are now supported.

  • Public key authentication is now supported as a method of authenticating operation-target devices.

  • The stopcluster command was added.

    Preparations for stopping JP1/AO services in a cluster environment can now be performed.

  • The hcmdsldapuser command was added.

    The user information that is necessary to search Active Directory registration information when Active Directory linkage is used can now be edited.

  • The hcmdsssltool command was added.

    A private key, CSR, self-signed certificate, and a file to contain the self-signed certificate, which are necessary for SSL connections, can now be created.

  • A description stating that the following files are not targets of the backupsystem and restoresystem commands was added:

    • SSL server certificate files for HTTPS connections

    • Private key files for HTTPS connections

    • Private key files for public key authentication

  • API functions are now supported.

(b) Changes in the manual (3021-3-366(E))

  • For the manual issued in December 2014 or later, the title and reference number were changed as shown below.

    Before the change:

    Job Management Partner 1/Automatic Operation GUI and Command Reference (3021-3-315(E))

    After the change:

    Job Management Partner 1/Automatic Operation GUI, Command, and API Reference (3021-3-366(E))

  • Windows Server 2012 R2 was added to the supported OSs.

  • With addition of the task monitor function and the service template debugger function, the following windows were added:

    • Task log dialog box

    • Debug-Tasks view

    • Task Monitor view

    • Perform Debugging dialog box

    • Debug view

    • Service template debugging view

  • A function that links with Active Directory to manage users was added.

  • HTTPS connections are now supported.

  • With the change to slide bars, the screenshots of the following windows were changed:

    • Main window

    • Services dialog box

    • Tasks window

    • Tasks view

    • Task Histories view

    • Administration window

    • Connection Destinations view

    • Service Share Properties view

    • User Groups view (User Groups tab)

    • User Groups view (Users tab)

    • Resource Groups view

    • Editor window

    • Service template view dialog box

    • Service template editing view

  • A function for viewing the task log was added to the following windows:

    • Waiting for Response Task List dialog box

    • In Progress Task List dialog box

    • Completed Task List dialog box

    • Failed Task List dialog box

    • Tasks view

    • Task Details dialog box

  • A function that retries tasks and a function that forcibly stops tasks were added to the following windows:

    • Waiting for Response Task List dialog box

    • In Progress Task List dialog box

    • Tasks view

  • With the addition of the task monitor and service template debugger, the conditions in which the following windows are displayed were changed:

    • Submit Service dialog box

    • Task Details dialog box

    • Respond dialog box

    • Plug-in view

    • View Service Definition dialog box

    • Steps dialog box

    • Service template editing view

    • Build/Release Result dialog box

    The descriptions of items displayed in the following windows were changed:

    • Tasks window

    • Task Details dialog box

    • Editor window

    • Service template editing view

    • Build/Release Result dialog box

  • Return Value was added to the list of steps displayed in the Task Details dialog box. In addition, a description stating that the statuses displayed in the list of steps can be changed was added.

  • Public key authentication is now supported as a method of authenticating operation-target devices.

  • Functions that can be executed or specified as root were added to the following windows:

    • Plug-in view

    • Create Plug-in dialog box

    • Edit Plug-in dialog box

  • A Release plug-in can now be deleted.

  • Content plug-ins that execute commands or scripts are now supported in AIX, HP-UX, and Solaris, in addition to Windows and Linux.

  • The stopcluster command was added.

    Preparations for stopping JP1/AO services in a cluster environment can now be performed.

  • The hcmdsldapuser command was added.

    The user information that is necessary to search Active Directory registration information when Active Directory linkage is used can now be edited.

  • The hcmdsssltool command was added.

    A private key, CSR, self-signed certificate, and a file to contain the self-signed certificate, which are necessary for SSL connections, can now be created.

  • The listtasks command can now be used to output the details of multiple tasks. In addition, the submittask command can now be used to re-register multiple tasks that are to be executed periodically or according to the schedule.

  • A description of the /user option of the hcmdscheckauth command was added, and return value 247 was added.

  • A note on the user name or password to be specified for an option was added.

  • A description stating that debug services and debug tasks are not targets of the following commands was added:

    • listservices command

    • listtasks command

    • stoptask command

    • submittask command

  • The submittask command can now be used to register a command that is to be executed periodically.

  • A description stating that the following files are not targets of the backupsystem and restoresystem commands was added:

    • SSL server certificate files for HTTPS connections

    • Private key files for HTTPS connections

    • Private key files for public key authentication

  • The description of the JP1/Base service was deleted because the JP1/Base service starts when the JP1/AO service starts.

  • Notes that apply in a cluster system were added.

  • The descriptions of the /workpath and /file options were changed. In addition, notes on the hcmdsdbtrans command were added.

  • Explanations of debug services and debug tasks were added in the description of the restoresystem command. In addition, a description stating that the retry operation cannot be selected for restored tasks and debug tasks was added.

  • API functions are now supported.

  • Descriptions of the status icons displayed in windows were added.

(11) Changes in version 10-12

(a) Changes in the manual (3021-3-084-50)

  • Windows Server 2012 R2 was added to the supported OSs.

  • With addition of the task monitor function and the service template debugger function, the following windows were added:

    • Task log dialog box

    • Debug-Tasks view

    • Task Monitor view

    • Perform Debugging dialog box

    • Debug view

    • Service template debugging view

  • With the change to slide bars, the screenshots of the following windows were changed:

    • Main window

    • Services dialog box

    • Tasks window

    • Tasks view

    • Task Histories view

    • Administration window

    • Connection Destinations view

    • Service Share Properties view

    • User Groups view (User Groups tab)

    • User Groups view (Users tab)

    • Resource Groups view

    • Editor window

    • Service template view dialog box

    • Service template editing view

  • A function for viewing the task log was added to the following windows:

    • Waiting for Response Task List dialog box

    • In Progress Task List dialog box

    • Completed Task List dialog box

    • Failed Task List dialog box

    • Tasks view

    • Task Details dialog box

  • A function that retries tasks and a function that forcibly stops tasks were added to the following windows:

    • Waiting for Response Task List dialog box

    • In Progress Task List dialog box

    • Tasks view

  • With the addition of the task monitor and service template debugger, the conditions in which the following windows are displayed were changed:

    • Submit Service dialog box

    • Task Details dialog box

    • Respond dialog box

    • Plug-in view

    • View Service Definition dialog box

    • Steps dialog box

    • Service template editing view

    • Build/Release Result dialog box

    The descriptions of items displayed in the following windows were changed:

    • Tasks window

    • Task Details dialog box

    • Editor window

    • Service template editing view

    • Build/Release Result dialog box

  • Return Value was added to the list of steps displayed in the Task Details dialog box. In addition, a description stating that the statuses displayed in the list of steps can be changed was added.

  • Functions that can be executed or specified as root were added to the following windows:

    • Plug-in view

    • Create Plug-in dialog box

    • Edit Plug-in dialog box

  • A description stating that debug services and debug tasks are not targets of the following commands was added:

    • listservices command

    • listtasks command

    • stoptask command

    • submittask command

  • Explanations of debug services and debug tasks were added in the description of the restoresystem command. In addition, a description stating that the retry operation cannot be selected for restored tasks and debug tasks was added.

  • Descriptions of the status icons displayed in windows were added.

(12) Changes in version 10-11

(a) Changes in the manual (3021-3-084-40)

  • A Release plug-in can now be deleted.

  • Content plug-ins that execute commands or scripts are now supported in AIX, HP-UX, and Solaris, in addition to Windows and Linux.

  • A description of the /user option of the hcmdscheckauth command was added, and return value 247 was added.

  • A note on the user name or password to be specified for an option was added.

  • The listtasks command can now be used to output the details of multiple tasks. In addition, the submittask command can now be used to re-register multiple tasks that are to be executed periodically or according to the schedule.

  • The submittask command can now be used to register a command that is to be executed periodically.

  • The description of the JP1/Base service was deleted because the JP1/Base service starts when the JP1/AO service starts.

  • Notes that apply in a cluster system were added.

  • The descriptions of the /workpath and /file options were changed. In addition, notes on the hcmdsdbtrans command were added.

(13) Changes in version 10-10

(a) Changes in the manual (3021-3-084-30)

  • New functionality allows the user to develop service templates and plug-ins in the Editor window.

  • Configuration Type was added as a display item of the following windows:

    • Waiting Task List dialog box

    • Waiting for Response Task List dialog box

    • In Progress Task List dialog box

    • Completed Task List dialog box

    • Failed Task List dialog box

    • Services window

    • Submit Service dialog box

    • Add Service dialog box

    • Service Definition dialog box

    • Tasks view

    • Task Details dialog box

    • Task Histories view

  • The limit on simultaneous execution was increased from 2 to 10 for both the submittask and stoptask commands.

  • The Develop role was added to user permissions. It can be used to execute the following commands:

    • deleteservicetemplate command

    • importservicetemplate command

    • listservices command

    • listtasks command

    • stoptask command

    • submittask command

  • Configuration Type was added to the output items of the listservices and listtasks commands.

  • The following description was added: If you omit specifying the /property option in the submittask command, the values you entered in the Service Definition dialog box are set for the corresponding property keys.

  • The /wait option, which is used to finish the command after outputting the execution results of the task, was added to the submittask command.

  • The /scheduledate and /scheduletime options, which are used to specify when services are to be executed, were added to the submittask command.

  • The limit values for the Editor window were added to the list of limit values.

(b) Changes in the manual (3021-3-315-10(E))

  • New functionality allows the user to develop service templates and plug-ins in the Editor window.

  • Notes on operating on windows in Windows Server 2012 were added.

  • Configuration Type was added as a display item of the following windows:

    • Waiting Task List dialog box

    • Waiting for Response Task List dialog box

    • In Progress Task List dialog box

    • Completed Task List dialog box

    • Failed Task List dialog box

    • Services window

    • Submit Service dialog box

    • Add Service dialog box

    • Service Definition dialog box

    • Tasks view

    • Task Details dialog box

    • Task Histories view

  • The following items of the Task Details dialog box were changed:

    • Jobnet Information was changed to Step Information.

    • Jobnet Details was changed to Step Details.

    • Root Jobnet Name was deleted.

    • Units was changed to Steps.

    • Unit Name was changed to Name.

    • Comment was changed to Description.

  • Telnet was added to the available protocols.

  • Plug-in resource files for English, Chinese, and Japanese environments can now be selected.

  • Service resource files for English, Chinese, and Japanese environments can now be selected.

  • The limit on simultaneous execution was increased from 2 to 10 for both the submittask and stoptask commands.

  • New functionality allows the user to change the subject identification information output to the audit log.

  • A description that the setupcluster command is not available in Windows Server 2012 was added.

  • The Develop role was added to user permissions. It can be used to execute the following commands:

    • deleteservicetemplate command

    • importservicetemplate command

    • listservices command

    • listtasks command

    • stoptask command

    • submittask command

  • Configuration Type was added to the output items of the listservices and listtasks commands.

  • The following description was added: If you omit specifying the /property option in the submittask command, the values you entered in the Service Definition dialog box are set for the corresponding property keys.

  • The /wait option, which is used to finish the command after outputting the execution results of the task, was added to the submittask command.

  • The /scheduledate and /scheduletime options, which are used to specify when services are to be executed, were added to the submittask command.

  • The description of JP1/Base services was deleted because these services automatically start when JP1/AO services start.

  • The limit values for the Editor window were added to the list of limit values.

  • The list of limit values was modified.

  • Items related to functionality in the list of limit values were moved to the Job Management Partner 1/Automatic Operation Overview and System Design Guide as List of limit values of functions.

(14) Changes in version 10-02

(a) Changes in the manual (3021-3-084-20)

  • Notes on operating on windows in Windows Server 2012 were added.

  • The following items of the Task Details dialog box were changed:

    • Jobnet Information was changed to Step Information.

    • Jobnet Details was changed to Step Details.

    • Root Jobnet Name was deleted.

    • Units was changed to Steps.

    • Unit Name was changed to Name.

    • Comment was changed to Description.

  • Telnet was added to the available protocols.

  • New functionality allows the user to change the subject identification information output to the audit log.

  • A description that the setupcluster command is not available in Windows Server 2012 was added.

  • The list of limit values was modified.

(15) Changes in version 10-02

(a) Changes in the manual (3021-3-084-10)

  • Items related to functionality in the list of limit values were moved to the Job Management Partner 1/Automatic Operation Overview and System Design Guide as List of limit values of functions.