oci_file_system – Create, update and delete a File System in OCI Filesystem Service

New in version 2.5.

Synopsis

  • Create an OCI File System
  • Update an OCI File System, if present, with a new display name
  • Delete an OCI File System, if present.

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.
availability_domain
-
The availability domain in which to create the File System. Mandatory for create operation.
compartment_id
-
Identifier of the compartment under which this File System would be created. Mandatory for create operation.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
display_name
-
A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.
file_system_id
-
Identifier of the existing File System which required to be updated, deleted. Mandatory for update and delete.

aliases: id
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.
freeform_tags
dictionary
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
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.
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 ←
  • absent
Create, update and delete File System. 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
    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.
# Create File System
- name: Create File System
  oci_file_system:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    availability_domain: 'IwGV:US-EXAMPLE-AD-1'
    display_name: 'ansible_file_system'
    freeform_tags:
        deployment: 'production'
    defined_tags:
        target_users:
            division: 'documentation'
    state: 'present'

# Update File System's display name
- name: Update File System's display name
  oci_file_system:
    file_system_id: 'ocid1.filesystem.oc1..xxxxxEXAMPLExxxxx'
    display_name: 'updated_ansible_file_system'
    state: 'present'

# Update File System's Freeform Tags
- name: Update File System's Freeform Tags
  oci_file_system:
    file_system_id: 'ocid1.filesystem.oc1..xxxxxEXAMPLExxxxx'
    freeform_tags:
        deployment: 'trial'
    state: 'present'

# Update File System's Defined Tags
- name: Update File System's Defined Tags
  oci_file_system:
    file_system_id: 'ocid1.filesystem.oc1..xxxxxEXAMPLExxxxx'
    defined_tags:
        target_users:
            division: 'development'
    state: 'present'

# Delete File System
- name: Delete File System
  oci_file_system:
    id: 'ocid1.filesystem.oc1..xxxxxEXAMPLExxxxx'
    state: 'absent'

Return Values

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

Key Returned Description
file_system
complex
success
Attributes of the created/updated File System. For delete, deleted File System description will be returned.

Sample:
{'lifecycle_state': 'ACTIVE', 'availability_domain': 'IwGV:US-EXAMPLE-AD-1', 'display_name': 'ansible_file_system', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'defined_tags': {'ansible_tag_namespace_integration_test_1': {'ansible_tag_1': 'initial'}}, 'freeform_tags': {'system_license': 'trial'}, 'time_created': '2018-10-16T09:43:00.051000+00:00', 'metered_bytes': 100, 'id': 'ocid1.filesystem.oc1.iad.xxxxxEXAMPLExxxxx'}
  availability_domain
string
always
The availability domain the File System is in.

Sample:
IwGV:US-EXAMPLE-AD-1
  compartment_id
string
always
The identifier of the compartment containing the File System

Sample:
ocid1.compartment.oc1.xzvf..xxxxxEXAMPLExxxxx
  defined_tags
dictionary
always
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.

Sample:
{'Department': 'Finance'}
  display_name
string
always
The user-friendly name for the File System.

Sample:
ansible-file-system
  freeform_tags
dictionary
always
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.

Sample:
{'Operations': {'CostCenter': '42'}}
  id
string
always
The identifier of the File System

Sample:
ocid1.filesystem.oc1.xzvf..xxxxxEXAMPLExxxxx
  lifecycle_state
string
always
The current state of the File System.

Sample:
ACTIVE
  metered_bytes
integer
always
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.

Sample:
582
  time_created
datetime
always
Date and time when the File System was created, in the format defined by RFC3339

Sample:
2018-10-16 09:43:00.051000


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.