oci_load_balancer_work_request_facts – Fetch details of all work_requests of a load balancer

New in version 2.5.

Synopsis

  • Fetch details of all work_requests of a load balancer.

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.
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.
load_balancer_id
-
Identifier of the Load Balancer to which the Work Requests belongs. Mutually exclusive with work_request_id.

aliases: id
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.
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
-
Identifier of the Work Request whose details needs to be fetched.

Examples

#Fetch details of all Work Request of a Load Balancer
- name: List all Work Requests
  oci_load_balancer_work_request_facts:
      load_balancer_id: 'ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx'

#Fetch details of a specific Work Request in a Load Balancer
- name: List a specific Work Request
  oci_load_balancer_work_request_facts:
      work_request_id: 'ocid1.loadbalancerworkrequest.oc1.iad.xxxxxEXAMPLExxxxx'

Return Values

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

Key Returned Description
work_requests
complex
success
Attributes of the Work Requests fetched.

  error_details
list
always
Error details of the work request

Sample:
[{'errorCode': 'BAD_INPUT', 'message': "Default Listener on port '80' refer to VIP 'private-vip' twice"}]
  id
string
always
Identifier of the Work Request

Sample:
ocid1.loadbalancerworkrequest.oc1.xxxxxEXAMPLExxxxx
  lifecycle_state
string
always
The current state of the Load Balancer

Sample:
ACCEPTED
  load_balancer_id
string
always
The OCID of the load balancer the Work Request is associated with.

Sample:
ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx
  message
string
always
A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. Possible data elements include - workflow name - event ID - work request ID - load balancer ID - workflow completion message

Sample:
{'eventId': '43644f81-8724-1324', 'workRequestId': 'ocid1.loadbalancerworkrequest.oc1.iad.xxxxxEXAMPLExxxxx', 'workflowName': 'AddHostnameWorkflow', 'loadBalancerId': 'ocid1.loadbalancer..aaaa', 'message': 'OK', 'type': 'SUCCESS'}
  time_accepted
datetime
always
The date and time the work request was created, in the format defined by RFC3339.

Sample:
2018-06-26 21:10:29.600000
  time_finished
datetime
always
The date and time the work request was completed, in the format defined by RFC3339.

Sample:
2018-06-26T21:112:29.600Z
  type
string
always
The type of action the work request represents.

Sample:
[{'lifecycle_state': 'SUCCEEDED', 'time_finished': '2018-06-22T09:02:54.687000+00:00', 'time_accepted': '2018-06-22T09:02:38.505000+00:00', 'error_details': [], 'load_balancer_id': 'ocid1.loadbalancer..aaaa', 'message': {'eventId': '43644f81-8724-44b0-a13', 'workRequestId': 'ocid1.loadbalancerworkrequest.oc1.iad.xxxxxEXAMPLExxxxx', 'workflowName': 'AddHostnameWorkflow', 'loadBalancerId': 'ocid1.loadbalancer..aaaa', 'message': 'OK', 'type': 'SUCCESS'}, 'type': 'CreateHostname', 'id': 'ocid1.loadbalancerworkrequest.oc1.iad.xxxxxEXAMPLExxxxx'}, {'lifecycle_state': 'SUCCEEDED', 'time_finished': '2018-06-22T09:02:54.687000+00:00', 'time_accepted': '2018-06-22T09:02:38.505000+00:00', 'error_details': [], 'load_balancer_id': 'ocid1.loadbalancer..aaaa', 'message': {'eventId': '43644f81-8724-44b0-a14', 'workRequestId': 'ocid1.loadbalancerworkrequest.oc1.iad.xxxxxEXAMPLExxxxx', 'workflowName': 'AddHostnameWorkflow', 'loadBalancerId': 'ocid1.loadbalancer..aaaa', 'message': 'OK', 'type': 'SUCCESS'}, 'type': 'CreateHostname', 'id': 'ocid1.loadbalancerworkrequest.oc1.iad.xxxxxEXAMPLExxxxx'}]


Status

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

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

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