oracle.oci.oci_file_storage_export – Manage an Export resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an Export resource in Oracle Cloud Infrastructure

  • For state=present, creates a new export in the specified export set, path, and file system.

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.
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.
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
string
The OCID of the export.
Required for update using state=present.
Required for delete using state=absent.

aliases: id
export_options
list / elements=dictionary
Export options for the new export. If left unspecified, defaults to:
" [ { \"source\" : \"0.0.0.0/0\", \"requirePrivilegedSourcePort\" : false, \"access\" : \"READ_WRITE\", \"identitySquash\" : \"NONE\" } ]"
**Note:** Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated `ClientOptions` item has a source of `0.0.0.0/0`.
**If set to the empty array then the export will not be visible to any clients.**
The export's `exportOptions` can be changed after creation using the `UpdateExport` operation.
This parameter is updatable.
access
string
    Choices:
  • READ_WRITE
  • READ_ONLY
Type of access to grant clients using the file system through this export. If unspecified defaults to `READ_ONLY`.
anonymous_gid
integer
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to `65534`.
anonymous_uid
integer
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to `65534`.
identity_squash
string
    Choices:
  • NONE
  • ROOT
  • ALL
Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If `ALL`, all users and groups are remapped; if `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `ROOT`.
require_privileged_source_port
boolean
    Choices:
  • no
  • yes
If `true`, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to `true`.
source
string / required
Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.
**Note:** Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.
export_set_id
string
The OCID of this export's export set.
Required for create using state=present.
file_system_id
string
The OCID of this export's file system.
Required for create using state=present.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
path
string
Path used to access the associated file system.
Avoid entering confidential information.
Example: `/mediafiles`
Required for create using state=present.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the Export.
Use state=present to create or update an Export.
Use state=absent to delete an Export.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create export
  oci_file_storage_export:
    # required
    export_set_id: "ocid1.exportset.oc1..xxxxxxEXAMPLExxxxxx"
    file_system_id: "ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx"
    path: path_example

    # optional
    export_options:
    - # required
      source: source_example

      # optional
      require_privileged_source_port: true
      access: READ_WRITE
      identity_squash: NONE
      anonymous_uid: 56
      anonymous_gid: 56

- name: Update export
  oci_file_storage_export:
    # required
    export_id: "ocid1.export.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    export_options:
    - # required
      source: source_example

      # optional
      require_privileged_source_port: true
      access: READ_WRITE
      identity_squash: NONE
      anonymous_uid: 56
      anonymous_gid: 56

- name: Delete export
  oci_file_storage_export:
    # required
    export_id: "ocid1.export.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
export
complex
on success
Details of the Export resource acted upon by the current operation

Sample:
{'export_options': [{'access': 'READ_WRITE', 'anonymous_gid': 56, 'anonymous_uid': 56, 'identity_squash': 'NONE', 'require_privileged_source_port': True, 'source': 'source_example'}], 'export_set_id': 'ocid1.exportset.oc1..xxxxxxEXAMPLExxxxxx', 'file_system_id': 'ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'path': 'path_example', 'time_created': '2013-10-20T19:20:30+01:00'}
 
export_options
complex
on success
Policies that apply to NFS requests made through this export. `exportOptions` contains a sequential list of `ClientOptions`. Each `ClientOptions` item defines the export options that are applied to a specified set of clients.
For each NFS request, the first `ClientOptions` option in the list whose `source` attribute matches the source IP address of the request is applied.
If a client source IP address does not match the `source` property of any `ClientOptions` in the list, then the export will be invisible to that client. This export will not be returned by `MOUNTPROC_EXPORT` calls made by the client and any attempt to mount or access the file system through this export will result in an error.
**Exports without defined `ClientOptions` are invisible to all clients.**
If one export is invisible to a particular client, associated file systems may still be accessible through other exports on the same or different mount targets. To completely deny client access to a file system, be sure that the client source IP address is not included in any export for any mount target associated with the file system.

   
access
string
on success
Type of access to grant clients using the file system through this export. If unspecified defaults to `READ_ONLY`.

Sample:
READ_WRITE
   
anonymous_gid
integer
on success
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to `65534`.

Sample:
56
   
anonymous_uid
integer
on success
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to `65534`.

Sample:
56
   
identity_squash
string
on success
Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If `ALL`, all users and groups are remapped; if `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `ROOT`.

Sample:
NONE
   
require_privileged_source_port
boolean
on success
If `true`, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to `true`.

Sample:
True
   
source
string
on success
Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.
**Note:** Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

Sample:
source_example
 
export_set_id
string
on success
The OCID of this export's export set.

Sample:
ocid1.exportset.oc1..xxxxxxEXAMPLExxxxxx
 
file_system_id
string
on success
The OCID of this export's file system.

Sample:
ocid1.filesystem.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The OCID of this export.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of this export.

Sample:
CREATING
 
path
string
on success
Path used to access the associated file system.
Avoid entering confidential information.
Example: `/accounting`

Sample:
path_example
 
time_created
string
on success
The date and time the export 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)