Puppet Task: volume_group_modify
- Defined in:
-
tasks/volume_group_modify.json,
tasks/volume_group_modify.rb
Overview
Modify a volume group, snapshot set, or clone.
Supports noop? false
Parameters
- description (Optional[String[0,256]]) — New description for the volume group. The description should not have any unprintable characters.If an empty string is specified, the description will be cleared.
- force (Optional[Boolean]) — Normally a replication destination volume group 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 group needs to be cleaned up.With the force option, the user will be allowed to remove the protection policy from the replication destination volume group provided that the replication session has never been synchronized.This parameter defaults to false, if not specified.
- id (String) — Unique identifier of the volume group.
- is_replication_destination (Optional[Boolean]) — New value for is_replication_destination property. is_replication_destination property of all the volumes in the volume group will be modified to the specified value. Modification of is_replication will not be transactional in nature. If the command only succeeds in modifying the is_replication_destination property of a subset of volumes, is_replication_destination property for the volume group will be set to true.Modification of this property is idempotent.This parameter is only valid when modifying a primary or a clone volume group, only when the volume group is no longer the destination of a replication session, and may only be set to false.
- is_write_order_consistent (Optional[Boolean]) — A boolean flag to indicate whether snapshot sets of the volume group will be write-order consistent.This parameter is only valid when modifying a primary or a clone volume group.
- name (Optional[String[0,128]]) — New name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case of the name provided is reserved, uniqueness check is case-insensitive, so the same name in two different cases is not considered unique.
- protection_policy_id (Optional[String]) — Unique identifier of the protection policy to assign to a primary or clone volume group. If an empty string is specified, protection policy will be removed from the volume group.