American Megatrends StorTrends User’s guide User Manual
  1. Manuals
  2. Brands
  3. American Megatrends Manuals
  4. Software
  5. StorTrends User's guide
  6. User manual
American Megatrends StorTrends User’s guide User Manual

American Megatrends StorTrends User’s guide User Manual

Command line interface version 2.7
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
StorTrends®
iTX Software
CLI (Command Line Interface)
(Version 2.7)
User's Guide
MAN-STOR-ITX27-CLI
06/07/2010

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the StorTrends User’s guide and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for American Megatrends StorTrends User’s guide

Summary of Contents for American Megatrends StorTrends User’s guide

  • Page 1 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide MAN-STOR-ITX27-CLI 06/07/2010...

  • Page 2: Revision History

    This publication contains proprietary information which is protected by copyright. No part of this publication can be reproduced, transcribed, stored in a retrieval system, translated into any language or computer language, or transmitted in any form whatsoever without the prior written consent of the publisher, American Megatrends, Inc. American Megatrends, Inc. acknowledges the following trademarks: Intel and Pentium are registered trademarks of the Intel Corporation.
  • Page 3 01/25/10 Updated the iSCSI commands and corrected wrong format updation 03/30/10 Corrected the Create Volume usage and Get Eventlog Usage. 04/11/10 Update the create replication commands 06/07/10 Corrected the output of ‘cli main’. 06/07/10 Removed the term apple 06/07/10 Corrected set -t nfs command. 06/07/10 Corrected set raid commands.

  • Page 4: Table Of Contents

    Table of Contents Revision History ............................ii Table of Contents ............................. iv Table of Contents ............................. iv Limited Warranty ............................v Limitations of Liability ..........................v Technical Support ............................v Web Site ..............................v Disclaimer ..............................vi Chapter 1 Overview of CLI ........................1 Preface ..............................

  • Page 5: Limited Warranty

    Please see the Warranty Registration Software shipped with this product for full warranty details. Limitations of Liability American Megatrends, Inc. shall in no event be held liable for any loss, expenses, or damages of any kind whatsoever, whether direct, indirect, incidental, or consequential (whether arising from the design or use of this product or the support materials provided with the product).

  • Page 6: Disclaimer

    (even if American Megatrends has been advised of the possibility of such damages). Any questions or comments regarding this document or its contents should be addressed to American Megatrends at the address shown on the inside of the front cover.

  • Page 7: Chapter 1 Overview Of Cli

    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®...

  • Page 8: Initial Setup

    Initial Setup Network Configuration Once the StorTrends® iTX is installed in a new system, please ensure that the initial network configuration is proper. The system factory defaults to DHCP setup. The configured network settings can be verified by the following CLI commands: CLI>...

  • Page 9: Volume Configuration

    Volume Configuration Initial volume configuration can be done in three stages. 1. RAID Disk Creation At the base level is the RAID CONTROLLER. CLI> list –-type or –t controller raid <Enter> Example: list –t controller raid This will list the available RAID controllers in the system. By default, Software MD will be shown as a RAID controller with controller number “0”.

  • Page 10: Container And Volume Configuration

    2. Container and Volume Configuration Next step is the AMI DVM container creation. This can be done by the following commands: CLI>create –-type or -t container –-containername or -c container1 –-chunksize or –k 64 –-ldname or –l /dev/md0 volume <Enter> Example: create –t container –c accounting –k 64 –l /dev/sdb volume (for a 3U) This command creates a container named “accounting”...

  • Page 11: Enabling Share Or Target

    Similarly a SAN volume can be created as follows: CLI>create –-type or –t volume –-containername or -c container1 –-volumename or -v sanvol0 –-volumesize or -z 1000 –-provisiontype or -p 0 –-volumetype or -e 0 –-voldialect or -f 0 --chunksize or –k (8 or 64 for 8KB and 64KB chunk sized volume respectively.) volume <Enter>...
  • Page 12 Then, to enable the target, use the syntax below: CLI>enable –-type or –t tgt –-targetname or -n sanvol0 iscsi <Enter> Example: enable –t tgt –n sanvol0 iscsi Next step is to activate a port for iSCSI traffic. CLI>activate –-type or –t portal –-ipaddress or -p 10.0.0.100 –-portaltag or -g 1 iscsi Example: activate –t portal –p 10.0.0.100 –g 2 iscsi...

  • Page 13: Chapter 2 Command Set

    Chapter 2 Command Set Command Set The CLI design being similar to the DMTF SMASH specifications follows the standard to a great extent. The commands supported can be represented grammatically as follows: <verb> <option> … <property> <target> The CLI provides a wide range of command sets. These commands are grouped into modules for better understanding.
  • Page 14 For example: To find out how the show command works, type: CLI>show -h <Enter> This will display the many ways the show command can be used. (this is redundant) For example: To display the available targets/verbs, the user has to enter: CLI>show –d targets <Enter>...

  • Page 15: Alert Configuration

    Alert Configuration These commands configure the way alerts are generated. Command Argument Description get alert -t/--type snmp Gives the SNMP alert For example: configuration. get –t snmp alert get alert -t/--type email Gives the Email alert For example: configuration. get –t email alert delete alert -t/--type snmp Deletes the SNMP specified...

  • Page 16: Date/Time Configuration

    Date/Time Configuration These commands configure the time zone and date. Command Argument Description set timezone -z/--zone <zone name> Sets the time zone of StorTrends® -x/--xml iTX to given time zone. For example: set –z America/New_York timezone get timezone For example: get timezone Shows the configured time zone.

  • Page 17: Event Log Commands

    Event log Commands These commands display or clear the event log. Command Argument Description get eventlog -s/--section {v/s/o/h} Lists event log content matching -o/--offset <record-offset> the given criteria. -n/--recordcount <record-count> -i/--info v-Volume -f/--fatal s-System -w/--warning or o-OS -a – all eventlog h-Health -x/--xml For example: get –s vs –o 2 –n 20 –f –w eventlog...

  • Page 18: Firewall Configuration

    Firewall Configuration These commands configure the network firewall options. Command Argument Description add firewall -a/--allow or Add allowed or blocked firewall -b/--block rule with given parameters for the -i/--ip <ipaddress> ICMP protocol. -m/--mask <netmask> -p/--proto {icmp} -x/--xml add firewall -a/--allow Add allowed or blocked firewall -b/--block rule with given parameters for TCP...

  • Page 19: General Server Configuration

    General Server Configuration These commands retrieve the general server information, such as build version, build date and so on. It also allows configuration of a new server name. Command Argument Description get serverinfo For example: get serverinfo Displays the server information such as server name, build version, build date and so on.

  • Page 20: Iscsi Configuration

    iSCSI Configuration Note: Targetname input: Only the suffix portion of the targetname is required. For example: “iqn.1991-10.com.ami:itx001a2b3c4d5e2006:test1” . The user needs to input only “test1”. Command Argument Description get iscsi -t/--type {tgtstatus} Gives the status of the target as -n/--targetname <targetsuffix> enabled or disabled.
  • Page 21 Command Argument Description -c/--containername <containername> -m/--mode {0/1/2} 0 – Write through For example: set –t lunwritecachemode –v v1 –c c1 1 – Write back –m 0 iscsi add iscsi -t/--type {processor} Adds the processor to the specified -n/--targetname <target suffix> target (used for backup).

  • Page 22: License Configuration

    Command Argument Description For example: set –t tgtoptimizations –n t1 –p y –g 10 iscsi enable iscsi -t/--type { iSNSservice} Enables the iSNS Service. disable iscsi -t/--type { iSNSservice} Disables the iSNS Service. get iscsi -t/--type {iSNS} Gives the iSNS server's information i.e.

  • Page 23: Network Controller Configuration

    Network Controller Configuration These commands configure the network ports. They can also be used to create virtual bonding network ports (teams) for high availability and/or load balancing. Command Argument Description get network -t/--type {port} Gets the number of ports. -c/--count -x/--xml For example: get –t port –c count network get network...

  • Page 24: Nas Quota Configuration

    Command Argument Description -p/--port <adapter name> remove network -t/--type alias Removing an alias adapter -n/--name <alias name> NAS Quota Configuration These commands configure quotas for the NAS volumes of your iTX box. Command Argument Description get quota -t/--type {user } Displays the quota configured for -p/--path <volume path>...

  • Page 25: Nas User / Group Configuration

    NAS User / Group Configuration These commands allow viewing and configuration of the NAS Users and groups accounts. Note: Known Issue: As iTX software supports enabling of ADS and NIS simultaneously, the user/group list retrieved will be given for both instead of singly. Command Argument Description...

  • Page 26: Protocol Configuration

    set ug -t/--type {group} Adds the given user to the specified -g/--groupname <groupname> group. Multiple users can be added -u/--username <username> using –u/--username switch. -x/--xml (maximum of 8 users at a time) Protocol Configuration These commands configure the various network protocols supported. Command Argument Description...

  • Page 27: Raid & Disk Management Commands

    RAID & Disk Management Commands These commands allow management of disks and RAID creation. For Hardware RAID please enter the Slotindex (For example: 1, 2,3, and so on) instead of diskname (For example: /dev/sda, /dev/sdb) in the option for -d / --diskname <DiskInfo_OSName or slotindex> Command Argument Description...
  • Page 28 Command Argument Description expand raid -t/--type {ld} Expands the logical drive to -l/ -- ldname <ldname > specified disksize using specified -d/ --diskname <diskname or slotindex(optional)> disk. -s/--disksize <disksize in GB> -b/--subdisk <subdiskcount (Required only for RAID10N and RAID50)> -e/--distspare -n/--controllerno <controllerno (Required only for LSI RAID controller) For example: expand -t ld -l /dev/sdb -d 2 -s 20 raid...
  • Page 29 Command Argument Description -l / --ldname <ldname> -m/--cachemode <cache mode> Cache Modes - ld 0 - None 1 - Read 2 - Write 3 - Read-Write rescan raid -n/--controllerno <controller number> Initiates rescanning of the storage bus connected to the controller. remove raid -t/--type {spare} Removes a drive assigned as a...

  • Page 30: Share, Directory & Acl Configuration

    Share, Directory & ACL Configuration These commands work on NAS shares and directory. Command Argument Description create dir -p/--path <directory path> Creates a subdirectory with the -x/--xml given complete path. For example: create –p c0_nas0/new dir list dir -p/--path <directory path> Displays all directories in the -x/--xml volume.
  • Page 31 LEVEL FOR NT 0 - Apply to all levels 1 – Apply to first level PERMISSIONS FOR POSIX 0 - Read Write 1 - Read Only 2 - Deny PERMISSIONS FOR NT : The 14 bits in following order A - Traverse Folder / Execute file B - List Folder / Read Data C - Read Attributes D - Read Extended Attributes...

  • Page 32: System Control Configuration

    System Control Configuration These commands configure the System controls. Command Argument Description shutdown system For example: shutdown system Shuts the system down. get system For example: Gets the auto shutdown cli get -x system information. set system -f/--fansensors <on/off> Sets the fan sensors or temperature -t/--tempsensors <on/off>...
  • Page 33 Command Argument Description -L/--localsnap used, then only the local snapshot will be created. By default, without the switches –L and –R, it will create the local snapshot only. delete volume -t/--type {container} Deletes the container. -c/--containername<containername> -r/ option deletes all volumes -f/--force (optional) within the container recursively.
  • Page 34 Command Argument Description -c/ --containername <containername> -v/--volumename <volumename> get volume -t/--type {snap} Gets the snapshot schedule settings -c/--containername <containername> for the specified volume. -v/--volumename <volumename> -u/--schedule get volume -t/--type { snap} Gets the information about the -i/--info specified Snapshot. -c/--containername <containername> -v/--volumename <volumename>...

  • Page 35: Ups Configuration

    UPS Configuration These commands configure the UPS for power management. Command Argument Description get UPS -i/--info Displays the existing UPS -x/--xml configuration. get UPS -i/--info Display the monitoring -m/--monitor configuration for the configured -x/--xml UPS devices. set UPS -d/--disable Disables automatic shutdown. -x/--xml set UPS -e/--enable or...

  • Page 36: Synchronous Replication

    Synchronous replication These commands configure synchronous replication and High Availability using Windows DSM (iTX 2.7v 2.x). Command Argument Description create syncreplica –l/--local < cont_vol_name> Creates a replication pair. Both the -r/--remote < cont_vol_name> primary and secondary volumes -p/--priority <resync priority> should be present before this -i/--localhost <primary's IP address>...
  • Page 37 High Availability (iTX27 v3.x and up ) These commands configure High Availability which is OS Agnostic Command Argument Description syncparams -r/--remoteip < remote ipaddress > Syncparams is used to sync the syncreplica -x/--xmlflag iscsi base target names/date and time between local and remote machines before creating an HA For example: pair.
  • Page 38 Command Argument Description -g/--rgname <rgname> Update command is used to move a -x/--xmlflag <xml flag> replication volume pair from Resource group to another. For example: -g stands for the destination rg update -l c0_v0 -p 50 -m 172.16.70.102 -x name. syncreplica update -l c0_v0 -g rg0 syncreplica get syncreplica...

  • Page 39: Asynchronous Replication

    Asynchronous Replication These commands configure asynchronous replication. Command Argument Description create asyncreplica -t/--type <sar/jar/hasar> Creates a asynchronous replication -n/--name <snap assisted replication name> pair. Both the primary and -f/--volumedialect secondary volumes should be -a/--primarycontainer <primary contName> present before this operation. -l/--primaryvolume <primary volName>...
  • Page 40 Command Argument Description Example: container. list -c c0 asyncreplica This command can be issued on both Primary and Secondary storage systems. list asyncreplica -c/--containername <container name> Lists all the common snapshots (of -n/--name <asynchronous replication name> all volumes) in the asynchronous replication pairs in the given container.
  • Page 41 Command Argument Description -c/--containername <container name> replication to the original primary. -d/--index <system assigned name> This command can be issued only Example: in the original primary acting as a failback -n name -c c0 –d 1 asyncreplica secondary. rollbackjoin -n/--name <asynchronous replication name> If the status is asyncreplica -c/--containername <container name>...
  • Page 42 Command Argument Description update asyncreplica -n/--name <asynchronous replication name> Update ‘secondary snap count’ -c/--containername <container name> field alone. -d/--index <system assigned name> -z/--secsnapcount <secondary snap count> secsnapcount takes value between Example: 1-1022 update -n myname -d 1 -c Cont0 -z 200 asyncreplica This command can be issued in a primary.
  • Page 43 Command Argument Description -s/-- schedule> Replication. -d/--index <system assigned name> Note : Example: add -n myname -c Cont0 -s "0-24 0-7" -d 1 1) The periodicity can be of one of asyncreplica the following a.“<start time>-<end time> <start_day>-<end day>” add -n myname -c Cont0 -s "* 0-7" -d 1 b.“<start time >...
  • Page 44 Command Argument Description -n/--cgname <cgname> -s/--schedulesnap <scheduleduration:maxsnapshots> -d/--description <description> -b/--backuptargetname <backuptargetname> -p/--scheduleType <0-Windows,1-Local> Example: set -t snap -c Cont0 -n mysar0 -s 5:10 -s 60:20 -d testing -b backuptest -p 0 asyncreplica enable asyncreplica -t hasar Enables HA-DR with the HA pair -n/--name <...

  • Page 45: Journal Volume Management

    Journal Volume Management These commands configure a journal and journal file. create -t/--type journal Creates journal. journal -j/--journalname <journalname> -l/--ldname <ldname> Minimum LD size for journal creation is 10GB Example: create -t journal -j jour0 -l /dev/sdb journal create -t/--type journalfile Creates journal file.
  • Page 46 get -t snaptable -c c0 -f cg0 -n 10 journal list -t/ --type journal List journal information. journal list -t/ --type journalfile List journal file information. journal -c/--containername <containername list -t/ --type snaptable List information for a specific journal -c/--containername <containername> journal file snapshot.

  • Page 47: Continuous Data Protection

    Continuous Data Protection These commands are to view cdp for journal file. rollback -c/--container <containername> Performs rollback on journal file. -f/--journalfile <jfname> Example: rollback -c c0 -f jf0 cdp review -c/--container <containername> Performs CDP Review operation -f/--journalfile <jfname> for journal file. -s/--basesnap <t-number>...

  • Page 48: Storage Resource Management

    remove -c/--container <container name> Remove recoverywizard disables recoverywizard -v/--volume<volumename> the target enabled in the Review -s/--snap<snapname> recoverywizard, removes the set of -t/--tgt_name<tgt_name> snaps that have common ‘t’ -x/--xml (optional) number across the given set of volume(s) from the LUN, and Example: deactivates the snapshot.

  • Page 49: Local And Replicated Snapshot Validation

    Local and Replicated Snapshot validation These commands are used as part of snap validation. enable -t/--type local This will enable local NAS snap snapvalidation -c/--containername <containername> validation for the given NAS -v/--volumename<volumename> volume. Once enabled, it will be -x/--xml in “resumed” state by default – meaning ALL scheduled snaps will Example: be validated, both already present...
  • Page 50 -v/--volumename<volumename> set. -x/--xml SRP – Sync replica module Example: HA – High availability module pause -t SRP -c Cont0 -v Volume0 snapvalidation pause -t HA -c Cont0 -v Volume0 snapvalidation t/--type (SRP/HA) This will return the status – paused snapvalidation -c/--containername <containername>...

  • Page 51: Appendix A Error Codes

    Appendix A Error Codes Code Description Command Succeeded Command Failed Invalid Parameter Insufficient buffer Insufficient memory Invalid Operation Error in opening file User does not exist User already exists Selected user is a NIS user User type did not match ADS NIS and LOCAL User Count in UserList is not set Invalid User ID Group does not exist...
  • Page 52 Code Description Null parameter Invalid disk channel Invalid Disk Invalid Username Invalid password Invalid groupname Invalid Network port Invalid Path Invalid Volume Name Invalid share name Invalid server name Invalid member type Invalid member count Invalid access rights Invalid address Retry after system reboot Invalid member name Invalid service type...
  • Page 53 Code Description Error in mounting the share Upgrade version error Upgrade package already installed Upgrade package dependency failure Upgrade package installation failed Upgrade requires more disk space Invalid package name Error in upgrade operation Duplicate IP address Invalid IP address Invalid subnet mask Invalid gateway Invalid DNS server...
  • Page 54 Code Description License file read write error Duplicate Alias Name Alias not found Invalid Alias Name DHCP is not supported for Alias Adapters Maximum Alias Adapter count exceeded Maximum Alias per NIC exceeded No Target found Object Not Found Internal error Limits exceeded for operation Object does not have date iSNS status returned...
  • Page 55 Code Description No spare support Max limit reached No MD device available MD creation failed Add entry to configuration file failed disk is not free Minimum disk count Error in updating configuration file Error in reading from configuration file read error Raid hot remove failed Disk partitioning failed Raid hot add failed...
  • Page 56 Code Description Error in mounting file system Error in getting snap info Error in creating writable snap Error in getting volume info Max space reached Invalid dialect Invalid Snap Error in rolling back Snap Error in unmounting file system Error in reading metadata Serial already exists Invalid mount type Quota operations not possible on iSCSI volumes...
  • Page 57 Code Description Error in BIND License - HA pair creation license expired/disabled License - Unable to Read the License File License - License Validation Failure License - New Motherboard or New Motherboard with Some External NIC cards found, For service key generation, remove all External NIC cards from the system License - Thin provision license expired/disabled, request denied.
  • Page 58 Code Description 1029 Replication - Volume is not in sync 1030 Replication - Box owns RG but volumes are secondary 1031 Replication - Box is not the orignal owner of the RG 1032 Replication - Box does not own RG but volumes are primary 1101 Asynchronous Replication –...
  • Page 59 Code Description 1306 Snap Validation – Local snapshot not available 1307 Snap Validation – User snapshot validation pending 1308 Snap Validation – Snapshot already validated 1325 Read only snap count max reached 1326 Snap count per volume max reached 1327 Snap count per system max reached 1345 Duplicate Frequency/Level entered for Snapshot Schedule...
  • Page 60 Code Description 4099 DVM - Device open error 4100 DVM - Device access error 4101 DVM - general error 4102 DVM - Lib DM suspend error 4103 DVM - Lib DM resume error 8192 DVM - generic error 8193 DVM - memory allocation errors 8194 DVM - IOCTL Parameter passing failures copy_from_user, copy to user etc 8195...

This manual is also suitable for:

Stortrends itx

Table of Contents