Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Ops Center Automator CLI commands

Ops Center Automator gives a set of CLI commands.

NoteWhen the Ops Center Automator server is using the Linux OS, read "/" to "-" is used for each argument.

When running Ops Center Automator in a Windows-based OS, navigate to <system-drive>\Program Files\hitachi\Automation\bin, (when running Linux OS, navigate to /opt/hitachi/Automation/bin) then open the command prompt to run the following Ops Center Automator CLI commands.

backupsystem

The backupsystem command backs up the system configuration and database information in the specified folder.

The syntax is:

backupsystem {/dir directoryname [/auto] | /help}

where:

  • /dir is an absolute or relative folder path that contains backup data.
  • /auto directs the Ops Center Automator, Common Component services and database to start and stop automatically.
NoteBefore running the backupsystem command in a cluster environment, you must run the following command to take the group where the Automator service is registered offline and disable failover.
Common-component-Installation-folder\ClusterSetup\hcmds64clustersrvstate.bat /soff /r group-name
deleteremoteconnection

The deleteremoteconnection deletes the agentless connection-destination definitions registered through Ops Center Automator based on the definition ID derived with the listremoteconnections command.

The syntax is:

deleteremoteconnection {/id definition-ID [/user username | /user username  /passwordfile passwordfile] 
[/authmode local | external] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /id is the single-byte numerical ID (between 1 - 64 characters in length) of the agentless connection-destination definition information to delete; if the specified ID does not exist, an error is generated.
  • /user is a user ID.
  • /passwordfile is a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
deleteservicetemplate

The deleteservicetemplate command deletes a service template.

The syntax is:

deleteservicetemplate {/name service-template-key-name /vendor 
vendor-ID /version XX.YY.ZZ [/user username | /user username  /passwordfile passwordfile] 
[/authmode local | external] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /name is the key name of a service template.
  • /vendor is the vendor ID of a service template.
  • /version is a version of a service template.
  • /user is a user ID.
  • /passwordfile is a password file (with absolute or relative path) that includes the encrypted user credentials.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
encryptpassword

The encryptpassword command creates a file that includes an encrypted user name and password. You can specify the password file instead of the password for any Ops Center Automator command that allows the /passwordfile option.

The syntax is:

encryptpassword {[/user username] /passwordfile passwordfile [/authmode local | external ] | /help }
NoteYou are prompted to enter the password in interactive mode.

where:

  • /user is the ID of the user who is added to the password file.
  • /passwordfile is the name of the password file (with absolute or relative path) that includes the encrypted user credentials.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
importservicetemplate

The importservicetemplate command imports a service template.

The syntax is:

importservicetemplate 
{/file service-template [/user username | /user username  /passwordfile passwordfile] [/authmode local | external ] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /file is the service template file to import.
  • /user is a user ID.
  • /passwordfile is a password file (with absolute or relative path) that includes the encrypted user credentials.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
listremoteconnections

The listremoteconnections command outputs a listing of the agentless connection-destination definitions registered in Ops Center Automator to a CSV formatted file.

The syntax is:

listremoteconnections {/file output-file [/user username | /user username  /passwordfile passwordfile] [/authmode local | external ]
 | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /file is the path of the file to which the list is output; if the specified file already exists, an error is generated.
  • /user is the name of the user executing the command. The user name can consist of any single-byte alphanumeric characters including ( ! # $ % & ' ( ) * + - . = @ \ ^ _ |) from 1 - 256 characters in length. The user name is case sensitive.
  • /passwordfile is a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
listservices

The listservices command exports a list of services or a list of service templates to a CSV file.

The syntax is:

listservices {/output {services | servicetemplates} /file output-file 
[/encoding encoding] [/user username | /user username  /passwordfile passwordfile] [/authmode local | external ] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /output is either services (export services) or servicetemplates (export service templates).
  • /file is the output file path.
  • /encoding is the encoding of the output file, either UTF-8 or Shift_JIS.
  • /user is a user ID.

    The Submit role is required to output services list. The Modify role is required to output service templates list.

  • /passwordfile is a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
listtasks

The listtasks command exports a list of services or a list of tasks to a CSV file.

The syntax is:

listtasks {[/startrange {yyyy-mm-dd | ,yyyy-mm-dd 
| yyyy-mm-dd, yyyy-mm-dd}] /output {tasks |
 histories | taskdetails} {/file outputfile 
| /taskdetaildir directoryname} [/encoding encoding]
 [/user username | /user username  /passwordfile passwordfile] [/authmode local | external] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /startrange is the date range of the task start date. Use this to limit the contents of the list to tasks run within a specific period of time.
  • /output is either of the following output data types: tasks (export tasks), histories (export histories), taskdetails (export task with properties)
  • /file is an output file with an absolute or relative path.
  • /taskdetaildir is an output file with an absolute or relative path. /taskdetaildir is required instead of /file when /output taskdetails is specified.
  • /encoding is the encoding of the output file, either UTF-8 or Shift_JIS
  • /user is a user ID. The Admin role is required to output taskdetails.
  • /passwordfile is the absolute or relative path of the password file.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
restoresystem

The restoresystem command restores the system configuration and database information from the specified folder where the data was backed up.

The syntax is:

restoresystem {/dir directoryname [/auto] | /help}

where:

  • /dir is an absolute or relative folder path that contains data that is backed up by the backupsystem command
  • /auto directs the Ops Center Automator, Common Component services and database to start and stop automatically.
NoteBefore running the restoresystem command in a cluster environment, you must run the following command to take the group where the Automator service is registered offline and disable failover.
Common-component-Installation-folder\ClusterSetup\hcmds64clustersrvstate.bat /soff /r group-name
setremoteconnection

The setremoteconnection command adds or updates agentless connection-destination definitions in Ops Center Automator through a CSV file.

The syntax is:

setremoteconnection {/file input-file
[/user username | /user username  /passwordfile passwordfile] 
[/authmode local | external] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /file is the path of the file that contains the agentless connection-destination definitions to be added or updated; if the specified file does not exist, an error is generated. Absolute paths and relative paths are both acceptable.
  • /user is the name of the user executing the command. The user name can consist of any single-byte alphanumeric characters including ( ! # $ % & ' ( ) * + - . = @ \ ^ _ |) from 1 - 256 characters in length. The user name is case sensitive.
  • /passwordfile is a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
setupcluster

The setupcluster command sets up an Ops Center Automator cluster environment.

The syntax is:

setupcluster {/exportpath exportpath | /help}

where :

  • /exportpath is the absolute or relative path of the folder on a shared disk used to store the database and server information.
stoptask

The stoptask command stops a running task.

The syntax is:

stoptask {/taskid task-ID [/user username | /user username  /passwordfile passwordfile] [/authmode local | external] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.

where:

  • /taskid is a task ID. You can confirm the task ID from the Task Details window, output of submittask command, output of listtasks command.
  • /user is a user ID.
  • /passwordfile is the absolute or relative path of the password file.
  • /authmode local | external specifies the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
submittask

The submittask submits a task for a service.

For more information, see the submittask command section.

setupcommonservice command

The setupcommonservice command is a setting command for linking with Common Services. The setupcommonservice command registers Ops Center Automator as an application in Common Services and sets Ops Center Automator as an authentication server that uses Common Services.

NoteYou must use the Ops Center portal to remove an Ops Center Automator registered in Common Services.
Functions

The setupcommonservice command registers the Ops Center Automator URL in Common Services. The URL to be registered uses the URL registered in the hcmds64chgurl command. Confirm in advance that the URL registered in hcmds64chgurl can be resolved by the browser, then run the setupcommonservice command.

This command needs a secure connection between Ops Center Common Services and Ops Center Automator.

Syntax

Windows syntax:

setupcommonservice {[/csUri CommonServiceUri | /csUri CommonServiceUri /csUsername CommonServiceUsername] [/appName ApplicationName] 
[/appDescription ApplicationDescription] [ /auto ] | /help }

Linux syntax:

setupcommonservice {[-csUri CommonServiceUri | -csUri CommonServiceUri -csUsername CommonServiceUsername] [-appName ApplicationName] 
[-appDescription ApplicationDescription] [ -auto ] | -help }
NoteYou are prompted to enter the password in interactive mode.
Options
Option Description
csUri Specify the URL of Common Services. (For example: https://common.service/portal)
csUsernameSpecify a user with opscenter-security-administrator privileges to be managed by Common Services. The username can be 1-byte alphanumeric characters. This includes (! # $% & '() * +-. = @ ^ _ |). The length is from 1 to 255 characters. Usernames are case-sensitive.

You are prompted to enter the password when you run the command with this option.

appName Specify the name of the Ops Center Automator to be displayed by Common Services. The name is specified with 1 to 128 characters.

If appName is omitted at the time of new registration, the host name or IP address of Ops Center Automator is set as the name. If appName is omitted when updating, the name is not changed.

appDescriptionSpecify a description of the Ops Center Automator displayed by Common Services. The description can be from 0 to 512 characters.
autoAutomatically start and stop the services and databases of Ops Center Automator.

changemode command

The changemode command allows you to change the performance mode for Ops Center Automator. There are two performance modes, standard and high performance.

  • Standard mode

    This is the default mode which supports running a single Online Migration with Configuration Manager task.

  • High performance mode

    Use high performance mode if you need to run multiple Online Migration with Configuration Manager tasks concurrently. If you select this mode, you will need to change the logger.TA.MaxFileSize and plugin.threadPoolSize parameters in config_user.properties. For more information, see "Changing the system configuration" in the Hitachi Ops Center Automator Installation and Configuration Guide.

Syntax
changemode {/mode {standard| highPerformance} [/auto] |  /print |  /help}
Options
OptionDescription
/modeSpecify a performance mode, either standard (standard mode) or highPerformance* (high performance mode).
/autoOptionally stop and start services that use Common Component and HiRDB automatically. To specify this option in a cluster environment, the services registered in the cluster software must be offline.
/printOutput the current mode.
/helpDisplay command help.
*: If you change the mode to highPerformance, you need to change the logger.TA.MaxFileSize and plugin.threadPoolSize parameters in config_user.properties. For more information, see "Changing the system configuration" in the Hitachi Ops Center Automator Installation and Configuration Guide.
Permissions

Ops Center Automator users must have Administrator permissions in Window or root permissions in Linux.

Return codes

The following table lists the changemode command return codes and descriptions.

Return code Description
0 The command succeeded.
1 The argument is not valid.
2 The command stopped.
3 The service status is not valid.
4 An exclusion error has occurred.
101Cannot change the mode because it failed due to a cause other than those listed above.
90Cannot start or stop the service.
255 The command stopped because of an error not in this table.
Usage example: To change to high performance mode
changemode /mode highPerformance
Usage example: To change to standard mode and specify the auto option
changemode /mode standard /auto
Usage example: To output the current mode
changemode /print
Output example: Changing to high performance mode
# changemode /mode highPerformance

KNAE03000-I The changemode command will now start.
KNAE03542-I
Changed to high performance mode. Set the following values in config_user.properties: 
logger.TA.MaxFileSize=100240
plugin.threadPoolSize=100
After updating config_user.properties, restart the service.
KNAE03001-I The changemode command ended normally.

submittask command

The submittask command submits a service for execution using the specified service name, service group name, and property options, and returns the task ID as the execution output of the command.

Functions

The submittask command has four functions:

  • Immediate execution of a service.
  • Scheduled execution of a service.
  • Recurrent execution of a service.
  • Reregistration of tasks.

    If this option is specified, you can reregister tasks that were output by the listtasks command with the taskdetails option.

Syntax: Immediate execution of a service
submittask {/servicename ServiceName [/servicegroup ServiceGroup]
	[/taskname  TaskName]
	[/taskdescription TaskDescription]
	[{[/property Key "Value"]... | /propertyfile PropertyFile}]
	[/user UserName | /user UserName /passwordfile PasswordFile]
	[/wait]
	[/authmode local | external] | /help}
Syntax: Scheduled execution of a service
submittask {/servicename ServiceName
	[/servicegroup ServiceGroup]
	[/taskname TaskName]
	[/taskdescription TaskDescription]
	[{[/property Key "Value"]... | /propertyfile PropertyFile}]
	[/user UserName | /user UserName /passwordfile PasswordFile]
	/scheduledate yyyy-mm-dd
	/scheduletime hh:mm 
	[/authmode local | external] | /help}

Syntax: Recurrent execution of a service

submittask {/servicename ServiceName
	[/servicegroup ServiceGroup]
	[/taskname TaskName]
	[/taskdescription TaskDescription]
	[{[/property Key "Value"]... | /propertyfile PropertyFile}]
	[/user UserName | /user UserName /passwordfile PasswordFile]
	/recurrencepattern {daily[:{1h|2h|3h|4h|6h|8h|12h|24h}] |
	weekly:sun,mon,...,sat | monthly:{dd,dd,...,dd
	[,endofmonth] | endofmonth}}
	/recurrencetime hh:mm /recurrencestart yyyy-mm-dd
	[/authmode local | external] | /help}
Syntax: Reregistration of tasks
submittask {/reregister
	/taskdetaildir DirectoryName
	[/setoriginalsubmitter]
	[/user UserName | /user UserName /passwordfile PasswordFile]
	[/authmode local | external] | /help}
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.
Permission
  • To run this command, you must have the Admin, Modify, or Submit role in Ops Center Automator and Administrator permission for the OS.
  • You cannot run services that are in a service group whose role is not set.
  • The service you want to run must belong to the service group with a role that is assigned by the user group. The user must belong to the user group.
Options
Option Description
/servicename

Specify a service name.

The name of a service you want to submit. The service name can be 1 to 128 characters long.

/servicegroup

Specifies a service group to which the service belongs.

The name of the service group that the service belongs to. This is an optional parameter.

If you omit this option, the service group that is associated with the user who is specified in the /user option is used. However, if more than one service group is associated with that user, an error occurs.

The service group name can be 1 to 80 characters long and consists of half-width alphanumeric characters and _ (underscore).

/taskname

Specify a task name.

The name of the task. If you omit this option, the system defaults to service-name_YYYYMMDDhhmmss, where service-name is the value of the /servicename option and YYYYMMDDhhmmss is the time when the service runs.

The task name can be 1 to 128 characters long and can consists of any characters except control characters ('\u0000'~'\u001F' or \u007F'~'\u009F').

This is an optional parameter.

/taskdescription

Specify a task description.

The description of the task. The description can be 1 to 256 characters long and can consists of any characters except control characters ('\u0000'~'\u001F' or \u007F'~'\u009F').

This is an optional parameter.

/property

Specify a property key and value.

One or more property key-value combinations that are used by the service to be performed.

If a property value is not set for a key, the default value used. If the value of a required property key is not set, then an error occurs.

You cannot specify both the /property and the /propertyfile options. If you do, then an error occurs.

You can specify this option more than one time, for example, /property property-key-1 property-value-1 /property property-key-2 property-value-2. The maximum number of combinations of property keys and values available is 1000 pairs. This value can be changed by using the server.editor.publicProperty.perTemplate.maxnum key in the config_user.properties file.

  • key is the property key for the service. It can be 1 to 1024 characters long. The key consists of half-width alphanumeric characters and the following characters: / (slash), . (period), (hyphen), and _ (underscore). Specifying the same property key more than one time causes an error.
  • value is the value for the key property. If the value includes a space or special character, the value must be enclosed in double quotation marks (").
/propertyfile

Specify a properties file. Use an absolute or relative path.

The name of a properties file, including an absolute or relative path, that defines the property settings that the service you want to perform uses.

Property keys and values that are not specified in the properties file are set to default values. If you do not specify a required property key and that key has no default value, then an error occurs.

This option and the /property option cannot be specified at the same time. If both options are specified, then an error occurs.

Additional requirements:

  • Location: The properties file can be in any folder. However, the user who runs the command must be able to access it.
  • File name: Any file name.
  • Key-value combination format:

    property-key=property-value(linefeed code)

    property-key=property-value(linefeed code)

If you add a suffix @FILE to the key, it is possible to specify a text file to value. For example, key@FILE=C:\properties\valuefile.txt.

/user

Specify a user ID.

The ID for the Ops Center Automator user who has access permission to run the service.

The ID can be 1 to 256 half-width alphanumeric characters. It can consist of any characters, except the following: ! # $ % & ( ) * + - . = @ \ ^ _ |. The ID is not case-sensitive.

/passwordfile

Specify a password file. Use an absolute or relative path.

The absolute or relative path to the password file for the user who is specified in the /user option.

You can create a password file by using the encryptpassword command.

/wait

Wait for a task to finish.

Shows the task execution result (normal termination or failure). If the /wait option is not specified, the command ends without waiting for the task to end. In this case, a message reporting the task ID is provided only when the task execution has started normally.

/scheduledate

Specify a date for executing a service.

When this option is specified, any of the following conditions will result in an error:

  • A combination of arguments that is not valid.
  • The form of the specified date is incorrect.
  • The time indicated by / scheduledate and / scheduletime is in the past. The relevant time is server time.
  • The specified date is outside the range of January 1, 1994 to December 31, 2036

Format:

Specify the date in the form of "yyyy-mm-dd." Specify the year as yyyy in four digits. Specify the month as mm in the range 1 (or 01) to 12. Specify a day as dd in the range 1 (or 01) to 31.

/scheduletime

Specify a time for executing a service.

When this option is specified, any of the following conditions will result in an error:

  • A combination of arguments that is not valid.
  • The form of the specified time is incorrect.
  • The time indicated by / scheduledate and / scheduletime is in the past. The relevant time is server time.

Specify the time in the form of "hh:mm." Specify hours as hh in the range 0 (or 00)-23. Specify minutes as mm in the range 0 (or 00)-59.

/recurrencepattern

Specify a pattern for a recurring service.

Use this option with the /recurrencetime option, and the /recurrencestart option.

When this option is specified, the following conditions will result in an error:

  • A combination of arguments that is not valid.
  • The format of the specified fixed execution cycle is incorrect.

Recurrence options and formats:

  • Daily: specify "daily:1h, 2h, 3h, 4h, 6h, 8h, 12h, 24h". The default recurrence is every 24 hours.
  • Weekly: specify "weekly:sun, mon, ..." using three letter English abbreviations for days of the week and comma-separated values following a colon. The days can be in any order.
    • Sunday: sun
    • Monday: mon
    • Tuesday: tue
    • Wednesday: wed
    • Thursday: thu
    • Friday: fri
    • Saturday: sat
  • Monthly: specify two-digit comma-separated values following a colon. For the last day of the month, specify "endofmonth."
/recurrencetime

Specify the execution time for a recurring service.

Use this option with the /recurrencepattern option, and the /recurrencestart option.

When this option is specified, the following conditions will result in an error:

  • A combination of arguments that is not valid.
  • The form of the specified time is inaccurate.

Format:

Specify the time in the form of "hh:mm." Specify hours as hh in the range 0 (or 00) to 23. Specify minutes as mm in the range 0 (or 00) to 59.

/recurrencestart

Specify a date for a recurring service to start.

Use this option with the /recurrencepattern option, and the /recurrencetime option.

When this option is specified, the following conditions will result in an error:

  • A combination of arguments that is not valid.
  • The form of the specified date is inaccurate.
  • The specified date is outside the range on January 1, 1994 to December 31, 2036.

Format:

Specify the date in the form of "yyyy-mm-dd." Specify the year as yyyy in four digits. Specify the month as mm in the range 1 (or 01) to 12. Specify a day as dd in the range 1 (or 01) to 31.

/reregister

Specify to reregister scheduled tasks.

This option has no value.

/taskdetaildir

Specify a folder that was output by the listtasks command with the /taskdetails option. Use an absolute or relative path.

The folder must be located on a local disk.

The maximum path length is 180 characters.

/setoriginalsubmitter

Specify whether you want to reregister tasks as the user at the point in time in which task details were output.

This option has no value.

When this option is not specified, the user ID specified as the /user of the submittask command serves as the assigned user of the task after reregistration.

/authmode local | external Specify the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
/help

Show command syntax and usage.

Command location

installation-folder\bin

Return codes

The following table lists the submittask command return codes and descriptions.

Return code Description
0 The command succeeded.
1 The argument is not valid.
2 The command stopped.
3 The service status is not valid.
4 The number of commands that can be run simultaneously is exceeded.
5 Communication failed.
6 Authentication failed.
7 A path is specified that is not valid.
9 Path not found.
10 Path cannot be accessed.
14 You do not have permission to run the command.
17The interactive input value is not valid.
130 The service did not start.
131 The properties file does not exist.
132 The properties file has a format that is not valid.
133 The command with /wait option failed to get the current command status.
134 The task failed.
135 The task was canceled.
136 The contents of the folder specified by the /taskdetails option are not valid.
137 Some part of the tasks failed to be registered by the command with the /reregister option.
138 All tasks failed to be registered by the command with the /reregister option.
139

The content of task detail folder is different from the current version or revision.

255 The command stopped due to an error other than the ones listed in this table.
Example: Immediate execution of a service
submittask /servicename "Execute Remote Command"
        /servicegroup "Default Service Group"
        /taskname "Submittask sample"
        /taskdescription "This is a sample."
        /property common.targetHost host01 /property common.remoteCommand ipconfig
        /user Bob
Example: Scheduled execution of a service
submittask /servicename "Execute Remote Command"  
        /propertyfile "C:\temp\properties.txt"
        /scheduledate 2020-01-23 /scheduletime 12:34
        /user Bob
        
Example: Recurrent execution of a service
submittask /servicename "Execute Remote Command" 
        /propertyfile "C:\temp\properties.txt"
        /recurrencepattern weekly:sun,mon,sat
        /recurrencetime 12:34 /recurrencestart 2020-01-23
        /user Bob
Example: Reregistration of tasks
submittask /reregister /taskdetaildir "C:\temp\taskdetails"
        /user Bob

listremoteconnections command

The listremoteconnections command outputs a listing of the agentless connection-destination definitions registered through Ops Center Automator to a CSV formatted file.

Functions

The listremoteconnections command performs the following functions:

  • output a list of agentless connection-destination definitions that include names of connection destinations and credential information.
  • The CSV file that you have output can be used as an input file for the setremoteconnection command as-is.
Syntax:
listremoteconnections {/file OutputFile  
[/user UserName | /user UserName /passwordfile PasswordFile] 
[/authmode local | external] | /help} 
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.
Permission
  • Ops Center Automator users must have Admin permissions.
  • Only users who have OS administrator permissions (members of the Administrators group) are allowed to run the listremoteconnections command.
  • If a user who does not have the necessary permissions runs the command, the following message appears, asking for the promotion of the user's permissions:

    KNAE03226-E The user does not have permission to execute the command.
Options
Option Description
/file

Specifies the path of the file to which the list is output; if the specified file already exists, an error is generated. .

/user

Specifies the name of the user executing the command. The user name can consist of any single-byte alphanumeric characters including ( ! # $ % & ' ( ) * + - . = @ \ ^ _ |) from 1 - 256 characters. The user name is case-sensitive.

/passwordfile

Specifies a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user.

/authmode local | external Specify the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
Storage Destination

installation-folder\bin

Return codes

The following table lists the listremoteconnections command return codes and descriptions.

Return code Description
0 The command succeeded.
1 The argument is not valid.
2 The command stopped.
3 The service status is not valid.
4 An exclusion error has occurred.
5 Communication failed.
6 Authentication failed.
7 A path is specified is not valid.
8 A file with the specified name already exists.
9 Path not found.
10 Path cannot be accessed.
13 Failed to output the specified file.
14 User does not have permission to run the command.
17The interactive input value is not valid.
220 Failed to acquire a list of agentless connection-destination definitions.
255 The command stopped because of an error not in this table.
Data Format

Agentless connection destinations are output in CSV format with one host in one line and with the following data items in the order in which they are shown in the following table.

Property Header Section (first line) Data Section (second and subsequent lines)
Definition ID Id Agentless connection-destination definition ID
Connection destination type Method Connection destination can be specified as follows:
  • IPv4: The connection destination is an IP address in the IPv4 format.
  • IPv6: The connection destination is an IP address in the IPv6 format.
  • HostName: The connection destination is a host name.
Connection destination IP Address/Host Name IP address or host name of the connection-destination host.
Service resource group Service Group Service group name allocated to the agentless connection-destination definition.
Authentication information Authentication Can be either of the following:
  • Enable: Authentication information is set
  • Disable: Authentication information is not set
Protocol Protocol Can be any of the following:
  • Windows: Connect using Windows-based OS
  • SSH: Connect using SSH
  • Telnet: Connect using Telnet
SSH authentication method SSH authentication method

When the protocol is not SSH, null character ("")

When the protocol is SSH, any one of the following:

  • Password Authentication
  • Public Key Authentication
  • Keyboard Interactive Authentication
User ID User ID User ID of the user who logs on to the connection-destination host.
Password Password Fixed to "*******"
Super user's password Super user's password Fixed to "*******"
Status Connection Status Connection Successful, Error, Unknown, or -.
Last connection time Connected Time The last connection time.
Usage example: To output a list of registered agentless connection-destination definitions to a file
listremoteconnections /file bbbbb /user xxxxx
Example: Output message for successful list
KNAE03000-I The listremoteconnections command will now start.
KNAE03001-I The listremoteconnections command ended normally.
Example: Output message for unsuccessful list
KNAE03000-I The listremoteconnections command will now start.
KNAE03002-E The listremoteconnections command ended abnormally (12345).
Example: Typical output file
"Id","Method","IP Address/Host Name","Service Group","Authentication ","Protocol","SSH Authentication Method","User ID","Password","Super User's Password"
"1","IPv4","10.197.158.107","All Service Groups","Enable","Windows","","Administrator@DOM1","********",""
"10","HostName","vmc006","All Service Groups","Enable","SSH","Password Authentication","ao","********","********"
"100","IPv6","fd00::6172:839:2e15:f6f3:da7e"," All Service Groups ","Enable","Telnet","","","",""
"1000","HostName","vmc007"," All Service Groups ","Disable","","","","",""

setremoteconnection command

The setremoteconnection command adds or updates agentless connection-destination definitions in Ops Center Automator through a CSV file.

Function

The setremoteconnection command adds or updates agentless connection-destination definitions in Ops Center Automator. To add or update agentless connection-destination definitions, you define the information in a CSV file and then specify the file name as a command argument.

NoteThe CSV file must have the same format as the output file of the listremoteconnections command.
Syntax:
setremoteconnection {/file Input File  
[/user UserName | /user UserName /passwordfile PasswordFile]
 [/authmode local | external]| /help} 
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.
Permission
  • Ops Center Automator users must have Administrator permissions (members of the OS Administrators group) to run the setremoteconnection command.
  • If a user without the necessary permissions runs the command, the system generates the following message:

KNAE03226-W The user does not have permission to execute the command.
Options
Option Description
/file Specifies the path of the file that contains the agentless connection-destination definitions to add or update. If the specified file does not exist, the system generates an error. Both absolute and relative paths are allowed.
/user Specifies the name of the user running the command. The user name must be between 1 and 256 characters in length and consist of single-byte alphanumeric characters including ( ! # $ % & ' ( ) * + - . = @ \ ^ _ |). The user name is case sensitive.
/passwordfile Specifies a password file (with an absolute or relative path) that includes the encrypted user credentials for the specified user.
/authmode local | external Specify the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
Storage destination

installation-folder\bin

Return codes

The following table lists the setremoteconnection command return codes and descriptions:

Return code Description
0 The command succeeded.
1 The argument is not valid.
2 The command stopped.
3 The service status is not valid.
4 An exclusion error occurred.
5 Communication failed.
6 Authentication failed.
7 A path is specified that is not valid.
9 Path not found.
10 Path cannot be accessed.
14 User does not have permission to run the command.
17The interactive input value is not valid.
230 Format of the agentless connection-destination definition is not valid.
231 Registration of some of the agentless connection-destination definitions failed.
232 Registration of all of the agentless connection-destination definitions failed.
255 The command stopped because of an error not in this table.
File format

The agentless connection-destination definition file that you specify for the /file option uses the same basic format that is used in the output generated by the listremoteconnections command.

The agentless connection-destination definition file differs depending on the environment as follows:

  • In a Windows-based OS environment: Uses character encoding MS932 and line feed code CR+LF.
  • In a Linux OS environment: Uses the character encoding that is specified for the user's LANG environment variable and uses the line feed code LF.
Data item Description
Definition ID

(Id)

Specifies the ID of the agentless connection-destination definition to update. If a null character is specified, the agentless connection-destination definitions are registered as an addition. If the agentless connection-destination definition of the specified ID does not exist, the system generates an error.
Connection destination type

(Method)

Specifies any of the following connection destination types:
  • IPv4: The connection destination is an IP address in IPv4 format.
  • IPv6: The connection destination is an IP address in IPv6 format.
  • HostName: The connection destination is a host name.
Connection destination

(IP Address/Host Name)

Specifies the IP address or host name of the connection-destination host.
Service resource group

(Service Group)

Specifies the service group to allocate to the agentless connection-destination definition.

Note: This parameter is ignored from v8.5.1 onward because agentless connection settings are allocated to infrastructure groups.

Authentication information

(Authentication)

Specifies whether to set authentication information:
  • Enable: Authentication information is set.
  • Disable: Authentication information is not set.

When the system displays the message "Authentication information is not set," any additional data is ignored. However, the data item is still required.

Protocol

(Protocol)

Specifies one of the following protocols:
  • Windows: Connect using a Windows-based OS.
  • SSH: Connect using SSH.
  • Telnet: Connect using Telnet.
SSH authentication method

(SSH Authentication Method)

Specifies the SSH authentication method:
  • When the protocol is not SSH, specify a null character ("").
  • When the protocol is SSH, one of the following:
    • Password Authentication (PW)
    • Public Key Authentication (PK)
    • Keyboard Interactive Authentication (KI)
User ID

(User ID)

Specifies the User ID used to log on to the connection-destination host when the protocol is Windows or SSH. This parameter is required.
Password

(Password)

Specifies the password of the user ID used to log on to the connection-destination host. This parameter is required in some cases and not in others as follows:

Case 1: When no definition ID is specified (when adding a definition).

  • In a Windows-based OS, the parameter is required.
  • When the protocol is SSH the SSH authentication method is not "public key authentication", this parameter is required.

    Note: You cannot specify "********" as a password. The system generates an error if you specify this password.

Case 2: A definition ID is specified (when updating a definition).

  • In a Windows-based OS, the parameter is required.
  • When the protocol is SSH the SSH authentication method is not "public key authentication", this parameter is required.

    Note: If you specify "********" for the password, the password is not changed. If you specify a null character (“”) for the password, the password is deleted.

Super user's password

(Super User's Password)

Specifies the password of a super user of the connection-destination host. When the protocol is SSH or Telnet, this parameter is optional.
  • If you specify a string that is not "********" for the password, the specified string is set as the password.
  • If you specify "********" for the password, the password is not changed.
  • If you specify a null character (“”) for the password, the password is deleted.
Status

(Connection Status)

Specifies either Connection Successful, Error, Unknown, or "-" depending on the status.
Last connection time

(Connected Time)

Specifies the last connection time.
Behavior of the setremoteconnections command

The following lists includes details about the behavior of the setremoteconnections command when specifying an agentless connection-destination definition file for the /file option:

  • The first line of the file is the header section output by the setremoteconnections command and is ignored unconditionally. The second and subsequent lines are treated as agentless connection-destination definitions.
  • When you specify two or more agentless connection-destination definitions in the file, a single syntax error in either definition causes the command to end with an error, and no agentless connection-destination definitions are registered.
  • The values of the data items output by the listremoteconnections command in CSV format are enclosed in double quotation marks ("). However, if the values are not enclosed by double quotation marks, they are not treated as errors. (This is because when you edit a CSV file in Excel, double quotation marks are removed).
  • If the value of the first data item (ID) of an agentless connection-destination definition is a null character, the specified content is added as an agentless connection-destination definition.
  • If a value is specified for the first data item (ID) of an agentless connection-destination definition, the agentless connection-destination definition corresponding to the specified ID is updated with the content specified in the line. If the agentless connection destination definition corresponding to the specified ID does not exist, the system generates an error.
  • When two or more agentless connection-destination definitions are specified in a file and the addition or update portion of the definitions fails, the command results are as follows:

    - A return value (warning, not error) is used to report a definition that was not successfully registered.

    - Information is output as a standard error, which enables you to identify the definition that was not successfully registered.

    - The registration processing continues for all remaining definitions, even if an error occurs.

Usage example: Register or update the agentless connection-destination definitions in Ops Center Automator with the content of a specified file
setremoteconnection /file bbbbb /user xxxxx
Example: Successful registration of agentless connection-destination definition
KNAE03000-I The setremoteconnection command will now start.
KNAE03002-E The remote connection definition was registered (ID:12345, line number: 12345).
Example: Unsuccessful registration or update
KNAE03000-I The setremoteconnection command will now start.
KNAE03002-E The setremoteconnection command ended abnormally (12345).
Example: Error encountered in parameters
KNAE03000-I The setremoteconnection command will now start.
KNAE03333-E A required parameter was not found (parameter name: XXXXX, line number: 12345). Specify the required parameter, and then try again.
KNAE03334-E Unnecessary parameter has been specified (parameter name: XXXXX, line number: 12345). Delete the specified parameters, and then try again.
KNAE03002-E The setremoteconnection command ended abnormally (12345).

deleteremoteconnection command

The deleteremoteconnection command deletes the agentless connection-destination definitions registered through Ops Center Automator based on the definition ID derived with the listremoteconnections command.

Functions

The deleteremoteconnection command performs the following function:

  • Deletes a succession of agentless connection-destination definitions based on their definition IDs. To determine the definition ID of the agentless connection-destination definition, use the listremoteconnections command.
Syntax:
deleteremoteconnection {/id Definition ID  
[/user UserName | /user UserName /passwordfile PasswordFile] 
[/authmode local | external] 
| /help} 
NoteYou are prompted to enter the password in interactive mode if you do not specify the passwordfile option.
Permission
  • Ops Center Automator users must have Admin permissions.
  • Only users who have OS administrator permissions (members of the Administrators group) are allowed to run the deleteremoteconnection command.
  • If a user who does not have the necessary permissions runs the command, the following message is visible requesting promotion of the user's permissions:
KNAE03226-W The user does not have permission to execute the command.
Options
Option Description
/id

Specifies the single-byte numerical definition ID (between 1 - 64 characters) of the agentless connection-destination definition information to be deleted. If the specified ID does not exist, an error is generated.

/user

Specifies the name of the user (must have Admin permission) executing the command. The user name can consist of any single-byte alphanumeric characters including ( ! # $ % & ' ( ) * + - . = @ \ ^ _ |) from 1 - 256 characters in length. The user name is case sensitive.

/passwordfile

Specifies a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user.

/authmode local | external Specify the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties.
Storage destination

installation-folder\bin

Return codes

The following table lists the deleteremoteconnection command return codes and descriptions.

Return code Description
0 The command succeeded.
1 The argument is not valid.
2 The command stopped.
3 The service status is not valid.
4 An exclusion error has occurred.
5 Communication failed.
6 Authentication failed.
14 The user does not have permission to run the command.
17The interactive input value is not valid.
240 Failed to delete an agentless connection-destination definition
255 The command stopped due to an error other than the ones listed in this table.
Usage example: - To delete the agentless connection-destination definition of the ID specified for the parameter
deleteremoteconnection /id 12345 /user xxxxx
Example: Output of normal deletion
KNAE03000-I The deleteremoteconnection command will now start.
KNAE03001-I The deleteremoteconnection command ended normally.
Example: Output of abnormal deletion
KNAE03000-I The deleteremoteconnection command will now start.
KNAE03002-E The deleteremoteconnection command ended abnormally (12345).