oracle.oci.oci_operator_access_control_operator_control – Manage an OperatorControl resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_control.

New in version 2.9.0: of oracle.oci

Synopsis

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).
approver_groups_list
list / elements=string
List of user groups who can approve an access request associated with a resource governed by this operator control.
Required for create using state=present, update using state=present with operator_control_id present.
approvers_list
list / elements=string
List of users who can approve an access request associated with a resource governed by this operator control.
This parameter is updatable.
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 OCID of the compartment that contains this operator control.
Required for create using state=present.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace.
This parameter is updatable.
description
string
Description of the operator control.
This parameter is updatable.
email_id_list
list / elements=string
List of emailId.
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
This parameter is updatable.
is_fully_pre_approved
boolean
    Choices:
  • no
  • yes
Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
Required for create using state=present, update using state=present with operator_control_id present.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
operator_control_id
string
unique OperatorControl identifier
Required for update using state=present.
Required for delete using state=absent.

aliases: id
operator_control_name
string
Name of the operator control.
Required for create using state=present, update using state=present with operator_control_id present.
pre_approved_op_action_list
list / elements=string
List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be auto-approved if the access request only contain operator actions in the pre-approved list.
This parameter is updatable.
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
    Choices:
  • EXACC
  • EXADATAINFRASTRUCTURE
  • AUTONOMOUSVMCLUSTER
  • CLOUDAUTONOMOUSVMCLUSTER
resourceType for which the OperatorControl is applicable
Required for create using state=present.
state
string
    Choices:
  • present ←
  • absent
The state of the OperatorControl.
Use state=present to create or update an OperatorControl.
Use state=absent to delete an OperatorControl.
system_message
string
This is the message that will be displayed to the operator users while accessing the system.
This parameter is updatable.
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
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create operator_control
  oci_operator_access_control_operator_control:
    # required
    resource_type: EXACC
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    operator_control_name: operator_control_name_example
    approver_groups_list: [ "approver_groups_list_example" ]
    is_fully_pre_approved: true

    # optional
    approvers_list: [ "approvers_list_example" ]
    pre_approved_op_action_list: [ "pre_approved_op_action_list_example" ]
    email_id_list: [ "email_id_list_example" ]
    system_message: system_message_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    description: description_example

- name: Update operator_control
  oci_operator_access_control_operator_control:
    # required
    operator_control_name: operator_control_name_example
    approver_groups_list: [ "approver_groups_list_example" ]
    is_fully_pre_approved: true
    operator_control_id: "ocid1.operatorcontrol.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    approvers_list: [ "approvers_list_example" ]
    pre_approved_op_action_list: [ "pre_approved_op_action_list_example" ]
    email_id_list: [ "email_id_list_example" ]
    system_message: system_message_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    description: description_example

- name: Delete operator_control
  oci_operator_access_control_operator_control:
    # required
    operator_control_id: "ocid1.operatorcontrol.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

    # optional
    description: description_example

Return Values

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

Key Returned Description
operator_control
complex
on success
Details of the OperatorControl resource acted upon by the current operation

Sample:
{'approval_required_op_action_list': [], 'approver_groups_list': [], 'approvers_list': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'email_id_list': [], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_fully_pre_approved': True, 'last_modified_info': 'last_modified_info_example', 'lifecycle_state': 'CREATED', 'operator_control_name': 'operator_control_name_example', 'pre_approved_op_action_list': [], 'resource_type': 'EXACC', 'system_message': 'system_message_example', 'time_of_creation': '2013-10-20T19:20:30+01:00', 'time_of_deletion': '2013-10-20T19:20:30+01:00', 'time_of_modification': '2013-10-20T19:20:30+01:00'}
 
approval_required_op_action_list
list / elements=string
on success
List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.

 
approver_groups_list
list / elements=string
on success
List of user groups who can approve an access request associated with a target resource under the governance of this operator control.

 
approvers_list
list / elements=string
on success
List of users who can approve an access request associated with a target resource under the governance of this operator control.

 
compartment_id
string
on success
The OCID of the compartment that contains the operator control.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Description of operator control.

Sample:
description_example
 
email_id_list
list / elements=string
on success
List of emailId.

 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the operator control.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_fully_pre_approved
boolean
on success
Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.

Sample:
True
 
last_modified_info
string
on success
Description associated with the latest modification of the operator control.

Sample:
last_modified_info_example
 
lifecycle_state
string
on success
The current lifecycle state of the operator control.

Sample:
CREATED
 
operator_control_name
string
on success
Name of the operator control. The name must be unique.

Sample:
operator_control_name_example
 
pre_approved_op_action_list
list / elements=string
on success
List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.

 
resource_type
string
on success
resourceType for which the OperatorControl is applicable

Sample:
EXACC
 
system_message
string
on success
System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.

Sample:
system_message_example
 
time_of_creation
string
on success
Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

Sample:
2013-10-20T19:20:30+01:00
 
time_of_deletion
string
on success
Time when deleted expressed in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_modification
string
on success
Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)