Try SpotterFetches details about one or multiple TagDefault resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple TagDefault resources in Oracle Cloud Infrastructure
Lists the tag defaults for tag definitions in the specified compartment.
If I(tag_default_id) is specified, the details of a single TagDefault will be returned.
- name: Get a specific tag_default
oci_identity_tag_default_facts:
# required
tag_default_id: "ocid1.tagdefault.oc1..xxxxxxEXAMPLExxxxxx"
- name: List tag_defaults
oci_identity_tag_default_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
tag_definition_id: "ocid1.tagdefinition.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: ACTIVE
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
- security_token
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
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
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
compartment_id:
description:
- The OCID of the compartment (remember that the tenancy is simply the root compartment).
type: str
tag_default_id:
aliases:
- id
description:
- The OCID of the tag default.
- Required to get a specific tag_default.
type: str
lifecycle_state:
choices:
- ACTIVE
description:
- A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
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
tag_definition_id:
description:
- The OCID of the tag definition.
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
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
tag_defaults:
contains:
compartment_id:
description:
- The OCID of the compartment. The tag default applies to all new resources
that get created in the compartment. Resources that existed before the tag
default was created are not tagged.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
id:
description:
- The OCID of the tag default.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The tag default's current state. After creating a `TagDefault`, make sure
its `lifecycleState` is ACTIVE before using it.
returned: on success
sample: ACTIVE
type: str
locks:
contains:
is_active:
description:
- Indicates if the lock is active or not. For example, if there are mutliple
FULL locks, the first-created FULL lock will be effective.
returned: on success
sample: true
type: bool
message:
description:
- A message added by the creator of the lock. This is typically used to
give an indication of why the resource is locked.
returned: on success
sample: message_example
type: str
related_resource_id:
description:
- The ID of the resource that is locking this resource. Indicates that deleting
this resource will remove the lock.
returned: on success
sample: ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- When the lock was created.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
type:
description:
- Type of the lock.
returned: on success
sample: FULL
type: str
description:
- Locks associated with this resource.
- Returned for list operation
returned: on success
type: complex
tag_definition_id:
description:
- The OCID of the tag definition. The tag default will always assign a default
value for this tag definition.
returned: on success
sample: ocid1.tagdefinition.oc1..xxxxxxEXAMPLExxxxxx
type: str
tag_definition_name:
description:
- The name used in the tag definition. This field is informational in the context
of the tag default.
returned: on success
sample: tag_definition_name_example
type: str
tag_namespace_id:
description:
- The OCID of the tag namespace that contains the tag definition.
returned: on success
sample: ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- Date and time the `TagDefault` object 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
value:
description:
- The default value for the tag definition. This will be applied to all resources
created in the compartment.
returned: on success
sample: value_example
type: str
description:
- List of TagDefault resources
returned: on success
sample:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_state: ACTIVE
locks:
- is_active: true
message: message_example
related_resource_id: ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
type: FULL
tag_definition_id: ocid1.tagdefinition.oc1..xxxxxxEXAMPLExxxxxx
tag_definition_name: tag_definition_name_example
tag_namespace_id: ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
value: value_example
type: complex