American Megatrends MAN-STOR-ITX27-CLI manual Preface, Overview of CLI, Accessing CLI

Page 7

Chapter 1 Overview of CLI

Preface

Our feature rich StorTrends® iTX comes with a built-in command line interface (CLI) that provides extensive options to monitor and control “managed objects”. Wherever applicable, CLI follows industry standards and uses extensible ‘tags’ for new features and objects. The command line utility can be accessed through an in-band special console connected to the StorTrends® iTX system or out-of-band via a SSH or telnet client. It can also be used with scripting languages to automate a set of operations.

Overview of CLI

Our CLI supports commands in excess of 140 verbs and supports XML output format. The design is very similar to DMTF SMASH specifications and is being extended to fully comply with SMASH. Every managed element or object has a SMASH compliant <Target> addressing conforming to the server management instance addressing specification. The commands implemented are essentially “stateless” in nature. SMASH compliant <Verbs> is used to select the management actions, which are complemented by extensive <Option> attributes to control the behavior of the command. <Property> attributes can control the behavior of the output produced by the <Verb> along with various other mapping actions to the CIM schema.

The output produced can be controlled depending on the need, For example, in automation scripting. Output can also be made to be in the W3C standard compliant, self-descriptive XML format. The output format includes new tags pertinent to the object management. Inherent support for multi-lingual documents and Unicode data, along with content separation from presentation, aids in development of management applications that have their own data representation format. CLIs used for monitoring of performance parameters are dished out in XML tags that assist in graphing and charting, and can be right away imported by spreadsheet applications.

Accessing CLI

The CLI can be accessed either through an in-band console connected directly to the ITX box or through the out-of-band / remote CLP agents. It can also be accessed through a remote terminal emulation program using SSH or Telnet. Once connected, the administrator has to login to the system to perform the operations. In a typical console session, the user will be presented with a login screen such as:

login: cli <Enter>

password: ******* <Enter>

“cli” is the special user that has been provided with CLI access. The password is factory defaulted to “password”. Once logged in, the system will present the user with a CLI shell as follows:

CLI>

The user can then enter the supported commands in any order. The supported commands are listed in the next section. To close the session, the user can type the command ‘quit’. This will end the session.

Chapter One: Overview of CLI 1

Image 7 Contents
MAN-STOR-ITX27-CLI 06/07/2010 Revision History Preface Table of Contents Limitations of Liability Limited WarrantyTechnical Support Disclaimer Preface Accessing CLIOverview of CLI NIC-1 Initial SetupThis will list the available RAID LD’s present in the system Volume ConfigurationPage To create a target, use the following commands Similarly a SAN volume can be created as followsNext step is to activate a port for iSCSI traffic Then, to enable the target, use the syntax belowChapter Command SetCLIshow -h Enter For example To find out how the show command works, typeThese commands configure the way alerts are generated Alert ConfigurationDomain Configuration Date/Time ConfigurationThese commands configure the time zone and date These commands display or clear the event log Event log CommandsThese commands configure the network firewall options Firewall ConfigurationHealth Configuration General Server ConfigurationThese commands get the health information ISCSI Configuration Command Argument Description These commands configure the License License configurationNetwork Controller Configuration NAS Quota Configuration List retrieved will be given for both instead of singly NAS User / Group ConfigurationFor exmaple set -t user -u test1 -p test1 -f Test1 ug Protocol Configuration RAID & Disk Management Commands Command Argument Description Upgrades the firmware for a These commands work on NAS shares and directory Share, Directory & ACL ConfigurationLevel for NT 3provisiontype 0-Thin System Control ConfigurationVolume and Snapshot Commands These commands configure the System controlsCommand Argument Description Command Argument Description These commands configure the UPS for power management UPS ConfigurationXml Synchronous replication For example update -l c0v0 -p 50 -m SyncreplicaFor example Update -l c0v0 -g rg0 syncreplica For example Update -l c0v0 -p 50 -m 172.16.70.102Asynchronous Replication These commands configure asynchronous replicationUtilization bandwidth utilization Command Argument Description Failedduetorollback Command Argument Description Command Argument Description Command Argument Description Example Get -t journalfile -c Cont0 -f jf0 journal Journal Volume ManagementThese commands configure a journal and journal file ExamplePage Continuous Data Protection Recovery WizardThese commands are to view cdp for journal file These commands are used as part of recovery wizardWorkflow queue These commands are used as part of SRMStorage Resource Management List the tasks in report, pendingLocal and Replicated Snapshot validation These commands are used as part of snap validationPage Appendix a Error Codes Code 175 Error in mounting the share 338 License file read write error Code Code Code Code Description Code Description Code Description