oci_oke_work_request_facts - Retrieve facts of work requests in OCI Container Engine for Kubernetes Service

New in version 2.5.

Synopsis

  • This module retrieves information of a specified work request or lists work requests in a compartment.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_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.
cluster_id
The OCID of the cluster. Use cluster_id with compartment_id to filter work requests related to a cluster in the specified compartment.
compartment_id
The OCID of the compartment. Required to list all the work requests in a compartment.
config_file_location
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 Default:
DEFAULT
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
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
The OCID of the resource associated with a work request. Use resource_id with compartment_id to filter work requests related to a resource in the specified compartment.
resource_type
    Choices:
  • CLUSTER
  • NODEPOOL
Type of the resource associated with a work request. Use resource_type with compartment_id to filter work requests related to the resource type in the specified compartment.
tenancy
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
The OCID of the work request. work_request_id is required to get a specific work request's information.

aliases: id

Examples

- name: Get all the work requests in a specific compartment
  oci_oke_work_request_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get a specific work request
  oci_oke_work_request_facts:
    id: ocid1.clustersworkrequest.oc1..xxxxxEXAMPLExxxxx

- name: Get all the work requests in compartment associated with a particular cluster
  oci_oke_work_request_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    cluster_id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx

- name: Get all work requests in a compartment for a specified cluster in which resource of type NODEPOOL is associated
  oci_oke_work_request_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    cluster_id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
    resource_type: NODEPOOL

Return Values

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

Key Returned Description
work_requests
complex
 always
List of work request details

Sample:
[{'status': 'ACCEPTED', 'time_finished': '2018-07-26T18:44:13+00:00', 'time_started': '2018-07-26T18:43:26+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'operation_type': 'CLUSTER_CREATE', 'time_accepted': '2018-07-26T18:42:26+00:00', 'id': 'ocid1.clustersworkrequest.oc1..xxxxxEXAMPLExxxxx', 'resources': [{'entity_uri': '/clusters/ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'identifier': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'action_type': 'IN_PROGRESS', 'entity_type': 'cluster'}]}]
  status
string
 always
The current status of the work request.
  time_finished
datetime
 always
The time the work request was finished.
  time_started
datetime
 always
The time the work request was started.
  compartment_id
string
 always
The OCID of the compartment in which the work request exists.
  operation_type
string
 always
The type of work the work request is doing.
  time_accepted
datetime
 always
The time the work request was accepted.
  id
string
 always
The OCID of the work request.
  resources
list
 always
The resources this work request affects.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rohit Chaware (@rohitChaware)

Hint

If you notice any issues in this documentation you can edit this document to improve it.