oci_export_set – Update a Export Set in OCI Filesystem Service

New in version 2.5.

Synopsis

  • Update an OCI Export Set, if present, with a new display name
  • Update an OCI Export Set, if present, with new max_fs_stat_bytes
  • Update an OCI Export Set, if present, with new max_fs_stat_files

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.
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
-
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
export_set_id
-
Identifier of the existing Export Set which required to be updated.

aliases: id
max_fs_stat_bytes
-
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'.
max_fs_stat_files
-
Controls the maximum ffiles, 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'.
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
-
    Choices:
  • present ←
Update Export Set. For state=present, 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
    Choices:
  • no
  • yes ←
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.

Examples

# Note: These examples do not set authentication details.

# Update Export Set's display name
- name: Update Export Set's display name
  oci_export_set:
    export_set_id: 'ocid1.exportset.oc1..xxxxxEXAMPLExxxxx'
    display_name: 'updated_ansible_export_set'
    state: 'present'

# Update Export Set's max_fs_stat_bytes
- name: Update Export Set's max_fs_stat_bytes
  oci_export_set:
    export_set_id: 'ocid1.exportset.oc1..xxxxxEXAMPLExxxxx'
    max_fs_stat_bytes: 9223372036854775806
    state: 'present'

# Update Export Set's max_fs_stat_files
- name: Update Export Set's max_fs_stat_files
  oci_export_set:
    export_set_id: 'ocid1.exportset.oc1..xxxxxEXAMPLExxxxx'
    max_fs_stat_files: 9223372036854775806
    state: 'present'

Return Values

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

Key Returned Description
export_set
complex
success
Attributes of the updated Export Set.

Sample:
{'max_fs_stat_files': 9223372036854775807, 'lifecycle_state': 'ACTIVE', 'availability_domain': 'IwGV:US-EXAMPLE-AD-1', 'display_name': 'ansible_export_set', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-10-19T18:17:03.907000+00:00', 'max_fs_stat_bytes': 9223372036854775807, 'id': 'ocid1.exportset.oc1.iad.xxxxxEXAMPLExxxxx'}
  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
always
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
always
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:17:03.907000
  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.