System::Disk

Introduced : BIG-IP_v10.1.0
The Disk interface enables you to manage the disks in the system. The disk objects come in two flavors. “Physical disks” are the actual hardware disk drives, which can be anything from a true hard disk to a compact flash drive to a USB flash drive. Physical disks are addressed by their serial numbers. “Logical disks” are the view of the disk drives from the system&aposs point of view, abstracting the disk itself, making all disk drives look the same whether they are a true hard disk, a flash drive, or a full disk array. In other words, a logical disk can hold one or more physical disks. Logical disks are addressed by the LogicalDisk identifier, which includes their logical name (e.g., “HD2”, “CF1”, “MD1”) and their chassis slot identifier. It is important to note the potentially confusing relationship between logical and physical disks and their identifiers. All physical disks can be addressed by a LogicalDisk identifier, though it is not guaranteed that all physical disks have an entry in the logical disk table. The logical disk identifier for a physical disk is dependent on the connection of the disk drive to the system, so can change if the system&aposs disk drive configuration changes. On the other hand, all logical disks hold one or more physical disks, which can have a direct one-to-one mapping for a single disk drive or a one-to-many mapping for a disk array. To avoid problems, physical disks should be ideally addressed only by their serial numbers and logical disks only by their LogicalDisk identifiers. Addressing physical disks by their LogicalDisk identifier is supported as a convenience for any user-generated input. Be careful with these distinctions as you use this interface. The application volume component provides better granularity for managing disks. A logical disk can be logically segmented into several application volumes. An application volume belongs to only one logical disk and can never be shared. The visibility of the application volume can be confined to a particular software volume set or it can be made global to make it visible across all control planes. Once set, the volume set visibility property cannot be modified. Application volumes are created during the provisioning of disk-using application modules (e.g., “DATASTOR”, “VCMP” etc.). The application volumes may be discarded by the software(e.g. during module provisioning) unless its preservability property is changed to precious.

Methods

Method Description Introduced
add_array_member Adds physical disks to a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disks which represent disk arrays. BIG-IP_v10.1.0
add_array_member_by_logical_id Adds physical disks to a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disks which represent disk arrays. This method does exactly the same thing as “add_array_member”, except that the added physical disks are specified by their LogicalDisk identifiers, more convenient for user input than the serial numbers used in “remove_array_member”. It is supplied for convenience purposes only. BIG-IP_v10.1.0
delete_all_application_volumes Deletes all application volumes. BIG-IP_v11.0.0
delete_application_volume Deletes a set of application volumes. BIG-IP_v11.0.0
get_application_volume_list Gets the list of application volumes in the system. BIG-IP_v11.0.0
get_application_volume_status Gets the status for a set of application volumes. This provides details about the requested application volumes status. BIG-IP_v11.0.0
get_array_member Gets a list of physical disks that are members of a logical disk. Note that this can be used for any type of logical disk – single disk drives or disk arrays. However, it may not work for all physical disk logical identifiers. BIG-IP_v10.1.0
get_array_status Gets RAID disk array statuses for a set of physical disks. Note: RAID status will be RAID_STATUS_UNDEFINED if the disk is not a member of a RAID disk array (see get_physical_disk_is_array_member). BIG-IP_v10.1.0
get_bay_disk_serial_number Gets a list of serial numbers of disks installed for a set of disk bays. BIG-IP_v10.1.0
get_list Gets a list of physical disks in the system, identified by serial number. BIG-IP_v10.1.0
get_list_of_bays Gets a list of disk bays in the system. BIG-IP_v10.1.0
get_list_of_logical_disks Gets a list of logical disks in the system. BIG-IP_v10.1.0
get_logical_disk_device_name Gets device names for a set of logical disks. These are names like hda, hdb, etc. (Note: Currently, the strings are for descriptive purposes and are subject to change). BIG-IP_v10.1.0
get_logical_disk_format Gets the formats for a set of logical disks. These are strings like multiboot, lvm, etc. (Note: Currently, the strings are for descriptive purposes and are subject to change). BIG-IP_v10.1.0
get_logical_disk_media Gets media types for a set of logical disks. These are strings like hd, cf, cft, etc. (Note: Currently, the strings are for descriptive purposes and are subject to change). BIG-IP_v10.1.0
get_logical_disk_size Gets sizes (in MiB) for a set of logical disks. BIG-IP_v10.1.0
get_logical_disk_space_free Gets the free disk space available (in MiB) for a set of logical disks. BIG-IP_v11.0.0
get_logical_disk_space_in_use Gets the disk space in use (in MiB) for a set of logical disks. BIG-IP_v11.0.0
get_logical_disk_space_reserved Gets the volume group reserved sizes (MiB) for a set of logical disks. Reserved disk space (MiB) is the value set in accordance to the safety policy goal for a disk. If the free disk space available is at or below this number, no provision changes are allowed that would reduce the free space any further. BIG-IP_v11.0.0
get_logical_disk_user_mode Gets the user mode for a set of logical disks. The user mode defines how the logical disk will be consumed. BIG-IP_v11.0.0
get_name Gets names for a set of physical disks. This name is part of the physical disk&aposs LogicalDisk identifier. BIG-IP_v10.1.0
get_slot_id Gets slot identifiers for a set of physical disks. The slot identifier is part of the physical disk&aposs LogicalDisk identifer. BIG-IP_v10.1.0
get_version Gets the version information for this interface. BIG-IP_v10.1.0
is_array_member Gets states indicating whether a disk is a member of a RAID disk array for a set of physical disks. BIG-IP_v10.1.0
is_raid_capable Gets an indication of whether the system is capable of RAID operations. BIG-IP_v10.1.0
remove_array_member Removes phyiscal disks from a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disks which represent disk arrays. BIG-IP_v10.1.0
remove_array_member_by_logical_id Removes physical disks from a set of logical disk arrays. For a clustered system, this must be run on the chassis slot holding the disk array. This only works for logical disks which represent disk arrays. This method does exactly the same thing as “remove_array_member”, except that the removed physical disks are specified by their LogicalDisk identifiers, more convenient for user input than the serial numbers used in “remove_array_member”. It is supplied for convenience purposes only. BIG-IP_v10.1.0
set_logical_disk_space_reserved Sets volume group reserved sizes (in MiB) for a set of logical disks. BIG-IP_v11.0.0
set_logical_disk_user_mode Sets the user mode for a set of logical disks. BIG-IP_v11.0.0

Structures

Structure

Description

ApplicationVolume

A struct that contains a key for application volume.

ApplicationVolumeStatus

A structure describing the status of an application volume.

LogicalDisk

A struct that contains a key for logical_disk.


Enumerations

Enumeration Description
APPVOwner An enumeration of application volume owner. Owner property specifies the module (DATASTOR, MYSQL, VCMP) to which the application volume is dedicated.
APPVPreservabilityMode An enumeration of application volume preservability. Preservability mode defines whether the application volume can be discarded by software (e.g. during module provisioning).
LogicalDiskUserMode An enumeration of logical disk user mode. Mode for a logical disk describes its user.
RAIDStatus An enumeration of RAID status.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
APPVPreservabilityModeSequence APPVPreservabilityMode [] A sequence of preservability items.
ApplicationVolumeSequence ApplicationVolume [] A sequence of ApplicationVolumes.
ApplicationVolumeStatusSequence ApplicationVolumeStatus [] A sequence of ApplicationVolumeStatus.
LogicalDiskSequence LogicalDisk [] A sequence of LogicalDisks.
LogicalDiskSequenceSequence LogicalDisk [] [] A sequence of LogicalDisk sequences.
LogicalDiskUserModeSequence LogicalDiskUserMode [] A sequence of logical disk mode items.
RAIDStatusSequence RAIDStatus [] A sequence of RAID status items.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.