oci_waas_work_request_facts – Retrieve details about WAAS policy work requests

New in version 2.5.

Synopsis

  • This module retrieves information of a specific work request or lists all the work requests in the given WAAS policy and compartment.

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_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
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
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.
compartment_id
string
The OCID of the 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.
sort_by
string
    Choices:
  • id
  • status
  • timeAccepted
  • timeStarted
  • timeFinished
  • operationType
The value by which work requests are sorted in a paginated 'List' call. If unspecified, defaults to timeAccepted.
sort_order
string
    Choices:
  • ASC
  • DESC
The order in which to sort the results.
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
waas_policy_id
string
The OCID of the WAAS policy.
work_request_id
string
The OCID of the work request. Required to retrieve a specific work request.

Examples

- name: Get all the work requests for a waas policy in a compartment
  oci_waas_work_request_facts:
    waas_policy_id: ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get all the work requests for a waas policy in a compartment sorted by timeFinished
  oci_waas_work_request_facts:
    waas_policy_id: ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    sort_by: timeFinished

- name: Get a specific waas work request using its OCID
  oci_waas_work_request_facts:
    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_requests
complex
 on success
List of work requests

Sample:
[{'status': 'IN_PROGRESS', 'time_finished': None, 'errors': [], 'logs': [{'timestamp': '2019-04-10T18:46:05.663000+00:00', 'message': 'addWhitelistOp: start'}, {'timestamp': '2019-04-10T18:46:05.663000+00:00', 'message': 'addWhitelistOp: finished (45% of request completed)'}, {'timestamp': '2019-04-10T18:46:05.403000+00:00', 'message': 'updateProtectionSettingsOp: start'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'operation_type': 'CREATE_WAAS_POLICY', 'percent_complete': 45, 'time_accepted': '2019-04-10T18:45:45.044000+00:00', 'id': 'ocid1.waasworkrequest.oc1..xxxxxEXAMPLExxxxx', 'resources': [{'entity_uri': '/20181116/waasPolicies/ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx', 'identifier': 'ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx', 'action_type': 'CREATED', 'entity_type': 'waas'}], 'time_started': '2019-04-10T18:45:49+00:00'}]
  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.

Sample:
[{'timestamp': '2019-04-10T19:31:57.364000+00:00', 'message': 'Work request complete'}, {'timestamp': '2019-04-10T19:31:57.360000+00:00', 'message': 'PersistWaasOp: start (100% of request completed)'}, {'timestamp': '2019-04-10T19:31:57.261000+00:00', 'message': 'Starting Work Request'}]
  operation_type
string
 success
A description of the operation requested by the work request.

Sample:
CREATE_WAAS_POLICY
  percent_complete
integer
 success
The percentage of work completed by the work request.

Sample:
50
  resources
string
 success
The resources being used to complete the work request operation.

Sample:
[{'entity_uri': '/20181116/waasPolicies/ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx', 'identifier': 'ocid1.waaspolicy.oc1..xxxxxEXAMPLExxxxx', 'action_type': 'CREATED', 'entity_type': 'waas'}]
  status
string
 success
The current status of the work request.

Sample:
IN_PROGRESS
  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
  time_finished
string
 success
The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.

Sample:
2019-03-22 13:02:59.563000
  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.

Sample:
2019-03-22 13:02:56.563000


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.