oracle.oci.oci_governance_rules_control_plane_governance_rule – Manage a GovernanceRule resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_governance_rule
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a GovernanceRule resource in Oracle Cloud Infrastructure
For state=present, create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.
This resource has the following action operations in the oracle.oci.oci_governance_rules_control_plane_governance_rule_actions module: retry.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 Oracle ID (OCID) of the root compartment containing the governance rule.
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 . |
||||
creation_option
string
|
|
The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.
Example: `TEMPLATE`
Required for create using state=present.
|
|||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||||
description
string
|
Description of the governance rule.
This parameter is updatable.
|
||||
display_name
string
|
Display name of the governance rule.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||||
force_create
boolean
|
|
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. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
||||
governance_rule_id
string
|
Unique governance rule identifier.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||||
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.
|
||||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|||
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. |
||||
related_resource_id
string
|
The Oracle ID (OCID) of the resource, which was used as a template to create this governance rule.
This parameter is updatable.
|
||||
state
string
|
|
The state of the GovernanceRule.
Use state=present to create or update a GovernanceRule.
Use state=absent to delete a GovernanceRule.
|
|||
template
dictionary
|
Required for create using state=present.
This parameter is updatable.
|
||||
description
string
|
Description of the tag namespace.
|
||||
display_name
string
|
Display name of the quota resource.
Required when type is one of ['QUOTA', 'ALLOWED_REGIONS']
|
||||
name
string
|
The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
Required when type is 'TAG'
|
||||
regions
list
/ elements=string
|
List of allowed regions.
Required when type is 'ALLOWED_REGIONS'
|
||||
statements
list
/ elements=string
|
List of quota statements.
Required when type is 'QUOTA'
|
||||
tag_defaults
list
/ elements=dictionary
|
Applicable when type is 'TAG'
|
||||
is_required
boolean
/ required
|
|
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`
Required when type is 'TAG'
|
|||
tag_name
string
/ required
|
The name of the tag. The tag default will always assign a default value for this tag name.
Required when type is 'TAG'
|
||||
value
string
/ required
|
The default value for the tag name. This will be applied to all new resources created in the compartment.
Required when type is 'TAG'
|
||||
tags
list
/ elements=dictionary
|
Represents an array of tags for tag namespace.
Applicable when type is 'TAG'
|
||||
description
string
|
The description assigned to the tag during creation.
Applicable when type is 'TAG'
|
||||
is_cost_tracking
boolean
|
|
Indicates whether the tag is enabled for cost tracking.
Applicable when type is 'TAG'
|
|||
name
string
/ required
|
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.
Required when type is 'TAG'
|
||||
validator
dictionary
|
Applicable when type is 'TAG'
|
||||
validator_type
string
/ required
|
|
Specifies the type of validation: a static value (no validation) or a list.
|
|||
values
list
/ elements=string
|
The list of allowed values for a definedTag value.
Applicable when validator_type is 'ENUM'
|
||||
type
string
/ required
|
|
Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
Example: `QUOTA`
|
|||
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 |
||||
type
string
|
|
Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
Example: `QUOTA`
Required for create using state=present.
|
|||
wait
boolean
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create governance_rule
oci_governance_rules_control_plane_governance_rule:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
type: QUOTA
creation_option: TEMPLATE
display_name: display_name_example
template:
# required
name: name_example
type: TAG
# optional
tags:
- # required
name: name_example
# optional
description: description_example
is_cost_tracking: true
validator:
# required
validator_type: DEFAULT
tag_defaults:
- # required
tag_name: tag_name_example
value: value_example
is_required: true
description: description_example
# optional
description: description_example
related_resource_id: "ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update governance_rule
oci_governance_rules_control_plane_governance_rule:
# required
governance_rule_id: "ocid1.governancerule.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
template:
# required
name: name_example
type: TAG
# optional
tags:
- # required
name: name_example
# optional
description: description_example
is_cost_tracking: true
validator:
# required
validator_type: DEFAULT
tag_defaults:
- # required
tag_name: tag_name_example
value: value_example
is_required: true
description: description_example
related_resource_id: "ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update governance_rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_governance_rules_control_plane_governance_rule:
# required
display_name: display_name_example
# optional
description: description_example
template:
# required
name: name_example
type: TAG
# optional
tags:
- # required
name: name_example
# optional
description: description_example
is_cost_tracking: true
validator:
# required
validator_type: DEFAULT
tag_defaults:
- # required
tag_name: tag_name_example
value: value_example
is_required: true
description: description_example
related_resource_id: "ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete governance_rule
oci_governance_rules_control_plane_governance_rule:
# required
governance_rule_id: "ocid1.governancerule.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete governance_rule using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_governance_rules_control_plane_governance_rule:
# required
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
governance_rule
complex
|
on success |
Details of the GovernanceRule resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'creation_option': 'TEMPLATE', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'related_resource_id': 'ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, '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 root compartment containing the governance rule.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
creation_option
string
|
on success |
The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.
Example: `TEMPLATE`
Sample:
TEMPLATE
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
description
string
|
on success |
Description of the governance rule.
Sample:
description_example
|
||||
display_name
string
|
on success |
Display name of the governance rule.
Sample:
display_name_example
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
id
string
|
on success |
The Oracle ID (OCID) of the governance rule.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
lifecycle_state
string
|
on success |
The current state of the governance rule.
Sample:
ACTIVE
|
||||
related_resource_id
string
|
on success |
The Oracle ID (OCID) of the resource, which was used as a template to create this governance rule.
Sample:
ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||||
template
complex
|
on success |
|
||||
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)