oracle.oci.oci_os_management_scheduled_job – Manage a ScheduledJob resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a ScheduledJob resource in Oracle Cloud Infrastructure
For state=present, creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups. Can be created as a one-time execution in the future, or as a recurring execution that repeats on a defined interval.
This resource has the following action operations in the oracle.oci.oci_os_management_scheduled_job_actions module: change_compartment, run_scheduled_job_now, skip_next_scheduled_job_execution.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
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
|
|
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
|
|
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
|
OCID for the Compartment
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
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 . |
||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
description
string
|
Details describing the Scheduled Job.
This parameter is updatable.
|
||
display_name
string
|
Scheduled Job name
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
||
interval_type
string
|
|
the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)
This parameter is updatable.
|
|
interval_value
string
|
the value for the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)
This parameter is updatable.
|
||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
managed_instance_groups
list
/ elements=dictionary
|
The list of managed instance groups this scheduled job operates on (mutually exclusive with managedInstances). Either this or managedInstances must be supplied.
|
||
display_name
string
/ required
|
User friendly name
aliases: name |
||
id
string
/ required
|
unique identifier that is immutable on creation
|
||
managed_instances
list
/ elements=dictionary
|
The list of managed instances this scheduled job operates on (mutually exclusive with managedInstanceGroups). Either this or the managedInstanceGroups must be supplied.
|
||
display_name
string
/ required
|
User friendly name
aliases: name |
||
id
string
/ required
|
unique identifier that is immutable on creation
|
||
operation_type
string
|
|
the type of operation this Scheduled Job performs
Required for create using state=present.
This parameter is updatable.
|
|
os_family
string
|
|
The Operating System type of the managed instance(s) on which this scheduled job will operate. If not specified, this defaults to Linux.
|
|
package_names
list
/ elements=dictionary
|
the id of the package (only if operation type is INSTALL/UPDATE/REMOVE)
This parameter is updatable.
|
||
name
string
/ required
|
package identifier
|
||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|
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. |
||
schedule_type
string
|
|
the type of scheduling this Scheduled Job follows
Required for create using state=present.
This parameter is updatable.
|
|
scheduled_job_id
string
|
The ID of the scheduled job.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
state
string
|
|
The state of the ScheduledJob.
Use state=present to create or update a ScheduledJob.
Use state=absent to delete a ScheduledJob.
|
|
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 |
||
time_next_execution
string
|
the desired time for the next execution of this Scheduled Job
Required for create using state=present.
This parameter is updatable.
|
||
update_names
list
/ elements=string
|
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.
This parameter is updatable.
|
||
update_type
string
|
|
Type of the update (only if operation type is UPDATEALL)
This parameter is updatable.
|
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create scheduled_job
oci_os_management_scheduled_job:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
schedule_type: ONETIME
time_next_execution: time_next_execution_example
operation_type: INSTALL
# optional
managed_instances:
- # required
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
managed_instance_groups:
- # required
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
os_family: LINUX
description: description_example
interval_type: HOUR
interval_value: interval_value_example
update_type: SECURITY
package_names:
- # required
name: name_example
update_names: [ "update_names_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update scheduled_job
oci_os_management_scheduled_job:
# required
scheduled_job_id: "ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
schedule_type: ONETIME
time_next_execution: time_next_execution_example
interval_type: HOUR
interval_value: interval_value_example
operation_type: INSTALL
update_type: SECURITY
package_names:
- # required
name: name_example
update_names: [ "update_names_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update scheduled_job using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_os_management_scheduled_job:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
schedule_type: ONETIME
time_next_execution: time_next_execution_example
interval_type: HOUR
interval_value: interval_value_example
operation_type: INSTALL
update_type: SECURITY
package_names:
- # required
name: name_example
update_names: [ "update_names_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete scheduled_job
oci_os_management_scheduled_job:
# required
scheduled_job_id: "ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete scheduled_job using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_os_management_scheduled_job:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)