Applies To:

Show Versions Show Versions

Manual Chapter: Introduction
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>

This manual is a reference for F5s Command Line Interface (CLI). The book is organized as a companion to the CLI users guides (ARX® CLI Network-Management Guide, ARX® CLI Storage-Management Guide, and ARX CLI Maintenance Guide, in that order); for each chapter in the user guides there is a companion chapter in this book. This manual also has some additional chapters for CLI commands outside the scope of the users guides.
The Adaptive Resource Switch (ARX®) is a highly available and scalable solution that brings resource awareness to a file storage infrastructure, and adapts these resources to meet the demands of users and applications in real time. The ARX provides a file-virtualization layer that aggregates the total capacity and performance of your file storage. A namespace provides location-independent, transparent mapping of user requests onto the appropriate storage resource. You can configure policies that the switch enforces for the placement, replication and migration of files. Through policy configuration, the ARX adapts to the real-time demands of users and applications. The ARX thereby serves as a resource proxy for the files and services behind it.
The Adaptive Resource Switch acts as an in-band file proxy for the Network File System (NFS) and Microsoft's Common Internet File System (CIFS) protocols.
Front-end services provide the file virtualization layer that masks the physical file storage from the user and application. The switch becomes the file access point, as opposed to the actual physical resource, providing file access through a namespace. Users and applications maintain a single consistent file path that is transparently mapped to the proper physical resource where the information resides.
The Adaptive Resource Switch provides policy-based resource switching. Through policy configuration, you can optimize the placement of files onto the appropriate storage resources and automatically adapt these resources based on user and application demand. The ARX performs file replication and migration based on performance, usage or other life-cycle characteristics, enabling you to implement a flexible file services strategy. Examples of policies include: migrating files to reclaim stranded capacity; migrating files across different tiers of storage based on access patterns and/or value; and replicating frequently accessed files for performance. The result is more efficient utilization and greater flexibility in file storage management.
You can connect multiple ARXes with a Resilient Overlay Network (RON), which can reside on top of any IP network. This provides a network for distributing and accessing file storage. ARXes can replicate storage to other switches in the same RON, updating the replicas periodically as the writable master files change. This is called a shadow copy, where a source volume on one switch periodically copies its files to one or more shadow volumes on other switches. Clients can access the shadow volumes at multiple geographic locations, independent to where the source volume resides.
The Command-Line Interface (CLI) has its commands grouped into modes. Modes are structured as a tree with a single root, exec mode. This section summarizes the mode structure and explains some CLI conventions.
bstnA> enable
bstnA# config
bstnA# global
From any mode, use the exit command to return to its parent mode. From priv-exec mode, this command exits the CLI; to go from priv-exec mode back to exec mode, use the no enable command.
bstnA(gbl)# namespace wwmed
bstnA(gbl-ns[wwmed])# no volume /local
Many objects and configurations require you to enable them using the enable command before they can take effect. Likewise, many objects and configurations require you to first disable them using the no enable command before you can complete a related command or function. The no enable command does not remove an object; it only disables it until you re-enable it. The enable/no enable commands exist in many modes and submodes in the CLI.
bstnA(gbl)# namespace wwmed
To enter cfg mode, use the config command from priv-exec mode:
SWITCH> enable
SWITCH# config
SWITCH> enable
SWITCH# global
this font represents screen input and output;
bold text represents input, and
italic text appears for variable input or output.
this font is used for command-syntax definitions, which use the same rules for bold and italic.
[optional-argument] - square brackets ([ ]) surround optional arguments;
choice1 | choice2 - the vertical bar ( | ) separates argument choices;
{choice1 | choice2 | choice3} - curly braces ({ }) surround a required choice;
[choice1 | choice2]* - an asterisk (*) means that you can choose none of them, or as many as desired (for example, choice1 choice2 chooses both);
{choice1 | choice2}+ - a plus sign (+) means that you must choose one or more.
is the set of administrative roles that are allowed to access the command. Any number of administrative roles can be assigned to a command; and administrator who has one of these roles can access the command. The roles are
A command that is accessible to the operator is also accessible by an administrator with any other role.
Each administrative group has one or more of these roles, assigned by using the role command.
Table of Contents   |   << Previous Chapter   |   Next Chapter >>

Was this resource helpful in solving your issue?

NOTE: Please do not provide personal information.

Incorrect answer. Please try again: Please enter the words to the right: Please enter the numbers you hear:

Additional Comments (optional)