oci_identity_tag_default_facts – Fetches details about one or multiple TagDefault resources in Oracle Cloud Infrastructure¶
New in version 2.5.
Synopsis¶
- Fetches details about one or multiple TagDefault resources in Oracle Cloud Infrastructure
- Lists the Tag Defaults for Tag Definitions in the specified Compartment.
- If tag_default_id is specified, the details of a single TagDefault will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.7
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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_OCID 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
|
|
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. |
compartment_id
-
|
The OCID of the compartment (remember that the tenancy is simply the root compartment).
|
|
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 . |
|
id
-
|
A filter to only return resources that match the specified OCID exactly.
|
|
lifecycle_state
-
|
|
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
|
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. |
|
tag_default_id
-
|
The OCID of the Tag Default.
Required to get a specific tag_default.
aliases: id |
|
tag_definition_id
-
|
The OCID of the Tag 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 |
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List tag_defaults
oci_identity_tag_default_facts:
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
- name: Get a specific tag_default
oci_identity_tag_default_facts:
tag_default_id: ocid1.tagdefault.oc1..xxxxxxEXAMPLExxxxxx
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
tag_defaults
complex
|
on success |
List of TagDefault resources
Sample:
[{'lifecycle_state': 'ACTIVE', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'tag_definition_id': 'ocid1.tagdefinition.oc1..xxxxxxEXAMPLExxxxxx', 'value': 'value_example', 'tag_namespace_id': 'ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx', 'tag_definition_name': 'tag_definition_name_example', 'time_created': '2016-08-25T21:10:29.600Z', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]
|
|
compartment_id
string
|
on success |
The OCID of the Compartment. The Tag Default will apply to any resource contained in this Compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
id
string
|
on success |
The OCID of the Tag Default.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The tag default's current state. After creating a tagdefault, make sure its `lifecycleState` is ACTIVE before using it.
Sample:
ACTIVE
|
|
tag_definition_id
string
|
on success |
The OCID of the Tag Definition. The Tag Default will always assign a default value for this Tag Definition.
Sample:
ocid1.tagdefinition.oc1..xxxxxxEXAMPLExxxxxx
|
|
tag_definition_name
string
|
on success |
The name used in the Tag Definition. This field is informational in the context of the Tag Default.
Sample:
tag_definition_name_example
|
|
tag_namespace_id
string
|
on success |
The OCID of the Tag Namespace that contains the Tag Definition.
Sample:
ocid1.tagnamespace.oc1..xxxxxxEXAMPLExxxxxx
|
|
time_created
string
|
on success |
Date and time the `TagDefault` object was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2016-08-25 21:10:29.600000
|
|
value
string
|
on success |
The default value for the Tag Definition. This will be applied to all resources created in the Compartment.
Sample:
value_example
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Manoj Meda (@manojmeda)
- Mike Ross (@mross22)
- Nabeel Al-Saber (@nalsaber)
Hint
If you notice any issues in this documentation you can edit this document to improve it.