oci_waas_work_request – Manage WAAS policy work requests in OCI¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module allows the user to cancel a WAAS policy work request in OCI.

Requirements ¶

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

python >= 2.7
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_type string	Choices: api_key ← instance_principal instance_obo_user	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.
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.
state -	Choices: cancelled ←	Cancel a WAAS work request with state=cancelled.
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
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer	Default: 2000	Time, in seconds, to wait when wait=yes.
wait_until string		The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
work_request_id string / required		The OCID of the work request. Required to retrieve a specific work request.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Cancel a waas work request
  oci_waas_work_request:
    work_request_id: "ocid1.waasworkrequest.oc1..xxxxxEXAMPLExxxxx"
    state: cancelled

- name: Cancel a waas work request without explicitly stating the state as it is default
  oci_waas_work_request:
    work_request_id: "ocid1.waasworkrequest.oc1..xxxxxEXAMPLExxxxx"

Return Values ¶

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

Key		Returned	Description
waas_work_request complex		on success	Information about the WAAS work request. Sample: {'time_finished': None, 'resources': [], 'status': 'CANCELLED', 'time_started': None, 'operation_type': 'UPDATE_WAAS_POLICY', 'errors': [], 'logs': [], 'time_accepted': '2019-03-22T13:02:55.563000+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'percent_complete': 0}
	compartment_id string	success	The OCID of the compartment that contains the work request. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	errors list	success	The list of errors that occurred while fulfilling the work request.
	id string	success	The OCID of the work request. Sample: ocid1.waasworkrequest.oc1..xxxxxEXAMPLExxxxx
	logs list	success	The list of log entries from the work request workflow.
	operation_type string	success	A description of the operation requested by the work request. Sample: UPDATE_WAAS_POLICY
	percent_complete integer	success	The percentage of work completed by the work request.
	resources string	success	The resources being used to complete the work request operation.
	status string	success	The current status of the work request. Sample: CANCELLED
	time_accepted string	success	The date and time the work request was created, in the format defined by RFC3339. Sample: 2019-03-22 13:02:55.563000+00:00
	time_finished string	success	The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.
	time_started string	success	The date and time the work request moved from the ACCEPTED state to the IN_PROGRESS state, expressed in RFC 3339 timestamp format.

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Manoj Meda (@manojmeda)

Hint

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

oci_waas_work_request – Manage WAAS policy work requests in OCI¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶