Resource Type: powerstore_volume

Defined in:
lib/puppet/type/powerstore_volume.rb

Overview

Manage volumes, including snapshots and clones of volumes.

Properties

  • appliance_id

    Identifier of the appliance on which the volume is provisioned.

  • creation_timestamp

    Time when the volume was created.

  • description

    Description of the volume. This value must contain 128 or fewer printable Unicode characters.

  • ensure (defaults to: present)

    Whether this resource should be present or absent on the target system.

  • expiration_timestamp

    New expiration time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires.Use a maximum timestamp value to set an expiration to never expire.

  • force

    Normally a replication destination volume cannot be modified since it is controlled by replication. However, there can be cases where replication has failed or is no longer active and the replication destination volume needs to be cleaned up.With the force option, the user will be allowed to remove the protection policy from the replication destination volume provided that the replication session has never been synchronized and the last_sync_timestamp property is empty.This parameter defaults to false, if not specified.

  • host_group_id

    Unique identifier of the host group to be attached to the volume. If not specified, an unmapped volume is created. Only one of host_id or host_group_id can be supplied.

  • host_id

    Unique identifier of the host to be attached to the volume. If not specified, an unmapped volume is created. Only one of host_id or host_group_id can be supplied.

  • id

    Unique identifier of the volume to delete.

  • is_replication_destination

    New value for is_replication_destination property. The modification is only supported for primary and clone volume, only when the current value is true and there is no longer a replication session using this volume as a destination, and only to false.

  • location_history

    Filtering on the fields of this embedded resource is not supported.

  • logical_unit_number

    Optional logical unit number when creating a attached volume. If no host_id or host_group_id is specified, this property is ignored.

  • migration_session_id

    Unique identifier of the migration session assigned to the volume if it is part of a migration activity.

  • min_size

    Optional minimum size for the volume, in bytes.

  • node_affinity

    This attribute shows which node will be advertised as the optimized IO path to the volume. It is initially set to System_Select_At_Attach and can be modified to other values. When a volume is first attached to a host, if node_affinity is System_Select_At_Attach then the system will make the assignment to either System_Selected_Node_A or System_Selected_Node_B. The node_affinity may be modified to one of System_Select_At_Attach or Preferred_Node_A or Preferred_Node_B. Both System_Selected_Node_A and System_Selected_Node_B are reserved for system use only and cannot be set as the volume’s node_affinity.Possible affinity for a volume. * System_Select_At_Attach - Volume currently has no node affinity, affinity will be assigned when the volume is first attached. * System_Selected_Node_A - System selected Node A as the optimized IO path to volume. * System_Selected_Node_B - System selected Node B as the optimized IO path to volume. * Preferred_Node_A - Node A will always advertise as the optimized IO path to volume. * Preferred_Node_B - Node B will always advertise as the optimized IO path to volume.

  • node_affinity_l10n

    Localized message string corresponding to node_affinity

  • performance_policy_id

    Unique identifier of the performance policy assigned to the volume.

  • protection_data

    Protection data associated with a resource. Filtering on the fields of this embedded resource is not supported.

  • protection_policy_id

    Unique identifier of the protection policy assigned to the volume.

  • sector_size

    Optional sector size, in bytes. Only 512-byte and 4096-byte sectors are supported.

  • size

    Size of the volume to be created, in bytes. Minimum volume size is 1MB. Maximum volume size is 256TB. Size must be a multiple of 8192.

  • state

    Volume life cycle states. * Ready - Volume is operating normally. * Initializing - Volume is starting but not yet ready for use. * Offline - Volume is not available. * Destroying - Volume is being deleted. No new operations are allowed.

  • state_l10n

    Localized message string corresponding to state

  • type

    Type of volume. * Primary - A base object. * Clone - A read-write object that shares storage with the object from which it is sourced. * Snapshot - A read-only object created from a volume or clone.

  • type_l10n

    Localized message string corresponding to type

  • volume_group_id

    Volume group to add the volume to. If not specified, the volume is not added to a volume group.

  • wwn

    World wide name of the volume.

Parameters

  • name (namevar)

    Unique name for the volume to be created. This value must contain 128 or fewer printable Unicode characters.