Formatting a volume

Use the vol_format command to formats a volume.

vol_format vol=VolName

Parameters

Name Type Description Mandatory
vol Object name Name of the volume to be formatted. Y

A formatted volume returns zeros as a response to any read command.

All data stored on the volume is lost and cannot be restored.

The formatting of the volume is done logically and no data is actually written to the physical storage space allocated for the volume. This allows the command to complete instantly.

The volume's lock state must be unlocked when the command is issued.

This command fails if the volume has snapshots associated with it, or if the volume is a snapshot, or if the volume is part of any mirroring or data migration definition.

Example: 

vol_format vol=DBVolume

Output: 


Command executed successfully

Access control

User Category Permission
Storage administrator Allowed
Storage integration administrator Allowed
Application administrator Disallowed
Security administrator Disallowed
Read-only users Disallowed
Technicians Disallowed

Warnings

  • ARE_YOU_SURE_YOU_WANT_TO_FORMAT_VOLUME

    Volume Volume may contain data. Formatting will cause data loss. Are you sure you want to format volume Volume?

Return codes

  • VOLUME_BAD_NAME

    Volume name does not exist

  • VOLUME_HAS_SNAPSHOTS

    Volume has snapshots

  • VOLUME_IS_SNAPSHOT

    Operation is not permitted on snapshots

  • VOLUME_LOCKED

    Volume is locked

  • VOLUME_HAS_MIRROR

    Mirror is defined for this volume

  • VOLUME_HAS_DATA_MIGRATION

    Data Migration is defined for this volume

  • VOLUME_HAS_TRANSFORM

    Operation is not supported for volumes which are compressed/decompressed

  • OPERATION_DENIED_OBJECT_MANAGED

    This is a managed object. Only the managing software and xiv_maintenance / xiv_development may perform this operation on this object.

  • COMPRESSION_VOLUME_IS_OFFLINE

    Operation cannot be completed because the requested compressed volume is offline