Try SpotterFetches details about one or multiple StandardTagNamespaceTemplate 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 StandardTagNamespaceTemplate resources in Oracle Cloud Infrastructure
Lists available standard tag namespaces that users can create.
If I(standard_tag_namespace_name) is specified, the details of a single StandardTagNamespaceTemplate will be returned.
- name: Get a specific standard_tag_namespace_template
oci_identity_standard_tag_namespace_template_facts:
# required
standard_tag_namespace_name: standard_tag_namespace_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List standard_tag_namespace_templates
oci_identity_standard_tag_namespace_template_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
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).
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
standard_tag_namespace_name:
description:
- The name of the standard tag namespace tempate that is requested
- Required to get a specific standard_tag_namespace_template.
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
standard_tag_namespace_templates:
contains:
description:
description:
- The default description of the tag namespace that users can use to create
the tag namespace
returned: on success
sample: description_example
type: str
standard_tag_namespace_name:
description:
- The reserved name of this standard tag namespace
returned: on success
sample: standard_tag_namespace_name_example
type: str
status:
description:
- The status of the standard tag namespace
returned: on success
sample: status_example
type: str
tag_definition_templates:
contains:
description:
description:
- The default description of the tag namespace that users can use to create
the tag definition
returned: on success
sample: description_example
type: str
enum_mutability:
description:
- The mutability of the possible values list for enum tags. This will default
to IMMUTABLE for string value tags
returned: on success
sample: IMMUTABLE
type: str
is_cost_tracking:
description:
- Is the tag a cost tracking tag. Default will be false as cost tracking
tags have been deprecated
returned: on success
sample: true
type: bool
possible_values:
description:
- List of possible values. An optional parameter that will be present if
the type of definition is enum.
returned: on success
sample: []
type: list
tag_definition_name:
description:
- The name of this standard tag definition
returned: on success
sample: tag_definition_name_example
type: str
type:
description:
- The type of tag definition. Enum or string.
returned: on success
sample: ENUM
type: str
description:
- The template of the tag definition. This object includes necessary details
to create the provided standard tag definition.
- Returned for get operation
returned: on success
type: complex
description:
- List of StandardTagNamespaceTemplate resources
returned: on success
sample:
- description: description_example
standard_tag_namespace_name: standard_tag_namespace_name_example
status: status_example
tag_definition_templates:
- description: description_example
enum_mutability: IMMUTABLE
is_cost_tracking: true
possible_values: []
tag_definition_name: tag_definition_name_example
type: ENUM
type: complex