ARX::Volume¶
Methods¶
| Method | Description | Introduced |
| get_configuration | Returns the volume configurations for the specified volumes. CLI References: Volume. | ARX V6.02.000 |
| get_definition | Returns the volume definitions for the specified volumes. | ARX V5.02.000 |
| get_definition2 | Returns the volume definitions for the specified volumes. | ARX V6.00.000 |
| get_list | Returns the list of volumes for the specified namespace. CLI References: show namespace. | ARX V5.02.000 |
| get_statistics | Returns a list of volume statistics for the specified volumes. CLI References: show statistics metadata, show statistics migration. | ARX V6.02.000 |
| get_status | Returns the current status for the specified volumes. CLI References: show namespace. | ARX V6.02.000 |
Structures¶
Structure
Description
This structure defines the configuration parameters of a managed volume. You can find more details in the Volume section in the CLI Reference Guide. CLI References: Volume.
This structure defines the metadata share configurations of a managed volume. CLI References: metadata share (gbl-ns-vol).
This structure defines the current status of a metadata share of a managed volume. CLI References: show namespace.
This structure contains the current statistics of this volume. CLI References: show statistics metadata, show statistics migration.
This structure defines the status of a managed volume. CLI References: show namespace.
Enumerations¶
| Enumeration | Description |
| CifsNotifyChangeModeType | This enumeration defines how client notify-change requests are handled. CLI References: cifs notify-change-mode (gbl-ns-vol). |
| CifsOpLockType | This enumeration defines the CIFS opportunistic locks (oplocks). CLI References: cifs oplocks-disable (gbl-ns-vol). |
| FreespaceMode | This enumeration defines the supported Windows Volume Shadow Services modes. CLI References: freespace calculation dir-master-only (gbl-ns-vol), freespace calculation manual (gbl-ns-vol). |
| SnapshotDirectoryDisplayType | An enumeration that defines the supported Windows Volume Shadow Services modes. CLI References: snapshot directory display (gbl-ns-vol). |
| StateType | An enumeration that defines the current state of this volume. CLI References: show namespace. |
| VssModeType | This enumeration defines the supported Windows Volume Shadow Services modes. CLI References: snapshot vss-mode (gbl-ns-vol). |
Aliases¶
| Alias | Type | Description |
| CifsNotifyChangeModeTypeSequence | CifsNotifyChangeModeType [] | A sequence of CifsNotifyChangeModeType |
| CifsOpLockTypeSequence | CifsOpLockType [] | A sequence of CifsOpLockType |
| ConfigurationSequence | Configuration [] | A sequence of Configuration |
| FreespaceModeSequence | FreespaceMode [] | A sequence of FreespaceMode |
| MetadataShareConfigurationSequence | MetadataShareConfiguration [] | A sequence of MetadataShareConfiguration |
| MetadataShareStatusSequence | MetadataShareStatus [] | A sequence of MetadataShareStatus |
| SnapshotDirectoryDisplayTypeSequence | SnapshotDirectoryDisplayType [] | A sequence of SnapshotDirectoryDisplayType |
| StateTypeSequence | StateType [] | A sequence of StateType |
| StatisticsSequence | Statistics [] | A sequence of Statistics |
| StatusSequence | Status [] | A sequence of Status |
| VssModeTypeSequence | VssModeType [] | A sequence of VssModeType |
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.