oracle.oci.oci_governance_rules_control_plane_enforced_governance_rule_facts – Fetches details about one or multiple EnforcedGovernanceRule 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_governance_rules_control_plane_enforced_governance_rule_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • List enforced governance rules. Either compartment id or enforced governance rule id must be supplied. An optional governance rule type or a display name can also be supplied.

  • If enforced_governance_rule_id is specified, the details of a single EnforcedGovernanceRule 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.
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.
display_name
string
A filter to return only resources that match the entire name given.

aliases: name
enforced_governance_rule_id
string
Unique enforced governance rule identifier.
Required to get a specific enforced_governance_rule.

aliases: id
governance_rule_type
string
    Choices:
  • QUOTA
  • TAG
  • ALLOWED_REGIONS
A filter to return only resources that match the type given.
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:
  • 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.
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 enforced_governance_rule
  oci_governance_rules_control_plane_enforced_governance_rule_facts:
    # required
    enforced_governance_rule_id: "ocid1.enforcedgovernancerule.oc1..xxxxxxEXAMPLExxxxxx"

- name: List enforced_governance_rules
  oci_governance_rules_control_plane_enforced_governance_rule_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    enforced_governance_rule_id: "ocid1.enforcedgovernancerule.oc1..xxxxxxEXAMPLExxxxxx"
    governance_rule_type: QUOTA
    display_name: display_name_example
    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
enforced_governance_rules
complex
on success
List of EnforcedGovernanceRule resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'governance_rule_display_name': 'governance_rule_display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'template': {'description': 'description_example', 'display_name': 'display_name_example', 'name': 'name_example', 'regions': [], 'statements': [], 'tag_defaults': [{'is_required': True, 'tag_name': 'tag_name_example', 'value': 'value_example'}], 'tags': [{'description': 'description_example', 'is_cost_tracking': True, 'name': 'name_example', 'validator': {'validator_type': 'ENUM', 'values': []}}], 'type': 'QUOTA'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'QUOTA'}]
 
compartment_id
string
on success
The Oracle ID (OCID) of the child's root compartment to which the governance rule is attached.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
governance_rule_display_name
string
on success
Display name of the governance rule.

Sample:
governance_rule_display_name_example
 
id
string
on success
The Oracle ID (OCID) of the enforced governance rule.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the governance rule.

Sample:
ACTIVE
 
template
complex
on success
Returned for get operation

   
description
string
on success
Description of the allowed region resource.

Sample:
description_example
   
display_name
string
on success
Display name of the allowed region resource.

Sample:
display_name_example
   
name
string
on success
The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.

Sample:
name_example
   
regions
list / elements=string
on success
List of allowed regions.

   
statements
list / elements=string
on success
List of quota statements.

   
tag_defaults
complex
on success

     
is_required
boolean
on success
If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag default). If no value is set, resource creation is blocked.
* If the `isRequired` flag is set to "true", the value is set during resource creation. * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.
Example: `false`

Sample:
True
     
tag_name
string
on success
The name of the tag. The tag default will always assign a default value for this tag name.

Sample:
tag_name_example
     
value
string
on success
The default value for the tag name. This will be applied to all new resources created in the compartment.

Sample:
value_example
   
tags
complex
on success
Represents an array of tags for tag namespace.

     
description
string
on success
The description assigned to the tag during creation.

Sample:
description_example
     
is_cost_tracking
boolean
on success
Indicates whether the tag is enabled for cost tracking.

Sample:
True
     
name
string
on success
The name you assign to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed.

Sample:
name_example
     
validator
complex
on success

       
validator_type
string
on success
Specifies the type of validation: a static value (no validation) or a list.

Sample:
ENUM
       
values
list / elements=string
on success
The list of allowed values for a definedTag value.

   
type
string
on success
Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
Example: `QUOTA`

Sample:
QUOTA
 
time_created
string
on success
Date and time the governance rule was created. An RFC3339 formatted datetime string.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Date and time the governance rule was updated. An RFC3339 formatted datetime string.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
Example: `QUOTA`

Sample:
QUOTA


Authors

  • Oracle (@oracle)