oci_tag_namespace_facts – Retrieve details of tag namespaces for a specified compartment or tenancy in OCI

New in version 2.5.

Synopsis

  • This module retrieves details of tag namespaces of a specified tenancy or compartment in OCI.

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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_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.
compartment_id
-
The OCID of the compartment whose tag namespaces must be retrieved. To get the tag namespaces of the tenancy, provide the tenancy's root compartment OCID as the compartment_id
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
    Choices:
  • no
  • yes
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.
name
string
Use name along with the other options to return only resources that match the given name exactly.
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
-
The OCID of a tag namespace for which details must be retrieved. Required when facts about a specific tag namespace needs to be obtained.

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

Examples

- name: Get details of all the tag namespaces of the specified user
  oci_tag_namespace_facts:
    compartment_id: "ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx"

- name: Get details of a specific tag namespace
  oci_tag_namespace_facts:
    id: "ocid1.namespace.oc1..xxxxxEXAMPLExxxxx"

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
Information about one or more tag namespaces in the specified user

Sample:
{'tag_namespaces': [{'name': 'BillingTags', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'defined_tags': {}, 'freeform_tags': {}, 'time_created': '2018-01-15T17:36:10.388000+00:00', 'is_retired': False, 'id': 'ocid1.tagnamespace.oc1..xxxxxEXAMPLExxxxx', 'description': 'This namespace contains tags that will be used in billing.'}]}
  compartment_id
string
always
The OCID of the compartment that contains the tag namespace.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  description
string
always
The description that was assigned to the tag namespace.

Sample:
This namespace contains tags that will be used in billing.
  id
string
always
The OCID of the tag namespace.

Sample:
ocid1.tagnamespace.oc1..xxxxxEXAMPLExxxxx
  is_retired
string
always
Whether the tag namespace is retired.

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

Sample:
BillingTags
  time_created
string
always
Date and time the tag namespace object was created, in the format defined by RFC3339.

Sample:
2016-08-25 21:10:29.600000


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.