oracle.oci.oci_os_management_scheduled_job_actions – Perform actions on a ScheduledJob resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_os_management_scheduled_job_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a ScheduledJob resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

  • For action=run_scheduled_job_now, this will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.

  • For action=skip_next_scheduled_job_execution, this will force an already created Scheduled Job to skip its next regularly scheduled execution

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
  • run_scheduled_job_now
  • skip_next_scheduled_job_execution
The action to perform on the ScheduledJob.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment into which the resource should be moved.
Applicable only for action=change_compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
scheduled_job_id
string / required
The ID of the scheduled job.

aliases: id
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Perform action change_compartment on scheduled_job
  oci_os_management_scheduled_job_actions:
    # required
    scheduled_job_id: "ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Perform action run_scheduled_job_now on scheduled_job
  oci_os_management_scheduled_job_actions:
    # required
    scheduled_job_id: "ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx"
    action: run_scheduled_job_now

- name: Perform action skip_next_scheduled_job_execution on scheduled_job
  oci_os_management_scheduled_job_actions:
    # required
    scheduled_job_id: "ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx"
    action: skip_next_scheduled_job_execution

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
scheduled_job
complex
on success
Details of the ScheduledJob resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'interval_type': 'HOUR', 'interval_value': 'interval_value_example', 'is_restricted': True, 'lifecycle_state': 'CREATING', 'managed_instance_groups': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'managed_instances': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'operation_type': 'INSTALL', 'os_family': 'LINUX', 'package_names': [{'name': 'name_example'}], 'schedule_type': 'ONETIME', 'time_last_execution': '2013-10-20T19:20:30+01:00', 'time_next_execution': '2013-10-20T19:20:30+01:00', 'update_names': [], 'update_type': 'SECURITY', 'work_requests': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]}
 
compartment_id
string
on success
OCID for the Compartment

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Details describing the Scheduled Job.

Sample:
description_example
 
display_name
string
on success
Scheduled Job name

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
OCID for the Scheduled Job

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
interval_type
string
on success
the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)

Sample:
HOUR
 
interval_value
string
on success
the value for the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)

Sample:
interval_value_example
 
is_restricted
boolean
on success
true, if the schedule job has its update capabilities restricted. (Used to track Autonomous Scheduled Job)

Sample:
True
 
lifecycle_state
string
on success
The current state of the Scheduled Job.

Sample:
CREATING
 
managed_instance_groups
complex
on success
the list of managed instance groups this scheduled job operates on (mutually exclusive with managedInstances)

   
display_name
string
on success
User friendly name

Sample:
display_name_example
   
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
managed_instances
complex
on success
the list of managed instances this scheduled job operates on (mutually exclusive with managedInstanceGroups)

   
display_name
string
on success
User friendly name

Sample:
display_name_example
   
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
operation_type
string
on success
the type of operation this Scheduled Job performs

Sample:
INSTALL
 
os_family
string
on success
The Operating System type of the managed instance.

Sample:
LINUX
 
package_names
complex
on success
the names of the updates (only if operation type is INSTALL/UPDATE/REMOVE)

   
name
string
on success
package identifier

Sample:
name_example
 
schedule_type
string
on success
the type of scheduling this Scheduled Job follows

Sample:
ONETIME
 
time_last_execution
string
on success
the time of the last execution of this Scheduled Job

Sample:
2013-10-20T19:20:30+01:00
 
time_next_execution
string
on success
the time of the next execution of this Scheduled Job

Sample:
2013-10-20T19:20:30+01:00
 
update_names
list / elements=string
on success
The unique names of the Windows Updates (only if operation type is INSTALL). This is only applicable when the osFamily is for Windows managed instances.

 
update_type
string
on success
Type of the update (only if operation type is UPDATEALL)

Sample:
SECURITY
 
work_requests
complex
on success
list of Work Requests associated with this Scheduled Job

   
display_name
string
on success
User friendly name

Sample:
display_name_example
   
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)