oci_export – Create, update and delete a Export in OCI Filesystem Service¶
New in version 2.5.
Synopsis¶
- Create an OCI Export
- Update an OCI Export, if present, with a new display name
- Delete an OCI Export, if present.
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_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
|
|
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. |
|
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 . |
||
delete_export_options
boolean
|
|
Delete any export options in the Export that is specified in export_options. If delete_export_options=yes, export options provided by export_options would be deleted from existing export options, if they are part of existing export options. If they are not part of existing export options, they will be ignored. delete_export_options and purge_export_options are mutually exclusive.
|
|
export_id
-
|
Identifier of the existing Export which required to be updated, deleted. Mandatory for update and delete.
aliases: id |
||
export_options
-
|
Export options for this Export.
|
||
access
-
|
Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY. Allowed values are READ_WRITE and READ-ONLY.
|
||
anonymous_gid
-
|
GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified, defaults to 65534.
|
||
anonymous_uid
-
|
UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
|
||
identity_squash
-
|
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. Allowed values are NONE, ROOT and ALL.
|
||
require_privileged_source_port
-
|
If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
|
||
source
-
/ required
|
Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.
|
||
export_set_id
-
|
Identifier of the export set of this Export. Mandatory for create operation.
|
||
file_system_id
-
|
Identifier of the file system of this Export. Mandatory for create operation.
|
||
force_create
boolean
|
|
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
|
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
|
||
path
-
|
Path used to access the associated file system. Avoid entering confidential information. Mandatory for create operation.
|
||
purge_export_options
boolean
|
|
Purge any export options in the Export that is not specified in export_options. If purge_export_options=no, provided export options would be appended to existing export options. purge_export_options and delete_export_options are mutually exclusive.
|
|
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
-
|
|
Create, update and delete Export. For state=present, if it does not exist, it gets created. If it exists, it gets updated.
|
|
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
|
|
Whether to wait for create or delete operation to complete.
|
|
wait_timeout
integer
|
Default: 1200
|
Time, in seconds, to wait when wait=yes.
|
|
wait_until
string
|
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
|
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
# Note: These examples do not set authentication details.
# Create Export
- name: Create Export
oci_export:
file_system_id: 'ocid1.filesystem.oc1..xxxxxEXAMPLExxxxx'
export_set_id: 'ocid1.exportset.oc1..xxxxxEXAMPLExxxxx'
export_options:
- source: '10.0.0.0/16'
require_privileged_source_port: False
access: 'READ_WRITE'
identity_squash: 'NONE'
path: '/ansibletestpath'
state: 'present'
# Update Export's Export Options
- name: Update Export's Export Options
oci_export:
export_id: 'ocid1.export.oc1..xxxxxEXAMPLExxxxx'
export_options:
- source: '10.0.0.0/16'
require_privileged_source_port: False
access: 'READ_ONLY'
identity_squash: 'ROOT'
state: 'present'
# Update Export's Export Options by appending a new Export Options
- name: Update Export's Export Options by appending a new Export Options
oci_export:
export_id: 'ocid1.export.oc1..xxxxxEXAMPLExxxxx'
export_options:
- source: '10.0.0.100'
require_privileged_source_port: False
access: 'READ_ONLY'
identity_squash: 'ALL'
purge_export_options: False
state: 'present'
# Update Export's Export Options by deleting an Export Options
- name: Update Export's Export Options by deleting an Export Options
oci_export:
export_id: 'ocid1.export.oc1..xxxxxEXAMPLExxxxx'
export_options:
- source: '10.0.0.100'
require_privileged_source_port: False
access: 'READ_ONLY'
identity_squash: 'ALL'
delete_export_options: True
state: 'present'
# Delete Export
- name: Delete Export
oci_export:
id: 'ocid1.export.oc1..xxxxxEXAMPLExxxxx'
state: 'absent'
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
export
complex
|
success |
Attributes of the created/updated Export. For delete, deleted Export description will be returned.
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.