oracle.oci.oci_identity_tag_namespace_facts – Fetches details about one or multiple TagNamespace resources 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_identity_tag_namespace_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple TagNamespace resources in Oracle Cloud Infrastructure
Lists the tag namespaces in the specified compartment.
If tag_namespace_id is specified, the details of a single TagNamespace will be returned.
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 OCID of the compartment (remember that the tenancy is simply the root compartment).
Required to list multiple tag_namespaces.
|
|
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 . |
|
include_subcompartments
boolean
|
|
An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
|
lifecycle_state
string
|
|
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
|
name
string
|
Use name along with the other options to return only resources that match the given name exactly.
|
|
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. |
|
tag_namespace_id
string
|
The OCID of the tag namespace.
Required to get a specific tag_namespace.
aliases: id |
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific tag_namespace
oci_identity_tag_namespace_facts:
# required
tag_namespace_id: "ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx"
- name: List tag_namespaces
oci_identity_tag_namespace_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
include_subcompartments: true
lifecycle_state: ACTIVE
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
tag_namespaces
complex
|
on success |
List of TagNamespace resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_retired': True, 'lifecycle_state': 'ACTIVE', 'locks': [{'is_active': True, 'message': 'message_example', 'related_resource_id': 'ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'type': 'FULL'}], 'name': 'name_example', 'time_created': '2013-10-20T19:20:30+01:00'}]
|
||
compartment_id
string
|
on success |
The OCID of the compartment that contains the tag namespace.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
description
string
|
on success |
The description you assign to the tag namespace.
Sample:
description_example
|
||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The OCID of the tag namespace.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_retired
boolean
|
on success |
Whether the tag namespace is retired. See Retiring Key Definitions and Namespace Definitions.
Sample:
True
|
||
lifecycle_state
string
|
on success |
The tagnamespace's current state. After creating a tagnamespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tagnamespace, make sure its `lifecycleState` is INACTIVE before using it.
Sample:
ACTIVE
|
||
locks
complex
|
on success |
Locks associated with this resource.
|
||
is_active
boolean
|
on success |
Indicates if the lock is active or not. For example, if there are mutliple FULL locks, the first-created FULL lock will be effective.
Sample:
True
|
||
message
string
|
on success |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
Sample:
message_example
|
||
related_resource_id
string
|
on success |
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
Sample:
ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
When the lock was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
type
string
|
on success |
Type of the lock.
Sample:
FULL
|
||
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
|
||
time_created
string
|
on success |
Date and time the tagNamespace was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)