oci_tag – Create, retire and reactivate tag key definitions in OCI

New in version 2.5.

Synopsis

  • This module allows the user to create, retire and reactivate tag key definitions in OCI. A key definition defines the schema of a tag and includes a namespace, tag key, and tag value type. Currently the only tag value type supported is “string”, and hence is not specified during creation. Defined tag keys are case insensitive. However note that defined tag values are case sensitive.

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
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.
defined_tags
dictionary
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 definition during creation. This does not have to be unique, and can be changed later. Required when creating a tag definition with state=present The length of the description must be between 1 and 400 characters.
freeform_tags
dictionary
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.
is_cost_tracking
boolean
    Choices:
  • no
  • yes
Indicates whether the tag is enabled for cost tracking.
reactivate
boolean
    Choices:
  • no ←
  • yes
Whether a retired tag definition needs to be reactivated
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.
state
-
    Choices:
  • present ←
  • absent
The state of the tag key definition that must be asserted to. When state=present, and the tag definition doesn't exist, the tag definition is created. When state=absent, the tag namespace is retired. To reactivate a retired tag key definition, use reactivate=yes.
tag_name
- / required
The name assigned to the tag key definition during creation. It must be unique across all tags in the specified tag namespace 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 tags with same name but with different casing in one tag namespace.

aliases: name
tag_namespace_id
- / required
The OCID of the tag namespace that will contain this tag key definition.
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: Create a new tag key definition
  oci_tag:
    tag_namespace_id: "ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx"
    name: "CostCenter"
    description: "This tag will show the cost center that will be used for billing of resources."

- name: Update the description of a tag definition
  oci_tag:
    tag_namespace_id: "ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx"
    name: "CostCenter"
    description: "Tags used for cost center"

- name: Retire a tag key definition
  oci_tag:
    tag_namespace_id: "ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx"
    name: "CostCenter"
    state: "absent"

- name: Enable a tag key definition for cost-tracking
  oci_tag:
    tag_namespace_id: "ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx"
    name: "CostCenter"
    is_cost_tracking: "yes"

- name: Disable a tag key definition for cost-tracking
  oci_tag:
    tag_namespace_id: "ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx"
    name: "CostCenter"
    is_cost_tracking: "no"

- name: To reactivate a retired namespace
  oci_tag:
    tag_namespace_id: "ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx"
    name: "CostCenter"
    reactivate: "yes"

Return Values

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

Key Returned Description
tag
dictionary
 On successful create or update of a tag key definition
Details of the tag key definition

Sample:
{'freeform_tags': {}, 'id': 'ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx', 'name': 'CostCenter', 'description': 'This tag will show the cost center that will be used for billing of resources.', 'tag_namespace_id': 'ocid1.tagnamespace.oc1..xxxxxEXAMPLExxxxx', 'tag_namespace_name': None, 'is_retired': False, 'defined_tags': {}, 'is_cost_tracking': False, 'compartment_id': None, 'time_created': '2018-01-16T04:55:22.600000+00:00'}


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.