oci_tag_namespace - Create, retire and reactivate tag namespaces in OCI¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

This module allows the user to create, retire and reactivate tag namespaces in OCI. A tag namespace is a container for tag keys. It consists of a name, and zero or more tag key definitions. Tag namespaces are not case sensitive, and must be unique across the tenancy.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user		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		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		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		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	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 containing the tag namespace (the compartment may also be the root compartment of the Tenancy). Required for creating a tag namespace with state=present.
config_file_location		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	Default: DEFAULT	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		Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
description		A description to be associated with the tag namespace during creation. This does not have to be unique, and can be changed later. Required when creating a tag namespace with state=present The length of the description must be between 1 and 400 characters.
force_create bool	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		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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by		The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
name		The name assigned to the tag namespace during creation. It must be unique across all tag namespaces in the tenancy and cannot be changed. All ascii characters are allowed except spaces and dots. Note that names are case insenstive, that means you can not have two different namespaces with same name but with different casing in one tenancy. Required when a tag namespace is created using state=present.
reactivate bool	Choices: no ← yes	Whether a retired tag namespace needs to be reactivated
region		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.
state	Choices: present ← absent	The state of the tag namespace that must be asserted to. When state=present, and the tag namespace doesn't exist, the tag namespace is created. When state=absent, the tag namespace is retired. To reactivate a retired tag namespace, use reactivate=yes.
tag_namespace_id		The OCID of the tag namespace. Required when the tag namespace must be retired or reactivated. aliases: id
tenancy		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: Create a new tag namespace
  oci_tag_namespace:
    compartment_id: "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx"
    name: "BillingTags"
    description: "This namespace contains tags that will be used in billing."

- name: Update the description of a tag namespace
  oci_tag_namespace:
    id: "ocid1.namespace.oc1..xxxxxEXAMPLExxxxx"
    description: "Tags used for billing"

- name: Retire a tag namespace
  oci_tag_namespace:
    id: "ocid1.namespace.oc1..xxxxxEXAMPLExxxxx"
    state: "absent"

- name: To reactivate a retired namespace
  oci_tag_namespace:
    id: "ocid1.namespace.oc1..xxxxxEXAMPLExxxxx"
    reactivate: "yes"

Return Values ¶

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

Key	Returned	Description
tag_namespace dict	On successful create or update of a tag namespace	Details of the tag namespace Sample: {'description': 'This namespace contains tags that will be used in billing.', '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', 'name': 'BillingTags'}

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Sivakumar Thyagarajan (@sivakumart)

Hint

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