6.1.1 Provided Ops I components

In the Workflow definition, actions executed in an activity are defined by the actions within the Task model. Details on provided Ops I components that are available for this purpose are shown below.

(Table) List of actions (provided Ops I components)

Information about provided Ops I components for executing JP1/AJS3 jobs is shown below. Use within YAML definitions for Workflow provided as JP1/AJS3 coordination templates. For a description of JP1/AJS3 coordination templates, see “JP1/AJS3”.

(Table) List of actions (provided Ops I components for JP1/AJS3 coordination)

Information about provided Ops I components for executing JP1/IM jobs is shown below. Use within YAML definitions for Workflow provided as JP1/IM coordination templates. For a description of JP1/IM coordination templates, see “Monitoring deterrence”.

(Table) List of actions (provided Ops I components for JP1/IM coordination)

A description of Provided Ops I components is shown below.

(1) oi.fetch_access_token

Obtain Ops I access tokens. These Ops I access tokens are used when executing Ops I REST APIs from within a workflow.

If using oi.fetch_access_token, it is necessary to set the following parameters.

(Table) oi.fetch_access_token parameters

The following secret information must be stored in the location specified by the parameters.
For more information on secrets, see “Creating a secret”.

• username: The username for obtaining Ops I access tokens
• password: The user password for obtaining Ops I access tokens
• domain: Ops I FQDN (Example: “tenant name.ops-integration.com”)

oi.fetch_access_token return values are as below.

(Table) oi.fetch_access_token return values

(2) oi.insert_into_custom_table

Insert specified records into custom tables.

If using oi.insert_into_custom_table, the following parameters must be set.

(Table) oi.insert_into_custom_table parameters

The following secret information must be stored in the location specified by the parameters.
For more information on secrets, see “Creating a secret”.

• username: The username for obtaining Ops I access tokens^*2
• password: The user password for obtaining Ops I access tokens^*2
• domain: Ops I FQDN (Example: “tenant name.ops-integration.com”)
• opsi_token: Ops I token^*3

No return value for oi.insert_into_custom_table.

(3) awx.run_job_template

Execute automation job templates.

If using awx.run_job_template, it is necessary to set the following parameters.

(Table) awx.run_job_template parameters

awx.run_job_template return values are as below.

(Table) awx.run_job_template return values

(4) awx.get_job_result

Obtain the results of automation jobs.

If using awx.get_job_result, it is necessary to set the following parameters.

(Table) awx.get_job_result parameters

awx.get_job_result return values are as below.

(Table) awx.get_job_result return value

(5) ajs.cancel_exec_schedule

This part cancels the next scheduled execution of a Jobnet or job registered on JP1/AJS3.

If using ajs.cancel_exec_schedule, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.cancel_exec_schedule fixed parameters”.

(Table) JP1/AJS3 and JP1/IM common parameters

(Table) JP1/AJS3 common parameters

(Table) ajs.cancel_exec_schedule fixed parameters

ajs.cancel_exec_schedule return values are as follows.

(Table) ajs.cancel_exec_schedule return value

(6) ajs.change_hold

This part temporarily holds or removes the holding status of a Jobnet or job registered on JP1/AJS3.

If using ajs.change_hold, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.change_hold fixed parameters”.

(Table) ajs.change_hold fixed parameters

The ajs.change_hold return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(7) ajs.change_start_time

This part temporarily changes the execution start date of a Jobnet registered on JP1/AJS3, or immediately executes the Jobnet.

If using ajs.change_start_time, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.change_start_time fixed parameters” (see below).

(Table) ajs.change_start_time fixed parameters

The ajs.change_start_time return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(8) ajs.interrupt

This part interrupts the execution of a Jobnet after the job currently being executed with JP1/AJS3 is completed.

If using ajs.interrupt, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.interrupt fixed parameters” (see below).

(Table) ajs.interrupt fixed parameters

The ajs.interrupt return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(9) ajs.kill

This part kills the execution of a job or Jobnet currently being executed with JP1/AJS3.

If using ajs.kill, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.kill fixed parameters” (see below).

(Table) ajs.kill fixed parameters

The ajs.kill return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(10) ajs.register_fixed_exec

This part registers fixed executions for Jobnets registered in JP1/AJS3.

If using ajs.register_fixed_exec, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.register_fixed_exec fixed parameters” (see below).

(Table) ajs.register_fixed_exec fixed parameters

The ajs.register_fixed_exec return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(11) ajs.register_immediate_exec

This part registers immediate executions for Jobnets registered in JP1/AJS3.

If using ajs.register_immediate_exec, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.register_immediate_exec fixed parameters” (see below).

(Table) ajs.register_immediate_exec fixed parameters

The ajs.register_immediate_exec return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(12) ajs.register_planned_exec

This part registers planned executions for Jobnets registered in JP1/AJS3.

If using ajs.register_planned_exec, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.register_planned_exec fixed parameters” (see below).

(Table) ajs.register_planned_exec fixed parameters

The ajs.register_planned_exec return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(13) ajs.rerun

This part reruns the execution of a Jobnet or job registered on JP1/AJS3.

If using ajs.rerun, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/AJS3 common parameters”, and “(Table) ajs.rerun fixed parameters” (see below).

(Table) ajs.rerun fixed parameters

The ajs.rerun return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(14) ajs.show

This part obtains the execution information of a Jobnet or job registered on JP1/AJS3.

If using ajs.show, it is necessary to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters” and “(Table) JP1/AJS3 common parameters”.

The ajs.show return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(15) im.apply_common_exclusion_conditions_file

This part applies the common exclusion conditions extension definitions file specified in the parameters to JP1/IM and performs/removes monitoring deterrence. Files obtained with im.get_common_exclusion_conditions_file of Provided Ops I components can be used for the common exclusion condition extension definitions file.

If using im.apply_common_exclusion_conditions_file, it is required to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters” and “(Table) JP1/IM common parameters” (see below).

(Table) JP1/IM common parameters

The im.apply_common_exclusion_conditions_file return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(16) im.get_common_exclusion_conditions_file

This part obtains common exclusion conditions extension definition files registered in JP1/IM.

If using im.get_common_exclusion_conditions_file, it is required to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters” and “(Table) JP1/IM common parameters”.

The im.get_common_exclusion_conditions_file return values are the same as “(Table) ajs.cancel_exec_schedule return value”.

(17) im.set_common_exclusion_conditions_valid

This part enables/disables common exclusion conditions extension definitions registered in JP1/IM.

If using im.set_common_exclusion_conditions_valid, it is required to set the following: “(Table) JP1/AJS3 and JP1/IM common parameters”, “(Table) JP1/IM common parameters”, and “(Table) im.set_common_exclusion_conditions_valid fixed parameters”.

(Table) im.set_common_exclusion_conditions_valid fixed parameters

The im.set_common_exclusion_conditions_valid return values are the same as “(Table) ajs.cancel_exec_schedule return value”.