ARX¶
Interfaces¶
Interface | Description |
Api | The Api Interface allows applications to retrieve ARX API information. |
Authentication | The Authentication Interface allows applications to retrieve ARX authentication information. CLI References: NFS Access Lists, CIFS Authentication. |
Channel | The Channel interface allows applications to monitor the ARX channels. A channel is a group of Ethernet ports aggregated into a single flow, as specified in IEEE 802.3ad. CLI References: Layer 2, channel (cfg). |
Chassis | The Chassis Interface lets applications retrieve ARX system information. |
DisasterRecovery | The DisasterRecovery interface allows applications to monitor the ARX disaster recovery configurations between ARX clusters. CLI References: Disaster Recovery Between ARX Clusters. |
Export | The Export Interface allows applications to retrieve ARX export information. CLI References: Front-End Services. |
FileChangeNotification | The FileChangeNotification Interface lets applications monitor and manage ARX file data storage activity. |
FileServer | The FileServer Interface lets applications retrieve ARX file server information. CLI References: External Filer. |
ManualMigrateRule | The Manual Migrate Rule Interface lets applications migrate files within a volume. |
Namespace | The Namespace Interface lets applications retrieve ARX namespace information. CLI References: Namespace, Place Rules. |
Network | The Network interface lets applications retrieve ARX network interface information. |
Policy | The Policy Interface allows applications to retrieve ARX policy information. |
Report | The Report interface allows applications to view the ARX reports. CLI References: show reports. |
Schedule | The Schedule interface allows applications to monitor and manage ARX schedules. CLI References: Schedules. |
Share | The Share Interface lets applications retrieve ARX share information. CLI References: Volume. |
VirtualService | The VirtualService Interface lets applications retrieve ARX virtual service information. CLI References: Global Server, Front-End Services. |
Vlan | The Vlan interface allows applications to monitor the ARX VLANs. A Virtual Bridged Local Area Network (VLAN) is a group of physically-separated MAC addresses that appear as a single LAN segment. CLI References: Layer 2, vlan (cfg). |
Volume | The Volume Interface lets applications retrieve ARX volume information. CLI References: Volume. |
Structures¶
Structure
Description
CommonStorageSubsystemStatistics
/** This structure contains the current CIFS/NFS operation statistics of this storage subsystem statistics type. CLI References: show statistics namespace … summary, show statistics namespace … fastpath.
A structure that contains the details of a virtual service export.
A structure that contains the details of a virtual service export.
A structure that contains the details of a file change.
A structure that contains the details of a file change response.
A structure that contains file server details.
A structure that contains the details of a chassis&aposs HA status. CLI References: show redundancy.
A structure that contains the details of system health events. CLI References: show health.
A structure that contains the details of a namespace.
A structure that contains network interface details.
A structure that contains the statistics of a network.
A structure that contains policy details.
A structure that contains the details of a policy schedule.
A structure that contains processor statistics.
A structure that contains file access protocol details.
A structure that contains share details.
A structure that contains share details.
A structure that contains notification snapshot details.
A structure that contains the details of a storage subsystem&aposs status for a chassis. CLI References: show chassis.
A structure that contains virtual service details.
A structure that contains virtual service details.
A structure that contains the statistics of a particular virtual service.
A structure that contains the details of a volume.
A structure that contains the details of a volume.
Enumerations¶
Enumeration | Description |
ARXStatusType | The ARXStatusType defines the status types that can be returned by methods that return the status of an object or module. |
CommonAuthType | An enumeration that defines the ARX authentication types. |
CommonFaultType | An enumeration of possible faults returned by ARX API. |
CommonFileSystemProtocolType | An enumeration that defines the file system protocol types. |
CommonIntervalType | An enumeration of possible interval types. |
CommonStorageSubsystemStatisticsType | Enumeration of subsystem statistic types. |
FileChangeType | Possible File Change Types. |
FileServerType | Possible File Server Types. CLI References: filer-type (gbl-filer). |
HARoleType | The possible HA Roles of a chassis. CLI References: show redundancy. |
PolicyScheduleIntervalType | Enumeration of policy schedule interval types. |
PolicyType | Enumeration of policy types. |
ProtocolType | The ProtocolType enumerates supported file access protocol types. |
ProtocolVersion | The ProtocolType enumerates supported file access protocol versions. |
VolumeType | Enumeration of ARX volume types. |
Exceptions¶
Exception | Description |
CommonFault | This structure contains the fault raised by ARX API. CLI References: show documentation. |
Aliases¶
Alias | Type | Description |
ARXStatusTypeSequence | ARXStatusType [] | A sequence of ARXStatusType |
CommonAuthTypeSequence | CommonAuthType [] | A sequence of CommonAuthType |
CommonFaultTypeSequence | CommonFaultType [] | A sequence of CommonFaultType |
CommonFileSystemProtocolTypeSequence | CommonFileSystemProtocolType [] | A sequence of CommonFileSystemProtocolType |
CommonIntervalTypeSequence | CommonIntervalType [] | A sequence of CommonIntervalType |
CommonStorageSubsystemStatisticsSequence | CommonStorageSubsystemStatistics [] | A sequence of CommonStorageSubsystemStatistics |
CommonStorageSubsystemStatisticsTypeSequence | CommonStorageSubsystemStatisticsType [] | A sequence of CommonStorageSubsystemStatisticsType |
ExportDefinition2Sequence | ExportDefinition2 [] | A sequence of ExportDefinition2 |
ExportDefinitionSequence | ExportDefinition [] | A sequence of ExportDefinition |
FileChangeDefinitionSequence | FileChangeDefinition [] | A sequence of FileChangeDefinition |
FileChangeResponseSequence | FileChangeResponse [] | A sequence of FileChangeResponse |
FileChangeTypeSequence | FileChangeType [] | A sequence of FileChangeType |
FileServerDefinitionSequence | FileServerDefinition [] | A sequence of FileServerDefinition |
FileServerTypeSequence | FileServerType [] | A sequence of FileServerType |
HARoleTypeSequence | HARoleType [] | A sequence of HARoleType |
HAStatusSequence | HAStatus [] | A sequence of HAStatus |
HealthDefinitionSequence | HealthDefinition [] | A sequence of HealthDefinition |
NamespaceDefinitionSequence | NamespaceDefinition [] | A sequence of NamespaceDefinition |
NetworkDefinitionSequence | NetworkDefinition [] | A sequence of NetworkDefinition |
NetworkStatsSequence | NetworkStats [] | A sequence of NetworkStats |
PolicyDefinitionSequence | PolicyDefinition [] | A sequence of PolicyDefinition |
PolicyScheduleIntervalTypeSequence | PolicyScheduleIntervalType [] | A sequence of PolicyScheduleIntervalType |
PolicyScheduleSequence | PolicySchedule [] | A sequence of PolicySchedule |
PolicyTypeSequence | PolicyType [] | A sequence of PolicyType |
ProcessorStatsSequence | ProcessorStats [] | A sequence of ProcessorStats |
ProtocolDefinitionSequence | ProtocolDefinition [] | A sequence of ProtocolDefinition |
ProtocolTypeSequence | ProtocolType [] | A sequence of ProtocolType |
ProtocolVersionSequence | ProtocolVersion [] | A sequence of ProtocolVersion |
ShareDefinition2Sequence | ShareDefinition2 [] | A sequence of ShareDefinition2 |
ShareDefinitionSequence | ShareDefinition [] | A sequence of ShareDefinition |
SnapshotDefinitionSequence | SnapshotDefinition [] | A sequence of SnapshotDefinition |
StorageStatusSequence | StorageStatus [] | A sequence of StorageStatus |
VirtualServiceDefinition2Sequence | VirtualServiceDefinition2 [] | A sequence of VirtualServiceDefinition2 |
VirtualServiceDefinitionSequence | VirtualServiceDefinition [] | A sequence of VirtualServiceDefinition |
VirtualServiceStatsSequence | VirtualServiceStats [] | A sequence of VirtualServiceStats |
VolumeDefinition2Sequence | VolumeDefinition2 [] | A sequence of VolumeDefinition2 |
VolumeDefinitionSequence | VolumeDefinition [] | A sequence of VolumeDefinition |
VolumeTypeSequence | VolumeType [] | A sequence of VolumeType |
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¶
- ARX File Change - This example shows how to retrieve the set of ARX file changes that occurred in a managed volume between two snapshots.
- ARX Namespace Info - This example shows how to retrieve all namespaces and their configuration on an ARX.
- ARX Volume Info -
- Perl ARX Chassis - This example shows how to retrieve chassis configuration, status and statistics on an ARX.
- Perl ARX Export - This example shows how to retrieve all exports and their configuration on an ARX.
- Perl ARX FileServer - This example shows how to retrieve all file servers and their configurations, statuses and statistics on an ARX.
- Perl ARX ManualMigrateRule - This example shows how to use manual migration rule to migrate files on an ARX.
- Perl ARX Namespace - This example shows how to retrieve all namespaces and their configuration on an ARX.
- Perl ARX Network - This example shows how to retrieve networks and their configurations, statuses and statistics on an ARX.
- Perl ARX Schedule - This example shows how to monitor and manage all schedules on an ARX.
- Perl ARX Virtual Service - This example shows how to retrieve all virtual services and their configurations, statuses and statistics on an ARX.
- Perl ARX Volume - This example shows how to retrieve all volumes and their configurations, statuses and statistics on an ARX.
- Ps ARX Monitor - These examples show how to use PowerShell to monitor an ARX through the iControl interfaces.
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.