ARX::Share

Introduced : ARX V5.02.000
The Share Interface lets applications retrieve ARX share information. CLI References: Volume.

Methods

Method Description Introduced
get_configuration Returns a list of share configurations for the specified shares. CLI References: share (gbl-ns-vol). ARX V6.02.000
get_definition Returns a list of share definitions for the specified shares. ARX V5.02.000
get_definition2 Returns a list of share definitions for the specified shares. ARX V6.00.000
get_list Returns the list of shares. CLI References: show namespace. ARX V5.02.000
get_statistics Returns a list of share statistics for the specified shares. CLI References: show statistics namespace … summary, show statistics namespace … fastpath. ARX V6.02.000
get_status Returns a list of share statuses for the specified shares. CLI References: show namespace. ARX V6.02.000

Structures

Structure

Description

Configuration

This structure contains the configuration of a share on a managed volume. CLI References: share (gbl-ns-vol).

DirAttachConfiguration

This structure contains the configuration of a backend directory attached to a direct-mapped share. CLI References: attach (gbl-ns-vol-shr).

FileServerConfiguration

This structure contains the configuration to bind the current share to a back-end-filer share. CLI References: filer (gbl-ns-vol-shr).

PolicyConfiguration

This structure contains the policy free space configuration. CLI References: policy freespace (gbl-ns-vol-shr).

Statistics

This structure contains the current statistics of this share. CLI References: show statistics namespace … summary, show statistics namespace … fastpath.

Status

This structure contains the current status of this share. CLI References: show namespace.


Enumerations

Enumeration Description
StateType An enumeration that defines the current state of this share. CLI References: show namespace.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
ConfigurationSequence Configuration [] A sequence of Configuration
DirAttachConfigurationSequence DirAttachConfiguration [] A sequence of DirAttachConfiguration
FileServerConfigurationSequence FileServerConfiguration [] A sequence of FileServerConfiguration
PolicyConfigurationSequence PolicyConfiguration [] A sequence of PolicyConfiguration
StateTypeSequence StateType [] A sequence of StateType
StatisticsSequence Statistics [] A sequence of Statistics
StatusSequence Status [] A sequence of Status

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.