oci_export_facts – Fetches details of the OCI Export instances

New in version 2.5.

Synopsis

  • Fetches details of the OCI Export instances.

Requirements

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

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
    Choices:
  • api_key ←
  • instance_principal
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
-
Identifier of the compartment from which details of all OCI Export 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.
export_id
-
Identifier of the Export whose details needs to be fetched.

aliases: id
export_set_id
-
Identifier of the export set from which details of all OCI Export instances must be fetched
file_system_id
-
Identifier of the file system from which details of all OCI Export instances must be fetched
lifecycle_state
-
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
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.
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

Examples

# Fetch Export by Compartment Identifier
- name: List all Export in a compartment
  oci_export_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'

# Fetch Export by File System Identifier
- name: List all Export of a File System
  oci_export_facts:
      file_system_id: 'ocid1.filesystem..xxxxxEXAMPLExxxxx'

# Fetch Export by Export Set Identifier
- name: List all Export of an Export Set
  oci_export_facts:
      export_set_id: 'ocid1.exportset..xxxxxEXAMPLExxxxx'

# Fetch Export, filtered by lifecycle state
- name: List all Mount Target in a compartment, filtered by lifecycle state
  oci_export_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      lifecycle_state: 'CREATING'

# Fetch specific Export
- name: List a specific Export
  oci_export_facts:
      export_id: 'ocid1.export..xxxxxEXAMPLExxxxx'

Return Values

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

Key Returned Description
exports
complex
success
Attributes of the fetched Export.

Sample:
[{'file_system_id': 'ocid1.filesystem.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'ACTIVE', 'export_set_id': 'ocid1.exportset.oc1.iad.xxxxxEXAMPLExxxxx', 'path': '/ansibletestpath', 'export_options': [{'access': 'READ_WRITE', 'source': '10.0.0.10', 'require_privileged_source_port': False, 'identity_squash': 'NONE', 'anonymous_gid': 65534, 'anonymous_uid': 65534}, {'access': 'READ_ONLY', 'source': '10.0.2.0/24', 'require_privileged_source_port': True, 'identity_squash': 'ROOT', 'anonymous_gid': 65534, 'anonymous_uid': 65534}], 'id': 'ocid1.export.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-10-18T11:40:52.483000+00:00'}]
  export_options
list
always
Policies that apply to NFS requests made through this export.

Sample:
[{'access': 'READ_WRITE', 'source': '0.0.0.0/0', 'require_privileged_source_port': False, 'identity_squash': 'NONE', 'anonymous_gid': 65534, 'anonymous_uid': 65534}]
  export_set_id
string
always
Identifier of the export set of this Export.

Sample:
ocid1.exportset.oc1.xzvf..xxxxxEXAMPLExxxxx
  file_system_id
string
always
Identifier of the file system of this Export.

Sample:
ocid1.filesystem.oc1.xzvf..xxxxxEXAMPLExxxxx
  id
string
always
The identifier of the Export

Sample:
ocid1.export.oc1.xzvf..xxxxxEXAMPLExxxxx
  lifecycle_state
string
always
The current state of the Export

Sample:
ACTIVE
  path
string
always
Path used to access the associated file system.

Sample:
/ansibletestpath
  time_created
datetime
always
Date and time when the Export was created, in the format defined by RFC3339

Sample:
2018-10-18 11:40:52.483000


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.