oracle / oracle.oci / 3.5.0 / module / oci_identity_tag Manage a Tag resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_tag (3.5.0) — module
Install with ansible-galaxy collection install oracle.oci:==3.5.0
collections: - name: oracle.oci version: 3.5.0
This module allows the user to create, update and delete a Tag resource in Oracle Cloud Infrastructure
For I(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 L(UpdateTag,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/latest/Tag/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 L(EnumTagDefinitionValidator,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/identity/latest/datatypes/EnumTagDefinitionValidator).
This resource has the following action operations in the M(oracle.oci.oci_identity_tag_actions) module: bulk_delete, bulk_edit, import_standard_tags.
- 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
name: description: - 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. required: true type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the Tag. - Use I(state=present) to create or update a Tag. - Use I(state=absent) to delete a Tag. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str validator: description: - '' - This parameter is updatable. suboptions: validator_type: choices: - DEFAULT - ENUM description: - 'Specifies the type of validation: a static value (no validation) or a list.' required: true type: str values: description: - The list of allowed values for a definedTag value. - Applicable when validator_type is 'ENUM' elements: str type: list type: dict is_retired: description: - Whether the tag is retired. See L(Retiring Key Definitions and Namespace Definitions,https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). - This parameter is updatable. type: bool cert_bundle: description: - 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. type: str description: description: - The description you assign to the tag during creation. - Required for create using I(state=present). - This parameter is updatable. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict is_cost_tracking: description: - Indicates whether the tag is enabled for cost tracking. - This parameter is updatable. type: bool is_lock_override: description: - Whether to override locks (if any exist). - This parameter is updatable. type: bool tag_namespace_id: description: - The OCID of the tag namespace. required: true type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str
tag: contains: compartment_id: description: - The OCID of the compartment that contains the tag definition. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict description: description: - The description you assign to the tag. returned: on success sample: description_example type: str freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The OCID of the tag definition. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_cost_tracking: description: - Indicates whether the tag is enabled for cost tracking. returned: on success sample: true type: bool is_retired: description: - Indicates whether the tag is retired. See L(Retiring Key Definitions and Namespace Definitions,https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). returned: on success sample: true type: bool lifecycle_state: description: - 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. returned: on success sample: ACTIVE type: str name: description: - 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. returned: on success sample: name_example type: str tag_namespace_id: description: - The OCID of the namespace that contains the tag definition. returned: on success sample: ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx type: str tag_namespace_name: description: - The name of the tag namespace that contains the tag definition. returned: on success sample: tag_namespace_name_example type: str time_created: description: - Date and time the tag was created, in the format defined by RFC3339. - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str validator: contains: validator_type: description: - 'Specifies the type of validation: a static value (no validation) or a list.' returned: on success sample: ENUM type: str values: description: - The list of allowed values for a definedTag value. returned: on success sample: [] type: list description: - '' returned: on success type: complex description: - Details of the Tag resource acted upon by the current operation returned: on success 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: [] type: complex