List of reserved properties

Ops Center Automator Service Builder User Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99AUT002-18

A reserved property is a special service property whose property key has a specific definition or purpose in Ops Center Automator.

The property key of a reserved property begins with reserved. You can use reserved properties by mapping them to plug-in properties in the Specify Component Input Property Mapping Parameters dialog box or the Specify Component Output Property Mapping Parameters dialog box. Users cannot define or assign values to reserved properties.

When you map a reserved property to an input property, the value of the reserved property is assigned to a plug-in property when the plug-in is run. Alternatively, select the Direct Input option, and in the Value field, specify the reserved property in the format ?dna_reserved-property-key?. In this case, the value of the reserved property supplies part of the value of the plug-in properties at plug-in execution.

When you use a reserved property as an output property, the reserved property stores the value of a designated plug-in property. By selecting the View Property option in the Specify Component Output Property Mapping Parameters dialog box, you can specify a reserved property to which the value of the output property is passed.

Following is a list of reserved properties:

Reserved Property Key Description
reserved.external.hcmds.dir Indicates the folder of Hitachi Command Suite.

Example:

C:\Program Files\HiCommand

reserved.external.path Indicates the path of the REST API to access the dynamic data. For example, in the case of "http://localhost:22015/Automation/v1/objects/ExternalResources/IPAddresses?host=myHost&type=vm", the value becomes "/IPAddresses". The query parameter is not included.
reserved.external.query Indicates the query parameter of the path passing to REST API. For example, in the case of "http://localhost:22015/Automation/v1/objects/ExternalResources/IPAddresses?host=myHost&type=vm", the value becomes "host=myHost&type=vm".
reserved.external.resource.dir Indicates the resource folder of the external resource of the dynamic data.
reserved.external.userName The user name who is logged in to Ops Center Automator from REST API.
reserved.loop.index

reserved.loop.indexN

References a numerical value from 1 to 99 that indicates how many times a Repeated Execution Plug-in, that is one (or N) levels above the base step, has repeated.
reserved.loop.input

reserved.loop.inputN

References the value of the inputProperties input property of a repeated execution plug-in that is one (or N) levels above the base step. Of the comma-delimited values specified in the input properties of the repeated execution plug-in, this property stores the value of the element that corresponds to the current iteration of the flow. For example, if the input property is A,B,C, the values A, B, and C are input in the order corresponding to the repetition count of the flow. The repeated execution plug-in can be run a maximum of 99 times.
reserved.loop.output Passes values to the outputProperties output property of a repeated execution plug-in. The values output to this property are assigned to the output property as a comma-separated value. For example, if the values of the output property of the plug-in are X, Y, and Z for successive iterations, the value X,Y,Z is assigned to the output property.
reserved.service.name References the name of the service from which a task was generated. To reference this reserved property, specify the property key in the format ?dna_reserved.service.name?. You can use this property in any plug-in to which service properties can be mapped.
reserved.service.serviceGroupName References the service group in which the service from which a task was generated is registered. To reference this reserved property, specify the property key in the format ?dna_reserved.service.serviceGroupName?. You can use this property in any plug-in to which service properties can be mapped.
reserved.step.path References the ID of the step that is currently being run. To reference this reserved property, specify the property key in the format ?dna_reserved.step.path?. The value of this property is the same as the step ID visible in the messages output to the task log when plug-in execution begins and ends. You can use this property in any plug-in to which service properties can be mapped.
reserved.step.prevReturnCode Supplies the return value of the preceding step (the step that is the origin of the relational line connected to the plug-in). To reference this reserved property, specify the property key in the format ?dna_reserved.step.prevReturnCode?. If there are multiple preceding steps, the property is assigned the logical sum of all the return values. If there is no preceding step, 0 is assigned. You can use this property in any plug-in to which service properties can be mapped. If you try a task again from a step that references this reserved property without executing the preceding step, the return value from the last time the preceding step was run is set in this reserved property as the return value of the preceding step.
reserved.task.description Supplies the description of a task. To reference this reserved property, specify the property key in the format ?dna_reserved.task.description?. You can use this property in any plug-in to which service properties can be mapped.
reserved.task.dir Supplies the path of the temporary data folder created during task execution. This property shows a unique folder path at execution of each task. The folder referenced by this property is created on the Ops Center Automator server when the task is run, and deleted when the task is archived. Note that files and folders that start with task are reserved in Ops Center Automator, and cannot be created by the user.
reserved.task.id Supplies the task ID. To reference this reserved property, specify the property key in the format ?dna_reserved.task.id?. You can use this property in any plug-in to which service properties can be mapped.
reserved.task.name Supplies the task name. To reference this reserved property, specify the property key in the format ?dna_reserved.task.name?. You can use this property in any plug-in to which service properties can be mapped.
reserved.task.submitter Supplies the user ID of the user who submitted the task for execution. If the task was retried, this property references the user ID of the user who submitted the task, not the user who retried the task. To reference this reserved property, specify the property key in the format ?dna_reserved.task.submitter?. You can use this property in any plug-in to which service properties can be mapped.
reserved.task.tags A reserved property to reference the tags set for a task.
reserved.task.url Supplies the URL for accessing the Task Details dialog box. To reference this reserved property, specify the property key in the format ?dna_reserved.task.url?. You can use this property in any plug-in to which service properties can be mapped.
reserved.terminal.account References the user ID used by a terminal connect plug-in. This property is used by the commandLine input property of a terminal command plug-in. It stores the login name of the user account used to connect to the terminal.
reserved.terminal.password References the password used by a terminal connect plug-in. This property is used by the commandLine input property of a terminal command plug-in. It stores the password of the user account used to connect to the terminal.
reserved.terminal.suPassword References the root password used by the terminal connect plug-in. This property is used by the commandLine input property of a terminal command plug-in. It stores the password of the superuser used to connect to the terminal.