oci_export_set_facts – Fetches details of the OCI Export Set instances¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details of the OCI Export Set instances.

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	Choices: api_key ← instance_principal instance_obo_user	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 Export Set instances must be fetched.
compartment_id -		Identifier of the compartment from which details of all OCI Export Set 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.
export_set_id -		Identifier of the Export Set whose details needs to be fetched. aliases: id
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

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Fetch Export Set
- name: List all Export Set in a compartment and availability domain
  oci_export_set_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      availability_domain: 'IwGV:US-EXAMPLE-AD-1'

# Fetch Export Set, filtered by Display Name
- name: List all Export Set in a compartment and availability domain, filtered by Display Name
  oci_export_set_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      availability_domain: 'IwGV:US-EXAMPLE-AD-1'
      display_name: 'ansible-export-set'

# Fetch Export Set, filtered by lifecycle state
- name: List all Export Set in a compartment and availability domain, filtered by lifecycle state
  oci_export_set_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      availability_domain: 'IwGV:US-EXAMPLE-AD-1'
      lifecycle_state: 'CREATING'

# Fetch specific Export Set
- name: List a specific Export Set
  oci_export_set_facts:
      export_set_id: 'ocid1.exportset..xxxxxEXAMPLExxxxx'

Return Values ¶

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

Key		Returned	Description
export_sets complex		success	Attributes of the fetchedd Export Set. Sample: [{'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.exportset.oc1.iad.xxxxxEXAMPLExxxxx', 'display_name': 'ansible_export_set', 'availability_domain': 'IwGV:US-EXAMPLE-AD-1', 'lifecycle_state': 'ACTIVE', 'vcn_id': 'ocid1.vcn.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-10-19T18:12:54.027000+00:00'}]
	availability_domain string	always	The availability domain the Export Set is in. Sample: IwGV:US-EXAMPLE-AD-1
	compartment_id string	always	The identifier of the compartment containing the Export Set Sample: ocid1.compartment.oc1.xzvf..xxxxxEXAMPLExxxxx
	display_name string	always	The user-friendly name for the Export Set. Sample: ansible-file-system
	id string	always	The identifier of the Export Set Sample: ocid1.exportset.oc1.xzvf..xxxxxEXAMPLExxxxx
	lifecycle_state string	always	The current state of the Export Set. Sample: ACTIVE
	max_fs_stat_bytes integer	when listed by export_set_id	Controls the maximum tbytes, fbytes, and abytes values reported by NFS FSSTAT calls through any associated mount targets. This is an advanced feature. For most applications, use the default value. The tbytes value reported by FSSTAT will be max_fs_stat_bytes. The value of fbytes and abytes will be max_fs_stat_bytes minus the metered size of the file system. If the metered size is larger than max_fs_stat_bytes, then fbytes and abytes will both be '0'. Sample: 9223372036854775807
	max_fs_stat_files integer	when listed by export_set_id	Controls the maximum tfiles, ffiles, and afiles values reported by NFS FSSTAT calls through any associated mount targets. This is an advanced feature. For most applications, use the default value. The tfiles value reported by FSSTAT will be max_fs_stat_files. The value of ffiles and afiles will be max_fs_stat_files minus the metered size of the file system. If the metered size is larger than max_fs_stat_files, then ffiles and afiles will both be '0'. Sample: 9223372036854775807
	time_created datetime	always	Date and time when the Export Set was created, in the format defined by RFC3339 Sample: 2018-10-19 18:12:54.027000+00:00
	vcn_id string	always	The identifier of the virtual cloud network (VCN) the export set is in. Sample: ocid1.vcn.oc1.xzvf..xxxxxEXAMPLExxxxx

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.

oci_export_set_facts – Fetches details of the OCI Export Set instances¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶