oracle.oci.oci_work_requests_work_request_facts – Fetches details about one or multiple WorkRequest resources 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_work_requests_work_request_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple WorkRequest resources in Oracle Cloud Infrastructure

  • Lists the work requests in a compartment or for a specified resource.

  • If work_request_id is specified, the details of a single WorkRequest will be returned.

Requirements

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

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
    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.
Required to list multiple work_requests.
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.
resource_id
string
The OCID of the resource.
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
work_request_id
string
The OCID of the work request.
Required to get a specific work_request.

aliases: id

Examples

- name: Get a specific work_request
  oci_work_requests_work_request_facts:
    # required
    work_request_id: "ocid1.workrequest.oc1..xxxxxxEXAMPLExxxxxx"

- name: List work_requests
  oci_work_requests_work_request_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    resource_id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
work_requests
complex
on success
List of WorkRequest resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'operation_type': 'operation_type_example', 'percent_complete': 3.4, 'resources': [{'action_type': 'CREATED', 'entity_type': 'entity_type_example', 'entity_uri': 'entity_uri_example', 'identifier': 'identifier_example'}], 'status': 'ACCEPTED', 'time_accepted': '2013-10-20T19:20:30+01:00', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the compartment that contains the work request.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The OCID of the work request.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
operation_type
string
on success
The asynchronous operation tracked by this work request.

Sample:
operation_type_example
 
percent_complete
float
on success
The percentage complete of the operation tracked by this work request.

Sample:
3.4
 
resources
complex
on success
The resources that are affected by this work request.
Returned for get operation

   
action_type
string
on success
The way in which this resource was affected by the operation that spawned the work request.

Sample:
CREATED
   
entity_type
string
on success
The resource type the work request affects.

Sample:
entity_type_example
   
entity_uri
string
on success
The URI path that you can use for a GET request to access the resource metadata.

Sample:
entity_uri_example
   
identifier
string
on success
An OCID or other unique identifier for the resource.

Sample:
identifier_example
 
status
string
on success
The status of the work request.

Sample:
ACCEPTED
 
time_accepted
string
on success
The date and time the work request was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_finished
string
on success
The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`. Format is defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)