oracle.oci.oci_operator_access_control_operator_action_facts – Fetches details about one or multiple OperatorAction 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_operator_access_control_operator_action_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all the OperatorActions available in the system.

  • If operator_action_id is specified, the details of a single OperatorAction 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 ID of the compartment in which to list resources.
Required to list multiple operator_actions.
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.
lifecycle_state
string
    Choices:
  • ACTIVE
  • INACTIVE
A filter to return only resources whose lifecycleState matches the given OperatorAction lifecycleState.
name
string
A filter to return only resources that match the entire display name given.
operator_action_id
string
Unique Oracle supplied identifier associated with the operator action.
Required to get a specific operator_action.

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.
resource_type
string
A filter to return only lists of resources that match the entire given service type.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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

Examples

- name: Get a specific operator_action
  oci_operator_access_control_operator_action_facts:
    # required
    operator_action_id: "ocid1.operatoraction.oc1..xxxxxxEXAMPLExxxxxx"

- name: List operator_actions
  oci_operator_access_control_operator_action_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    resource_type: resource_type_example
    lifecycle_state: ACTIVE
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
operator_actions
complex
on success
List of OperatorAction resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'component': 'component_example', 'customer_display_name': 'customer_display_name_example', 'description': 'description_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'properties': [{'name': 'name_example', 'value': 'value_example'}], 'resource_type': 'EXACC'}]
 
compartment_id
string
on success
compartmentId for which the OperatorAction is applicable
Returned for list operation

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
component
string
on success
Name of the infrastructure layer associated with the operator action.

Sample:
component_example
 
customer_display_name
string
on success
Display Name of the operator action.
Returned for get operation

Sample:
customer_display_name_example
 
description
string
on success
Description of the operator action in terms of associated risk profile, and characteristics of the operating system commands made available to the operator under this operator action.

Sample:
description_example
 
id
string
on success
Unique Oracle assigned identifier for the operator action.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current lifecycle state of the operator action.
Returned for list operation

Sample:
ACTIVE
 
name
string
on success
Unique name of the operator action.

Sample:
name_example
 
properties
complex
on success
Fine grained properties associated with the operator control.
Returned for get operation

   
name
string
on success
Name of the property

Sample:
name_example
   
value
string
on success
value of the property

Sample:
value_example
 
resource_type
string
on success
resourceType for which the OperatorAction is applicable

Sample:
EXACC


Authors

  • Oracle (@oracle)