dellemc / dellemc.powerstore / 1.3.0 / module / dellemc_powerstore_filesystem_snapshot Manage Filesystem Snapshots on Dell EMC PowerStore | "added in version" 1.1.0 of dellemc.powerstore" Authors: Akash Shendge (@shenda1) <ansible.team@dell.com> preview | supported by communitydellemc.powerstore.dellemc_powerstore_filesystem_snapshot (1.3.0) — module
Install with ansible-galaxy collection install dellemc.powerstore:==1.3.0
collections: - name: dellemc.powerstore version: 1.3.0
Managing filesystem snapshots on PowerStore Storage System includes creating new filesystem snapshot, getting details of filesystem snapshot, modifying attributes of filesystem snapshot and deleting filesystem snapshot.
- name: Create filesystem snapshot dellemc_powerstore_filesystem_snapshot: array_ip: "{{array_ip}}" verifycert: "{{verifycert}}" user: "{{user}}" password: "{{password}}" snapshot_name: "sample_filesystem_snapshot" nas_server: "ansible_nas_server" filesystem: "sample_filesystem" desired_retention: 20 retention_unit: "days" state: "present"
- name: Get the details of filesystem snapshot dellemc_powerstore_filesystem_snapshot: array_ip: "{{array_ip}}" verifycert: "{{verifycert}}" user: "{{user}}" password: "{{password}}" snapshot_id: "{{fs_snapshot_id}}" state: "present"
- name: Modify the filesystem snapshot dellemc_powerstore_filesystem_snapshot: array_ip: "{{array_ip}}" verifycert: "{{verifycert}}" user: "{{user}}" password: "{{password}}" snapshot_name: "sample_filesystem_snapshot" nas_server: "ansible_nas_server" description: "modify description" expiration_timestamp: "" state: "present"
- name: Delete filesystem snapshot dellemc_powerstore_filesystem_snapshot: array_ip: "{{array_ip}}" verifycert: "{{verifycert}}" user: "{{user}}" password: "{{password}}" snapshot_id: "{{fs_snapshot_id}}" state: "absent"
user: description: - The username of the PowerStore host. required: true type: str state: choices: - absent - present description: - Define whether the filesystem snapshot should exist or not. required: true type: str array_ip: description: - IP or FQDN of the PowerStore management system. required: true type: str password: description: - The password of the PowerStore host. required: true type: str filesystem: description: - The ID/Name of the filesystem for which snapshot will be taken. - If filesystem name is specified, then nas_server is required to uniquely identify the filesystem. - Mandatory for create operation. type: str nas_server: description: - The NAS server, this could be the name or ID of the NAS server. type: str verifycert: choices: - true - false description: - Boolean variable to specify whether to validate SSL certificate or not. - True - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - False - indicates that the SSL certificate should not be verified. required: true type: bool access_type: choices: - SNAPSHOT - PROTOCOL description: - Specifies whether the snapshot directory or protocol access is granted to the filesystem snapshot. - For create operation, if access_type is not specified, snapshot will be created with 'SNAPSHOT' access type. type: str description: description: - The description for the filesystem snapshot. type: str snapshot_id: description: - The ID of the Snapshot. type: str snapshot_name: description: - The name of the filesystem snapshot. - Mandatory for create operation. - Specify either snapshot name or ID (but not both) for any operation. type: str retention_unit: choices: - hours - days default: hours description: - The unit for retention. type: str desired_retention: description: - The retention value for the Snapshot. - If the desired_retention/expiration_timestamp is not mentioned during creation, snapshot will be created with unlimited retention. - Maximum supported desired retention is 31 days. type: int expiration_timestamp: description: - The expiration timestamp of the snapshot. This should be provided in UTC format, e.g 2020-07-24T10:54:54Z. - To remove the expiration timestamp, specify it as an empty string. type: str
changed: description: Whether or not the resource has changed returned: always type: bool create_fs_snap: description: Whether or not the resource has created returned: always type: bool delete_fs_snap: description: Whether or not the resource has deleted returned: always type: bool filesystem_snap_details: contains: access_type: description: Displays the type of access allowed to the snapshot. type: str creation_timestamp: description: The date and time the snapshot was created. type: str description: description: Description of the filesystem snapshot. type: str expiration_timestamp: description: The date and time the snapshot is due to be automatically deleted by the system. type: str id: description: Unique identifier of the filesystem snapshot instance. type: str name: description: The name of the snapshot. type: str nas_server: contains: id: description: ID of the NAS server. type: str name: description: Name of the NAS server type: str description: Details of NAS server on which snapshot is present. type: dict parent_id: description: ID of the filesystem on which snapshot is taken. type: str parent_name: description: Name of the filesystem on which snapshot is taken. type: str description: Details of the snapshot. returned: When snapshot exists. type: dict modify_fs_snap: description: Whether or not the resource has modified returned: always type: bool