oracle.oci.oci_tenant_manager_control_plane_link_facts – Fetches details about one or multiple Link resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

• Fetches details about one or multiple Link resources in Oracle Cloud Infrastructure

• Return a (paginated) list of links.

• If link_id is specified, the details of a single Link will be returned.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.6

• 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_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 security_token	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.
child_tenancy_id string		The ID of the child tenancy this link is associated with.
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.
lifecycle_state string	Choices: CREATING ACTIVE INACTIVE UPDATING FAILED TERMINATED	The lifecycle state of the resource.
link_id string		OCID of the link to retrieve. Required to get a specific link. aliases: id
parent_tenancy_id string		The ID of the parent tenancy this link is associated with.
realm_specific_endpoint_template_enabled boolean	Choices: no yes	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.
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.
sort_order string	Choices: ASC DESC	The sort order to use, whether 'asc' or 'desc'.
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: Get a specific link
  oci_tenant_manager_control_plane_link_facts:
    # required
    link_id: "ocid1.link.oc1..xxxxxxEXAMPLExxxxxx"

- name: List links
  oci_tenant_manager_control_plane_link_facts:

    # optional
    parent_tenancy_id: "ocid1.parenttenancy.oc1..xxxxxxEXAMPLExxxxxx"
    child_tenancy_id: "ocid1.childtenancy.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING
    sort_order: ASC

Return Values

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

Key		Returned	Description
links complex		on success	List of Link resources Sample: [{'child_tenancy_id': 'ocid1.childtenancy.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'parent_tenancy_id': 'ocid1.parenttenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_terminated': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
	child_tenancy_id string	on success	OCID of the child tenancy. Sample: ocid1.childtenancy.oc1..xxxxxxEXAMPLExxxxxx
	id string	on success	OCID of the link. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_state string	on success	Lifecycle state of the link. Sample: CREATING
	parent_tenancy_id string	on success	OCID of the parent tenancy. Sample: ocid1.parenttenancy.oc1..xxxxxxEXAMPLExxxxxx
	time_created string	on success	Date-time when this link was created. Sample: 2013-10-20T19:20:30+01:00
	time_terminated string	on success	Date-time when this link was terminated. Sample: 2013-10-20T19:20:30+01:00
	time_updated string	on success	Date-time when this link was last updated. Sample: 2013-10-20T19:20:30+01:00

Authors

• Oracle (@oracle)