dellemc.powerflex.thin_clone module – Create Thin Clones on Dell PowerFlex 5.x (Gen2)

Note

This module is part of the dellemc.powerflex collection (version 3.0.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 dellemc.powerflex. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.powerflex.thin_clone.

New in dellemc.powerflex 3.1.0

Synopsis

  • Creates a thin clone from a source volume (including an existing thin clone, which is itself a volume) or from a read-only snapshot on a PowerFlex 5.x Gen2 storage system.

  • This module is CREATION-ONLY. Ongoing management of the resulting thin clone (rename, resize, map/unmap, delete) is the responsibility of the dellemc.powerflex.volume module, following the PowerFlex Gen2 architecture pattern: System creates, Volume manages.

  • Supported on PowerFlex 5.0 and above only.

Requirements

The below requirements are needed on the host that executes this module.

  • A Dell PowerFlex storage system version 5.0 or later.

  • PyPowerFlex 2.0.0

Parameters

Parameter

Comments

from_snapshot_id

string

ID of the source (read-only) snapshot.

Mutually exclusive with from_snapshot_name, from_volume_name, and from_volume_id.

from_snapshot_name

string

Name of the source (read-only) snapshot.

Mutually exclusive with from_snapshot_id, from_volume_name, and from_volume_id.

from_volume_id

string

ID of the source volume (or source thin clone).

Mutually exclusive with from_volume_name, from_snapshot_name, and from_snapshot_id.

from_volume_name

string

Name of the source volume (or source thin clone).

Mutually exclusive with from_volume_id, from_snapshot_name, and from_snapshot_id.

hostname

aliases: gateway_host

string / required

IP or FQDN of the PowerFlex host.

new_clone_name

string / required

Name of the new thin clone volume to create.

Required. Must be non-empty.

password

string / required

The password of the PowerFlex host.

port

integer

Port number through which communication happens with PowerFlex host.

Default: 443

state

string

Desired state. This module supports present only.

Delete, rename, resize, and mapping are handled by dellemc.powerflex.volume_v2.

Choices:

  • "present" ← (default)

timeout

integer

Time after which connection will get terminated.

It is to be mentioned in seconds.

Default: 120

username

string / required

The username of the PowerFlex host.

validate_certs

aliases: verifycert

boolean

Boolean variable to specify whether or not to validate SSL certificate.

true - Indicates that the SSL certificate should be verified.

false - Indicates that the SSL certificate should not be verified.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Runs task to validate without performing action.

diff_mode

Support: full

Reports changes made or to be made.

Notes

Note

  • Requires PowerFlex 5.0 or later.

  • Architecture: System creates, Volume manages. Use dellemc.powerflex.volume_v2 for rename, resize, map/unmap, delete, and other ongoing operations on the returned thin clone.

  • The modules present in the collection named as ‘dellemc.powerflex’ are built to support the Dell PowerFlex storage platform.

Examples

- name: Create thin clone from a source volume
  dellemc.powerflex.thin_clone:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    from_volume_name: "src_vol"
    new_clone_name: "clone_a"
    state: present

Return Values

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

Key

Description

changed

boolean

Whether a new thin clone was created.

Returned: always

source_details

dictionary

Resolved source used for the create operation.

Returned: always

volume_details

dictionary

Details of the thin clone volume.

Returned: always

Authors

  • Dell Technologies Ansible Team (@dell-ansible)