Chapter 12. Storage Domains

12.1. Storage Domain Elements

The storagedomains collection provides information about the storage domains in a Red Hat Virtualization environment. An API user accesses this information through the rel="storagedomains" link obtained from the entry point URI.
The following table shows specific elements contained in a storage domain resource representation.

Table 12.1. Storage domain elements

Element Type Description Properties
link rel="permissions" relationship A link to the sub-collection for storage domain permissions.  
link rel="files" relationship A link to the files sub-collection for this storage domains.  
link rel="vms" relationship A link to the vms sub-collection for a storage domain with type set to export.  
link rel="templates" relationship A link to the templates sub-collection for a storage domain with type set to export.  
type enumerated The storage domain type. A list of enumerated values are available in capabilities.
external_status complex/enumerated The storage domain health status as reported by external systems and plug-ins. The state element contains an enumerated value of ok, info, warning, error, or failure.  
master Boolean: true or false true if this is the master storage domain of a data center.
host complex A reference to the host on which this storage domain should be initialized. The only restriction on this host is that it should have access to the physical storage specified.
storage complex Describes the underlying storage of the storage domain.
available integer Space available in bytes.
used integer Space used in bytes.
committed integer Space committed in bytes.
storage_format enumerated Describes the storage format version for the storage domain. A list of enumerated values are available in capabilities.
wipe_after_delete Boolean: true or false Sets the wipe after delete option by default on the storage domain. This option can be edited after the domain is created, but doing so will not change the wipe after delete property of disks that already exist.  
warning_low_space_indicator integer A percentage value that sets the warning low space indicator option. If the free space available on the storage domain is below this percentage, warning messages are displayed to the user and logged.  
critical_space_action_blocker integer A value in GB that sets the critical space action blocker option. If the free space available on the storage domain is below this value, error messages are displayed to the user and logged, and any new action that consumes space, even temporarily, will be blocked.  

Important

The API as documented in this chapter is experimental and subject to change. It is not covered by the backwards compatibility statement.