Contents

• Notices

• Summary of amendments

• Preface

• 1. Commands

  • 1.1 List of commands

  • 1.2 Notes on using the commands

  • 1.3 Valid characters for arguments in a command

  • 1.4 Command description format

  • 1.5 Configuration-related commands

    • 1.5.1 encryptpassword (creating a password file)

    • 1.5.2 hcmds64checkauth (verifying the connection with the external authentication server)

    • 1.5.3 hcmds64fwcancel (adding an exception to the Windows Firewall exceptions list)

    • 1.5.4 hcmds64intg (deleting or checking authentication data)

    • 1.5.5 hcmds64ldapuser (registering and deleting users for LDAP search)

    • 1.5.6 hcmds64ssltool (creating a private key and self-signed certificate)

    • 1.5.7 setupcluster (configuring a cluster environment)

  • 1.6 Operation-related commands

    • 1.6.1 deleteremoteconnection (deleting a connection destination definition)

    • 1.6.2 deleteservicetemplate (deleting a service template)

    • 1.6.3 hcmds64chgurl (updating URL information)

    • 1.6.4 hcmds64srv (starting and stopping JP1/AO, and displaying the status of JP1/AO)

    • 1.6.5 hcmds64unlockaccount (unlocking a user account)

    • 1.6.6 importservicetemplate (importing one or more service templates)

    • 1.6.7 listremoteconnections (outputting the list of connection destination definitions)

    • 1.6.8 listservices (outputting the list of services or service templates)

    • 1.6.9 listtasks (outputting the list of tasks and the detailed task information)

    • 1.6.10 setremoteconnection (adding or updating a connection destination definition)

    • 1.6.11 stoptask (stopping a task)

    • 1.6.12 submittask (executing a service and re-registering the tasks in a batch)

  • 1.7 Maintenance-related commands

    • 1.7.1 backupsystem (backing up the JP1/AO system)

    • 1.7.2 hcmds64dbrepair (re-creating the database)

    • 1.7.3 hcmds64dbsrv (starting and stopping the databases)

    • 1.7.4 hcmds64dbtrans (backing up and restoring the databases)

    • 1.7.5 hcmds64getlogs (collecting log information)

    • 1.7.6 restoresystem (restoring the JP1/AO system)

• 2. APIs

  • 2.1 List of APIs

  • 2.2 Specifications common to APIs

    • 2.2.1 Communication protocol

    • 2.2.2 Security and authentication

    • 2.2.3 Input/output format

    • 2.2.4 Namespace

    • 2.2.5 Request format

    • 2.2.6 Response format

    • 2.2.7 Supported methods

    • 2.2.8 Domain names and resources that can be managed by APIs

    • 2.2.9 Query parameter

    • 2.2.10 Request header

    • 2.2.11 Using HQL standard

    • 2.2.12 Domain object format

    • 2.2.13 Response header

    • 2.2.14 Members of resources

    • 2.2.15 Members to be returned for APIs that execute JP1/AO operations

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

    • 2.2.17 Status code

    • 2.2.18 Error information

  • 2.3 API description format

  • 2.4 Service template-related API functions

    • 2.4.1 Acquisition of a list of service templates

    • 2.4.2 Acquisition of information about a service template

    • 2.4.3 Deletion of a service template

    • 2.4.4 Acquisition of a list of operations for a service template

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

    • 2.4.6 Import of a service template

    • 2.4.7 Acquisition of information necessary for exporting a service template

    • 2.4.8 Export of a service template

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

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

    • 2.4.11 Creation of a service based on a service template

  • 2.5 Service-related APIs

    • 2.5.1 Acquisition of a list of services

    • 2.5.2 Acquisition of service information

    • 2.5.3 Editing a service

    • 2.5.4 Deletion of a service

    • 2.5.5 Acquisition of a list of operations for a service

    • 2.5.6 Acquisition of information necessary for executing a service

    • 2.5.7 Execution of a service

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

    • 2.5.9 Reset of the counter for a service

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

    • 2.5.11 Change of the status of a service to release

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

    • 2.5.13 Change of the status of a service to maintenance

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

    • 2.5.15 Change of the status of a service to disabled

    • 2.5.16 Acquisition of the URL for the details of a service

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

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

  • 2.6 Schedule-related APIs

    • 2.6.1 Acquisition of a list of schedules

    • 2.6.2 Acquisition of schedule information

    • 2.6.3 Acquisition of a list of operations for a schedule

    • 2.6.4 Acquisition of information necessary for canceling a schedule

    • 2.6.5 Cancellation of a schedule

    • 2.6.6 Acquisition of information necessary for pausing a schedule

    • 2.6.7 Pause of a schedule

    • 2.6.8 Acquisition of information necessary for resuming a schedule

    • 2.6.9 Resume of a schedule

  • 2.7 Task-related APIs

    • 2.7.1 Acquisition of a list of tasks

    • 2.7.2 Acquisition of task information

    • 2.7.3 Editing a task

    • 2.7.4 Deletion of a task

    • 2.7.5 Acquisition of a list of task operations

    • 2.7.6 Acquisition of information necessary for stopping task execution

    • 2.7.7 Stoppage of task execution

    • 2.7.8 Acquisition of information necessary for forcibly stopping a task

    • 2.7.9 Forced stoppage of a task

    • 2.7.10 Acquisition of information necessary for re-executing a task

    • 2.7.11 Re-execution of a task

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

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

    • 2.7.14 Acquisition of information necessary for retrying a task (retry from the failed step)

    • 2.7.15 Retry from the failed step

    • 2.7.16 Acquisition of information necessary for retrying a task (retry from the step after the failed step)

    • 2.7.17 Retry from the step after the failed step

    • 2.7.18 Acquisition of information necessary for archiving a task

    • 2.7.19 Archiving a task

    • 2.7.20 Acquisition of a list of steps

    • 2.7.21 Acquisition of task logs

  • 2.8 List of history-related API functions

    • 2.8.1 Acquisition of a list of history records

    • 2.8.2 Deletion of history records (with conditions specified)

    • 2.8.3 Acquisition of a history record

    • 2.8.4 Deletion of history records (with an ID specified)

    • 2.8.5 Acquisition of a list of operations for a history record

  • 2.9 Property-related APIs

    • 2.9.1 Acquisition of a list of property definitions

    • 2.9.2 Acquisition of property definition information

    • 2.9.3 Acquisition of a list of operations for a property definition

    • 2.9.4 Acquisition of lists of property definitions and property values

    • 2.9.5 Acquisition of a list of property values

    • 2.9.6 Batch update of property values

    • 2.9.7 Acquisition of a property value

    • 2.9.8 Update of a property value

    • 2.9.9 Acquisition of a list of operations for a property value

    • 2.9.10 Acquisition of a list of property groups

  • 2.10 Service group-related API functions

    • 2.10.1 Acquisition of a list of service groups

    • 2.10.2 Acquisition of information about a service group

    • 2.10.3 Acquisition of a list of operations for a service group

  • 2.11 Tag-related API functions

    • 2.11.1 Acquisition of a list of tag groups

    • 2.11.2 Acquisition of a list of tags

  • 2.12 API functions for information management

    • 2.12.1 Acquisition of user information

    • 2.12.2 Acquisition of version information

  • 2.13 API usage example

• Appendix

  • A. Reference Information

    • A.1 Version changes

• Index

To Page Top