oracle.oci.oci_file_storage_file_system_facts – Fetches details about one or multiple FileSystem resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the file system resources in the specified compartment.

  • If file_system_id is specified, the details of a single FileSystem will be returned.

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_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
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
string
The name of the availability domain.
Example: `Uocm:PHX-AD-1`
Required to list multiple file_systems.
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.
compartment_id
string
The OCID of the compartment.
Required to list multiple file_systems.
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
A user-friendly name. It does not have to be unique, and it is changeable.
Example: `My resource`

aliases: name
file_system_id
string
The OCID of the file system.
Required to get a specific file_system.

aliases: id
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
Filter results by the specified lifecycle state. Must be a valid state for the resource type.
parent_file_system_id
string
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.
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_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc', where 'asc' is ascending and 'desc' is descending. The default order is 'desc' except for numeric values.
source_snapshot_id
string
The OCID of the snapshot used to create a cloned file system. See Cloning a File System.
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

- name: Get a specific file_system
  oci_file_storage_file_system_facts:
    # required
    file_system_id: "ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx"

- name: List file_systems
  oci_file_storage_file_system_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    availability_domain: Uocm:PHX-AD-1

    # optional
    display_name: display_name_example
    lifecycle_state: CREATING
    source_snapshot_id: "ocid1.sourcesnapshot.oc1..xxxxxxEXAMPLExxxxxx"
    parent_file_system_id: "ocid1.parentfilesystem.oc1..xxxxxxEXAMPLExxxxxx"
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

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

Key Returned Description
file_systems
complex
on success
List of FileSystem resources

Sample:
[{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_clone_parent': True, 'is_hydrated': True, 'is_targetable': True, 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'metered_bytes': 56, 'replication_target_id': 'ocid1.replicationtarget.oc1..xxxxxxEXAMPLExxxxxx', 'source_details': {'parent_file_system_id': 'ocid1.parentfilesystem.oc1..xxxxxxEXAMPLExxxxxx', 'source_snapshot_id': 'ocid1.sourcesnapshot.oc1..xxxxxxEXAMPLExxxxxx'}, 'time_created': '2013-10-20T19:20:30+01:00'}]
 
availability_domain
string
on success
The availability domain the file system is in. May be unset as a blank or NULL value.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment that contains the file system.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: `My file system`

Sample:
display_name_example
 
freeform_tags
dictionary
on success
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 Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the file system.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_clone_parent
boolean
on success
Specifies whether the file system has been cloned. See Cloning a File System.

Sample:
True
 
is_hydrated
boolean
on success
Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See Cloning a File System.

Sample:
True
 
is_targetable
boolean
on success
Specifies whether the file system can be used as a target file system for replication. For more information, see Using Replication.
Returned for get operation

Sample:
True
 
kms_key_id
string
on success
The OCID of the KMS key which is the master encryption key for the file system.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Additional information about the current 'lifecycleState'.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the file system.

Sample:
CREATING
 
metered_bytes
integer
on success
The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see File System Usage and Metering.

Sample:
56
 
replication_target_id
string
on success
The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
Returned for get operation

Sample:
ocid1.replicationtarget.oc1..xxxxxxEXAMPLExxxxxx
 
source_details
complex
on success

   
parent_file_system_id
string
on success
The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.

Sample:
ocid1.parentfilesystem.oc1..xxxxxxEXAMPLExxxxxx
   
source_snapshot_id
string
on success
The OCID of the source snapshot used to create a cloned file system. See Cloning a File System.

Sample:
ocid1.sourcesnapshot.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the file system was created, expressed in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)