oci_mount_target_facts – Fetches details of the OCI Mount Target instances¶
New in version 2.5.
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_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_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. |
|
availability_domain
-
|
Availability domain from which details of all OCI Mount Target instances must be fetched.
|
|
|
compartment_id
-
|
Identifier of the compartment from which details of all OCI Mount Target instances must be fetched
|
|
|
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. |
|
|
display_name
string
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
|
lifecycle_state
-
|
|
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
|
|
mount_target_id
-
|
Identifier of the Mount Target whose details needs to be fetched.
aliases: id |
|
|
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. |
|
|
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¶
# Fetch Mount Target
- name: List all Mount Target in a compartment and availability domain
oci_mount_target_facts:
compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
availability_domain: 'IwGV:US-EXAMPLE-AD-1'
# Fetch Mount Target, filtered by Display Name
- name: List all Mount Target in a compartment and availability domain, filtered by Display Name
oci_mount_target_facts:
compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
availability_domain: 'IwGV:US-EXAMPLE-AD-1'
display_name: 'ansible-mount-target'
# Fetch Mount Target, filtered by lifecycle state
- name: List all Mount Target in a compartment and availability domain, filtered by lifecycle state
oci_mount_target_facts:
compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
availability_domain: 'IwGV:US-EXAMPLE-AD-1'
lifecycle_state: 'CREATING'
# Fetch specific Mount Target
- name: List a specific Mount Target
oci_mount_target_facts:
mount_target_id: 'ocid1.mounttarget..xxxxxEXAMPLExxxxx'
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
mount_targets
complex
|
success |
Attributes of the fetchedd Mount Target.
Sample:
[{'freeform_tags': {'system_license': 'trial'}, 'lifecycle_details': '', 'lifecycle_state': 'ACTIVE', 'private_ip_ids': ['ocid1.privateip.oc1.iad.xxxxxEXAMPLExxxxx'], 'availability_domain': 'IwGV:US-EXAMPLE-AD-1', 'export_set_id': 'ocid1.exportset.oc1.iad.xxxxxEXAMPLExxxxx', 'subnet_id': 'ocid1.subnet.oc1.iad.xxxxxEXAMPLExxxxx', 'defined_tags': {'ansible_tag_namespace_integration_test_1': {'ansible_tag_1': 'initial'}}, 'display_name': 'ansible_mount_target', 'id': 'ocid1.mounttarget.oc1.iad.xxxxxEXAMPLExxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2018-10-16T09:42:33.673000+00:00'}]
|
|
|
availability_domain
string
|
always |
The availability domain the mount target is in.
Sample:
IwGV:US-EXAMPLE-AD-1
|
|
|
compartment_id
string
|
always |
The identifier of the compartment containing the Mount Target
Sample:
ocid1.compartment.oc1.xzvf..xxxxxEXAMPLExxxxx
|
|
|
defined_tags
dictionary
|
always |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
Sample:
{'Department': 'Finance'}
|
|
|
display_name
string
|
always |
The user-friendly name for the Mount Target.
Sample:
ansible-mount-target
|
|
|
export_set_id
string
|
always |
The identifier of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target.
Sample:
ocid1.exportset.oc1.xzvf..xxxxxEXAMPLExxxxx
|
|
|
freeform_tags
dictionary
|
always |
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
Sample:
{'Operations': {'CostCenter': '42'}}
|
|
|
id
string
|
always |
The identifier of the Mount Target
Sample:
ocid1.mounttarget.oc1.xzvf..xxxxxEXAMPLExxxxx
|
|
|
lifecycle_details
string
|
always |
Additional information about the current lifecycle state.
Sample:
details
|
|
|
lifecycle_state
string
|
always |
The current state of the Mount Target.
Sample:
AVAILABLE
|
|
|
private_ip_ids
list
|
always |
The OCIDs of the private IP addresses associated with this mount target.
Sample:
['ocid1.privateip.oc1.xzvf..xxxxxEXAMPLExxxxx']
|
|
|
subnet_id
string
|
always |
The OCID of the subnet the Mount Target is in.
Sample:
ocid1.subnet.oc1.xzvf..xxxxxEXAMPLExxxxx
|
|
|
time_created
datetime
|
always |
Date and time when the Mount Target was created, in the format defined by RFC3339
Sample:
2018-10-16 09:42:33.673000+00:00
|
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Debayan Gupta(@debayan_gupta)
Hint
If you notice any issues in this documentation you can edit this document to improve it.