oracle.oci.oci_identity_tag – Manage a Tag resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Tag resource in Oracle Cloud Infrastructure

  • For state=present, creates a new tag in the specified tag namespace.

  • The tag requires either the OCID or the name of the tag namespace that will contain this tag definition.

  • You must specify a name for the tag, which must be unique across all tags in the tag namespace and cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters. Names are case insensitive. That means, for example, “myTag” and “mytag” are not allowed in the same namespace. If you specify a name that’s already in use in the tag namespace, a 409 error is returned.

  • The tag must have a description. It does not have to be unique, and you can change it with UpdateTag.

  • The tag must have a value type, which is specified with a validator. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. Lists are validiated.

    • If no validator is set, the user applying the tag to a resource can type in a static value or leave the tag value empty. * If a validator is set, the user applying the tag to a resource must select from a list of values that you supply with EnumTagDefinitionValidator.

  • This resource has the following action operations in the oracle.oci.oci_identity_tag_actions module: bulk_delete, bulk_edit, import_standard_tags.

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_purpose
string
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_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.
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.
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 Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
description
string
The description you assign to the tag during creation.
Required for create using state=present.
This parameter is updatable.
force_create
boolean
    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
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 Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
is_cost_tracking
boolean
    Choices:
  • no
  • yes
Indicates whether the tag is enabled for cost tracking.
This parameter is updatable.
is_lock_override
boolean
    Choices:
  • no
  • yes
Whether to override locks (if any exist).
This parameter is updatable.
is_retired
boolean
    Choices:
  • no
  • yes
This parameter is updatable.
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.
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.
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
string
    Choices:
  • present ←
  • absent
The state of the Tag.
Use state=present to create or update a Tag.
Use state=absent to delete a Tag.
tag_namespace_id
string / required
The OCID of the tag namespace.
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
validator
dictionary
This parameter is updatable.
validator_type
string / required
    Choices:
  • DEFAULT
  • ENUM
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'
wait
boolean
    Choices:
  • no
  • yes ←
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.

Examples

- name: Create tag
  oci_identity_tag:
    # required
    description: description_example
    tag_namespace_id: "ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_cost_tracking: true
    validator:
      # required
      validator_type: DEFAULT
    is_lock_override: true

- name: Update tag
  oci_identity_tag:
    # required
    tag_namespace_id: "ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    description: description_example
    is_retired: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    is_cost_tracking: true
    validator:
      # required
      validator_type: DEFAULT
    is_lock_override: true

- name: Delete tag
  oci_identity_tag:
    # required
    tag_namespace_id: "ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

    # optional
    is_lock_override: true

Return Values

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

Key Returned Description
tag
complex
on success
Details of the Tag resource acted upon by the current operation

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_cost_tracking': True, 'is_retired': True, 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'tag_namespace_id': 'ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx', 'tag_namespace_name': 'tag_namespace_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'validator': {'validator_type': 'ENUM', 'values': []}}
 
compartment_id
string
on success
The OCID of the compartment that contains the tag definition.

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.

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 definition.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_cost_tracking
boolean
on success
Indicates whether the tag is enabled for cost tracking.

Sample:
True
 
is_retired
boolean
on success
Indicates whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.

Sample:
True
 
lifecycle_state
string
on success
The tag's current state. After creating a tag, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's `lifecycleState` changes from DELETING to DELETED.

Sample:
ACTIVE
 
name
string
on success
The name assigned 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
 
tag_namespace_id
string
on success
The OCID of the namespace that contains the tag definition.

Sample:
ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx
 
tag_namespace_name
string
on success
The name of the tag namespace that contains the tag definition.

Sample:
tag_namespace_name_example
 
time_created
string
on success
Date and time the tag was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
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.



Authors

  • Oracle (@oracle)