American Megatrends MAN-STOR-ITX27-CLI user manual

Summary of the content on the page No. 1

StorTrends®
iTX Software
CLI (Command Line Interface)
(Version 2.7)
User’s Guide






















MAN-STOR-ITX27-CLI
06/07/2010

Summary of the content on the page No. 2

© Copyright 1985-2010 American Megatrends, Inc. All rights reserved. American Megatrends, Inc. 5555 Oakbrook Parkway Norcross, GA 30093 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 Mega

Summary of the content on the page No. 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. 06/07/10 Added available cache options for create raid. 06/07/10 Since al

Summary of the content on the page No. 4

Table of Contents Revision History ......................................................................................................................................... ii Table of Contents ..................................................................................................................................... iv Table of Contents ..................................................................................................................................... iv Limited

Summary of the content on the page No. 5

Limited Warranty The buyer agrees that if this product proves to be defective, American Megatrends is only obligated to repair or replace this product at American Megatrends’ discretion according to the terms and conditions of the warranty registration software that accompanies this product. American Megatrends shall not be liable in tort or contract for any loss or damage, direct, incidental or consequential resulting from the use of this product. Please see the Warranty Registration So

Summary of the content on the page No. 6

Disclaimer This manual describes the operation of the American Megatrends StorTrends® iTX Software. Although efforts have been made to assure the accuracy of the information contained here, American Megatrends expressly disclaims liability for any error in this information, and for damages, whether direct, indirect, special, exemplary, consequential or otherwise, that may result from such error, including but not limited to the loss of profits resulting from the use or misuse of the manua

Summary of the content on the page No. 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 scr

Summary of the content on the page No. 8

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> get –-type or –t port -–name or –n NIC-1 --info or -i network Example: get –t port –n nic-1 –i network This will display the NIC-1 network settings. To configure static IP to this port:

Summary of the content on the page No. 9

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 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”. If Hardware RAID controllers present, then they will take precedence over Software MD. CLI> list –-type

Summary of the content on the page No. 10

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 Example: create –t container –c accounting –k 64 –l /dev/sdb volume (for a 3U) This command creates a container named “accounting” from the LD /dev/sdb. On a 1U, LDs are created with names of /dev/mdX, with X as 0, 1, and so

Summary of the content on the page No. 11

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 Example: create –t volume –c container1 –v volume1 –z 1000 –p 0 – e 0 –f 1 –k 8 volume This command creates volume “sanvol0” in container “conta

Summary of the content on the page No. 12

Then, to enable the target, use the syntax below: CLI>enable –-type or –t tgt –-targetname or -n sanvol0 iscsi 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 We recommend that you assign different portal tags to the two portals if they are on different subnets. StorTrends® iTX Sof

Summary of the content on the page No. 13

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: … The CLI provides a wide range of command sets. These commands are grouped into modules for better understanding. Each command is non-interactive and state-less. The are supported using switches. Our CLI accepts both short and long

Summary of the content on the page No. 14

For example: To find out how the show command works, type: CLI>show -h 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 CLI>show –d verbs The show option can display the functions available for a target or even the functions available for a verb. For example: To display the functions available for targets/verbs the user ha

Summary of the content on the page No. 15

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 -v/--value destination from the alert -x/--xml alert configuration. For example: delete -t snmp -v 10.0.3.155 -v 10.0.0.20

Summary of the content on the page No. 16

Date/Time Configuration These commands configure the time zone and date. Command Argument Description set timezone -z/--zone 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. set datetime -n/--ntp Configures the NTP server to be used for time synchronization. get timezone -c/--count Gets the number of tim

Summary of the content on the page No. 17

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 the given criteria. -n/--recordcount -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 get eventlog -c/--count Gets the number of events reported. -s/--section {v/s/o/h} -i/--info

Summary of the content on the page No. 18

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 ICMP protocol. -m/--mask -p/--proto {icmp} -x/--xml add firewall -a/--allow Add allowed or blocked firewall -b/--block rule with given parameters for TCP -i/--ip and UDP protocols. -m/--mask -s/--sport -e

Summary of the content on the page No. 19

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. set serverinfo -n/--name Configures the name of the server. -x/--xml The length of the servername should be less than 16 characte

Summary of the content on the page No. 20

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 enabled or disabled. For example: get –t tgtstatus –n target1 iscsi get iscsi -t/--type {tgtname} Gets the iSCSI target name. This value is not configurable an