Command Reference 2 · 2017-10-31 · • To display a man page that introduces all the commands,...

Command Reference

Version 2.3

Legal Notices

Copyright 2010-2015 Nimble Storage, Inc. All rights reserved worldwide.

No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or byelectronic, mechanical, recording, photocopy, scanning or other means without prior written permission fromNimble Storage, Inc.

The product described in this documentation may be protected by US Patent 8,285,918, US Patent 8,832,330and other pending patent applications.

Nimble Storage, Incorporated (Nimble), has used the latest information that is available in producing thisdocument. Nimble Storage makes no warranty, expressed or implied, with regard to accuracy andcompleteness.

Information in this document is subject to change without notice.

Nimble Storage, the Nimble Storage logo, CASL, InfoSight, SmartStack and NimbleConnect are trademarksor registered trademarks of Nimble Storage. All brand names and product names mentioned in this documentare trademarks of their respective owners. Where known, trademarked, registered trademarks, and servicemarks are designated as such.

InfoSight® is a registered trademark in Japan of Intage Inc. of Japan. Usage of InfoSight® in Japan is permittedpursuant to a trademark license agreement between Nimble Storage, Inc. and Intage Inc.

Nimble Storage, Inc.211 River Oaks ParkwaySan Jose, CA 95134U.S.A.

Tel: +1 408.432.9600Website: http://www.nimblestorage.comSales: [email protected]

SupportAll documentation and knowledge base articles are available on the Nimble Storage Support site athttps://infosight.nimblestorage.com. To register on InfoSight, click the Enroll Now link on the main page.

Email: [email protected].

For all other general support contact information, go to http://www.nimblestorage.com/support.

Copyright © 2010-2015 by Nimble Storage, Inc. All rights reserved.

http://www.nimblestorage.com

mailto:[email protected]

https://infosight.nimblestorage.com

mailto:[email protected]

http://www.nimblestorage.com/support/

Contents

About the Nimble Command Line Interface (CLI).....................................5?...........................................................................................................................................................6

Nimble Administrative Commands.............................................................7alert......................................................................................................................................................8

array...................................................................................................................................................11

auditlog..............................................................................................................................................16

cert.....................................................................................................................................................19

chapuser............................................................................................................................................20

ctrlr.....................................................................................................................................................23

date....................................................................................................................................................25

disk.....................................................................................................................................................26

encryptkey..........................................................................................................................................32

failover................................................................................................................................................35

fc........................................................................................................................................................36

group..................................................................................................................................................40

halt.....................................................................................................................................................52

initiatorgrp..........................................................................................................................................54

ip........................................................................................................................................................61

migration............................................................................................................................................67

netconfig............................................................................................................................................69

nic......................................................................................................................................................73

partner................................................................................................................................................77

perfpolicy............................................................................................................................................85

pool....................................................................................................................................................91

prottmpl..............................................................................................................................................95

reboot...............................................................................................................................................107

route.................................................................................................................................................109

setup................................................................................................................................................111

shelf.................................................................................................................................................115

snap.................................................................................................................................................118

snapcoll............................................................................................................................................121

software............................................................................................................................................124

sshkey..............................................................................................................................................127

stats.................................................................................................................................................130

subnet..............................................................................................................................................135

timezone...........................................................................................................................................140

useradmin........................................................................................................................................141


usersession......................................................................................................................................145

version..............................................................................................................................................147

vmwplugin........................................................................................................................................148

vol.....................................................................................................................................................151

volcoll...............................................................................................................................................168

Regulatory Information................................................................................................183Regulatory Warnings.......................................................................................................................183


About the Nimble Command Line Interface (CLI)

Run Nimble administrative commands from the command line interface(CLI) to configure and monitor a Nimble Storage array.

Topics:

• ?Use a secure shell (SSH) utility to log in to the management IP of aNimble array to run administrative commands. Your role determines yourpermission level, which in turn determines the command options youcan run.

After you log in, you see a security message for array usage. You do nothave to acknowledge the security message. Type ? to display a list ofadministrative commands. Then use any or all of the following optionsto get more information about the commands:

• To display available options for a specific command, typecommand_name --help.

The output lists each option and suboption, and provides briefdescriptions of each.

• To display a man page that introduces all the commands, type manintro.

The output lists each command, and provides brief descriptions ofeach. Press the spacebar to page through the list. Type q to quit whenyou get to the end of the introduction.

• To display detailed information for a specific command, type mancommand_name.

The output lists the command name and brief description, synopsisof each option and suboption, and detailed descriptions of each optionand suboption, including valid values. Press the spacebar to pagethrough the list. Type q to quit when you get to the end of the manpage.

5Copyright © 2010-2015 by Nimble Storage, Inc. All rights reserved.

About the Nimble Command Line Interface (CLI)

?Lists the Nimble administrative commands or all commands.

Note The ? and help commands are similar. The major difference is that help command has a man page;the ? command does not.

Synopsis

?

? --help

? --all

Options

RoleDescriptionArguments and SuboptionsOption

GuestShow usage information for thecommand.

N/A--help

GuestShow all available commands, notjust the Nimble-specific administrat-ive commands.

N/A--all

Examples

This example lists the administrative commands to manage a Nimble array.

Nimble OS $ ?? fc pool subnetalert group prottmpl timezonearray halt reboot useradminauditlog help route usersessioncert initiatorgrp setup versionchapuser ip shelf vmwpluginctrlr migration snap voldate netconfig snapcoll volcolldisk nic softwareencryptkey partner sshkeyfailover perfpolicy stats

This example shows partial output from ? --all. The output is truncated to save space.

Nimble OS $ ? --all? expr nohup subnet[ failover nslookup sum[[ false od syncalert fc partner tacarp fgrep patch tailarray find perfpolicy tee......encryptkey mv stats zcatenv netconfig stringsexpand nic stty


?

Nimble Administrative Commands

A wide variety of administrative commands are provided to configure,manage, and monitor Nimble arrays.

Topics:

• alertUse either the Nimble OS graphical user interface (GUI) or the commandline interface (CLI) to perform administrative operations on a Nimble

• array• auditlog array or group of arrays. These interfaces provide comparable• cert management capabilities. The GUI has tooltips, embedded user

assistance, and help to guide you through administrative operationsinteractively. The CLI is useful to script frequently performed operations.

• chapuser• ctrlr• date• disk• encryptkey• failover• fc• group• halt• initiatorgrp• ip• migration• netconfig• nic• partner• perfpolicy• pool• prottmpl• reboot• route• setup• shelf• snap• snapcoll• software• sshkey• stats• subnet• timezone• useradmin• usersession• version• vmwplugin• vol• volcoll



alertThe alert command options manage array alerts and events. Alerts and events can use both email andSMTP notification methods.

Alerts provide a valuable diagnostic and preventative tool. By default, all alerts are displayed when listingalerts. You can filter based on severity levels, categories, and time spans to display only the alerts that youare interested in. For example, you can filter for the most recent alerts, and periodically list all of them to lookfor potential errors.

You can also send a test alert to verify that the system is configured properly to send alerts.

Synopsis

alert --help

alert --list[--array array_name][--from [[yyyy-]mm-dd,]hh:mm[:ss]][--to [[yyyy-]mm-dd,]hh:mm[:ss]][--severity {info|warning|critical}][--category {hardware|service|replication|volume|update|config}]

alert --info id

alert --test[--severity {info|warning|critical}]

Options



N/A--help


alert


GuestList alerts and events for the spe-cified array.

[--array array_name]--list

List alerts that start from the spe-cified time. Use only the time, oruse the date and time. For ex-ample, alert --list --from08-14,12:10:00 or alert --list --from 12:10:00. Usethis option with or without the --tooption. If used alone, --to is as-sumed to be now.

[--from [[yyyy-]mm-dd,]hh:mm[:ss]]

List alerts until the specified time.Use only the time, or use the dateand time. For example, alert --list --to 08-14,12:10:00or alert --list --to12:10:00. Use this option with orwithout the --from option.

[--to [[yyyy-]mm-dd,]hh:mm[:ss]]

List alerts and events of the spe-cified severity level. Alert levels arenot cumulative. For example, select-ing critical does not show the infoor warning severity levels.

[--severity {info|warning|critical}]

List alerts and events of the spe-cified category.

[--category {service|replica-tion|volume|update|config}]

GuestList detailed information about thespecified alert ID. To determinevalid alert IDs, use alert --list.

id--info

PowerUser

Generate a test alert with the spe-cified severity level.

--severity {info|warning|critical}]--test

Examples

This example lists all alert messages on the array where you run the command. The output is truncated tosave space.

Nimble OS $ alert --list----------+--------+--------------------+------+-----------+----------+---------ID Severity Time Type Category Array Detail----------+--------+--------------------+------+-----------+----------+---------

8 INFO Jun 27 2014 11:13:40 2101 service AA-102081 Systemservices started...

9 INFO Jun 27 2014 11:14:02 12714 hardware AA-102081 A newshelf is detected......

This example lists information about the alert with the ID 23.

Nimble OS $ alert --info 23ID: 23



Active: yesPriority: INFOCategory: hardwareType: 12201Time: Feb 24 2014 17:10:00Cleared: N/AArray: AC-102266Target type: NICTarget: 192.168.1.3Detail: IP interface 192.168.1.3 up on controller A NIC port eth1

This example sends an alert test email with the warning severity level.

Nimble OS $ alert --test --severity warning

From: AdminSent: Wednesday, August 14, 2013 12:12 PMTo: eng-solSubject: Nimble Alert on sol / mars (AC-109828) - WARNING: Test alertTime: Wed Aug 14 15:11:40 2013

Type: 5005Id: 31645Message: Test message at warn level

Group Name: AdminGroup ID: 2070866469188534807Array name: marsSerial: AC-109828Version: 2.0.3.8-46920-opt

Arrays in the group:----------------+-----------------+-----------+----------------+-----------Name Serial Model Version Status----------------+-----------------+-----------+----------------+-----------moon AC-103234 CS460G-X2 2.0.3.8-46920-opt reachablesaturn AC-103236 CS460G-X2 2.0.3.8-46920-opt reachablejupiter AC-103242 CS460G-X2 2.0.3.8-46920-opt reachablemercury AC-103235 CS460G-X2 2.0.3.8-46920-opt reachable



arrayThe array command options manage a Nimble array.

Note Minimize the amount of time between running array --resetup and the setup command. On a FibreChannel array, there is no I/O between running array --resetup and setup. On an iSCSI array, existingconnections may be unaffected, but new connections are refused.

Synopsis

array --help

array --list

array --discover

array --info {name|serial_number}

array --edit name[--name new_name]

array --resetup[--non_interactive]

array --add serial_number[--name name][--subnet_label subnet_label][--data_ipaddr ipaddr][--nic nic][--tagged tag][--support_ipaddr ipaddr][--pool pool][--create_pool][--pool_description pool_description]

array --remove name[--force]

Options



N/A--help

GuestList all discovered and groupmember arrays.

N/A--list

PowerUser

Discover non-member arrays onthe same management subnet.

N/A--discover

GuestProvide detailed information aboutthe specified group-member array.

{name | serial_number}--info


array


PowerUser

Modify the name of the array. Thename must conform to iSCSI nam-ing conventions. It can be anycombination of up to 63 alphanu-meric characters and hyphen, butcannot begin with a hyphen, orcontain spaces or other punctu-ation.

[--name new_name]--edit

Adminis-trator

Set a standalone array in a statewhere you can run the setupcommand again. This reenablesthe zeroconf process and lets youreset the array password, IP ad-dress, and most other configurationsettings. No data will be lost. Afterrunning this command, any com-puter on the same subnet as thearray can be used to reset the arraypassword and then control the ar-ray. Use this command with cau-tion. Minimize the time betweenresetting the array with this com-mand and running setup again tolimit I/O disruption. On a FibreChannel array, there is no I/Obetween running array --resetupand setup. On an iSCSI array,existing connections may be unaf-fected, but new connections arerefused.

N/A--resetup

Override the default behavior ofhaving to type "yes" to completethe command. Use this suboptionwith care to avoid unexpectedlysetting up the array.

[--non_interactive]




PowerUser

Serial number of an array to add toa group.

serial_number--add

Name of an array to add to agroup. The group must exist.

--name name

Subnet label on the NIC.--subnet_label subnet_label

Network IP address(es) managedata traffic. Repeat this option toset multiple IP addresses for mul-tiple NICs. Then the first IP addressis assigned to the first NIC, suchas eth1, and the second to thesecond NIC, such as eth2, and soon. To skip a NIC, type a blank ar-gument.

--data_ipaddripaddr

NIC setting.--nicnic

Include this argument twice. Thenthe first IP address entered is as-signed to Controller A and thesecond to Controller B. You mustassign static IP addresses to allowarray access if the management IPaddress is not accessible.

--support_ipaddripaddr

Pool to assign the array to. If youspecify this suboption, then thepool must exist. If you do not spe-cify this suboption or the --cre-ate_pool suboption, then the arrayis assigned to the default pool.

[--poolpool_name]

Create a new storage pool andautomatically assign the array to it.If you do not specify this suboptionalong with the --pool suboption,then the array is assigned to thedefault pool.

[--create_pool]

If you create a new pool for an ar-ray, type a description for the pool.If there are spaces in the descrip-tion, enclose the text in quotationmarks.

[--pool_description pool_descrip-tion]

PowerUser

Name of the array to remove froma group. Use the pool commandto remove the array from any pools.

name--remove

Forcibly remove the specified arrayfrom a group even if it is unreach-able. This may lead to loss of dataif a volume is currently stripedacross disks on the array.

--force



Examples

This example displays a list of member arrays.

Nimble OS $ array --list-----------------+---------------+-----------+-----------------+-----------Name Serial Model Version Status-----------------+---------------+-----------+-----------------+-----------c12-array3 AC-100159 CS210 2.0.4.1-44556-opt reachablec12-array6 AC-100209 CS220 2.0.4.1-44556-opt reachable

This example discovers non-member arrays.

Nimble OS $ array --discover-------------+----------+-----------------+--------------------------------Serial Number Model Version Link-Local IP Addresses-------------+----------+-----------------+--------------------------------AC-100159 CS210 2.0.3.8-44640-opt 169.254.8.98, 169.254.8.93...

This example shows information for the array named c20-array1.

Nimble OS $ array --info c20-array1Model: CS220...Array name: c20-array1...Member of pool: defaultStatus: reachable

This example shows information for the array with the serial number AC-102566.

Nimble OS $ array --info AC-102566Model: CS220Serial: AC-102566...Array name: c20-array1...Member of pool: defaultStatus: reachable

This example renames the MKTG array to Marketing.

Nimble OS $ array --edit MKTG --name Marketing

This example resets a standalone array so the setup command can be run.

Note Use this command option with caution.

Nimble OS $ array --resetupWARNING: This operation will reset the array configuration. Minimize the timebeforerunning setup again to limit I/O disruption. Existing iSCSI connections maybeunaffected, but new iSCSI connections will be refused.Type yes to continue, no to cancel: yesSuccessfully initiated array reset.Minimize the time before running setup again to limit I/O disruption. ExistingiSCSIconnections may be unaffected, but new iSCSI connections will be refused.WARNING: While the volume data and some of the configuration data are preserved,a



future setup of the array could change the group name and the networkconfiguration.This will invalidate the replication partner and the host configuration, whichmaydisrupt replication and iSCSI connections to this array.

This example adds the serial number of an uninitialized array and assigns a new name to the array duringthis process.

Although only one set of name, subnet_label, data_ipaddr, and pool options is required, you can use multiplesets of these options to specify values for more than one NIC on an array, such as eth1, eth2, tg1, tg2.

Nimble OS $ array --add AC-100159 --name c12-array3\

--data_ipaddr '' --subnet_label management \--data_ipaddr '' --subnet_label management \--data_ipaddr 198.51.100.61 --subnet_label data \--data_ipaddr 198.51.100.62 --subnet_label data \--support_ipaddr 10.19.0.57 --support_ipaddr 10.19.0.58

This example removes an existing member array named greydient from a group.

Note The array to remove must not be assigned to a pool. If needed, run pool --unassign to remove thearray from a pool before you run this command.

Nimble OS $ array --remove greydient



auditlogThe auditlog command options manage array audit log entries.

The Nimble OS audit log keeps records of all non-read operations performed on the array, and which userperformed the operation. You can search the audit log by activity and object type/name. You can also filterthe audit log by time range, username, userid, activity category, and access type. Administrators can viewthe audit log in a summary table with faceted browsing by time, activity category, and across access type.

Synopsis

auditlog --help

auditlog --list[--from [[yyyy-]mm-dd,]hh:mm[:ss]][--to [[yyyy-]mm-dd,]hh:mm[:ss]][--username username][--userid userid][--category {provision|protection|dataaccess|useraccess|sysconfig|swupdate}][--access_type {gui|cli|api}]

auditlog --info id

Options



N/A--help


auditlog


Adminis-trator

List audit logs that start from thespecified time. Use only the time,or use the date and time. For ex-ample, auditlog --list --from 08-14,12:10:00 orauditlog --list --from12:10:00.Use this option with orwithout the --to option. If usedalone, --to is assumed to be now.

[--from [[yyyy-]mm-dd,]hh:mm[:ss]]--list

List audit logs until the specifiedtime. Use only the time, or use thedate and time. For example,auditlog --list --to 08-14,12:10:00 or auditlog --list --to 12:10:00. Use thisoption with or without the --fromoption.


List audit logs by username.[--username {username}]

List audit logs by userid.[--userid {userid}]

List audit logs of the specified cat-egory.

[--category {provision|protec-tion|dataaccess| useraccess|sy-sconfig|swupdate}]

List audit logs using the specifiedaccess type.

[--access_type {gui|cli|api}]

Adminis-trator

List detailed information about thespecified audit log ID. To determinevalid audit log IDs, use auditlog--list.

id--info

Examples

This example lists all alert messages on the array where you run the command. The output is truncated tosave space.

Nimble OS $ auditlog --list--------+--------------------+---------------+---------+------------------------ID Time User Status Activity--------+--------------------+---------------+---------+------------------------1 Mar 25 2015 09:10:52 admin Succeeded Login attempt

2 Mar 25 2015 09:10:53 admin Succeeded Complete setup on ...3 Mar 25 2015 09:45:52 admin Succeeded User admin session ...4 Mar 26 2015 13:22:41 Succeeded Logout user

5 Mar 26 2015 13:43:21 Succeeded Logout user



This example lists all alert messages on the array where you run the command, filtered by username. Theoutput is truncated to save space.



Nimble OS $ auditlog --list--username pAdmin--------+--------------------+---------------+---------+------------------------ID Time User Status Activity--------+--------------------+---------------+---------+------------------------

57 Apr 22 2015 11:45:20 pAdmin Succeeded Login attempt

78 Apr 22 2015 13:16:40 pAdmin Succeeded Logout user pAdmin










This example lists information about the audit log with the ID 23.

Nimble OS $ auditlog --info 23ID: 23Type: 8015Object name: vol2Object type: VolumeScope: -Time: Mar 25 2015 09:28:06Status: SucceededError code: SM_http_okUser ID: 3Username: pAdminUser full name: Administrator UserSource IP: 10.20.21.168Access Type: GUIApplication name: GUICategory: Data ProtectionActivity type: otherActivity: Associate volume vol2 with volume collection volcoll2



certThe cert command options manage the certificates needed by the Nimble arrays for HTTPS communication.

After setting up a group-leader array or upgrading to 2.1.x, the array automatically generates two public keypairs and certificates to use for securing HTTPS connections. The first is a self-signed Certificate Authority(CA) key pair and certificate. The CA key is used to sign the second certificate, which contains informationabout the identity of the host, such as the DNS name for the array, the group DNS name, and managementIP addresses. The CA certificate, host certificate, and host private key are installed as the web server'scredentials, and are subsequently used to authenticate the web GUI connection.

The host certificate for the web server is automatically regenerated if the group name, array name, or IPaddress assignments change, so you do not have to run this command under these conditions. The CAcertificate remains the same so that browsers with the CA certificate installed do not raise a security exception.Other services recognize the changes on a restart. If needed, you can force a restart by initiating anon-disruptive controller failover.

Synopsis

cert --help

cert --regen {ca|host}

Options



N/A--help

Adminis-trator

Force a regeneration of the hostcertificate if "host" is specified, orboth the host and Certificate Author-ity (CA) certificates if "ca" is spe-cified. This is used primarily to re-generate the associated keys.

{ca|host}--regen

Examples

This example regenerates the certificates for both the host and CA for the current array.

Nimble OS $ cert --regen ca


cert

chapuserThe chapuser command options manage Challenge-Response Handshake Authentication Protocol (CHAP)user accounts for Nimble arrays that use the iSCSI protocol. Arrays that use the Fibre Channel protocol donot require CHAP user accounts. CHAP users represent a method of access control for iSCSI initiators. EachCHAP user has a CHAP password, which is also called a CHAP secret. The CHAP passwords must be thesame on the array and the iSCSI initiator before the array can authenticate the iSCSI initiator and permitaccess. The CHAP user information must exist on both the array and the iSCSI initiator. Target authenticationprovides security only for a specific iSCSI target. Multiple iSCSI initiators can use the same CHAP secretwhen connecting or each iSCSI initiator can have its own. The CHAP user name cannot include certain specialcharacters.

Synopsis

chapuser --help

chapuser --list

chapuser --info user_name

chapuser --create user_name[--description text]--password password

chapuser --delete user_name[--force]

chapuser --edit user_name[--name new_name][--description text][--password password]

Options



N/A--help

OperatorList all existing CHAP users in anarray.

N/A--list

OperatorShow detailed information about aspecified CHAP user.

user_name--info


chapuser


OperatorUser name and shared passwordfor the CHAP user, who then getsassigned to an access control list(ACL)-associated volume. CHAPuser authentication requires aCHAP secret that agrees with thechallenge response. This valuemust be between 12 and 16 alpha-numeric characters, with no spacesor special characters, including ' "` ~ ! @ # $ ^ & ( ) + [ ] {} * ; : ' " . , |< > ? / \ = %

user_name --password password--create

Plain-text description of the CHAPuser. If there are spaces in the de-scription, enclose the text in quota-tion marks.

[--description text]

OperatorDelete the specified CHAP user. Itdeletes the CHAP user connectionfrom the iSCSI initiator. The CHAPuser cannot be deleted if there areany active CHAP connections un-less the --force option is used.

user_name--delete

Forcibly delete the specified CHAPuser even if that user has activeconnections. It disregards any ACLrecords that have been applied.

[--force]

OperatorModify the name of the specifiedCHAP user.

user_name [--name new_name]--edit

Modify the description of the spe-cified CHAP user. If there arespaces in the description, enclosethe text in quotation marks.

user_name [--description text]

Modify the shared password usedby the specified CHAP. This valuemust be between 12 and 16 alpha-numeric characters, with no spacesor special characters, including ' "` ~ ! @ # $ ^ & ( ) + [ ] {} * ; : ' " . , |< > ? / \ = %

user_name [--password password]

Examples

This example lists CHAP users in the array. In this example, two CHAP users exist.

Nimble OS $ chapuser --list------------------------------+--------------------------------------------CHAP User Name Password------------------------------+--------------------------------------------nimblechap nimblechapuserguestchap minimalaccess



This example shows information about a CHAP user named "nimblechap".

Nimble OS $ chapuser --info nimblechapName: nimblechapDescription: generic chap user for the nimble arrayPassword: nimblechapuserCreated: Dec 17 2010 12:50:25Last configuration change: Dec 17 2010 12:50:25

This example creates a CHAP user with the name "nimblestorage" and a valid password.

Nimble OS $ chapuser --create nimblestorage--description "nimble storage user" --password n1mblechapu5er

This example forcibly deletes a CHAP user named "storageuser".

Nimble OS $ chapuser --delete storageuser --force

This example modifies the name, description, and password for the CHAP user previously named "nimblechap".

Note If you change the name or password of a CHAP user, it invalidates logins. Update the hosts with thechange.

Nimble OS $ chapuser --edit nimblechap --name nimchap--description "nimble user" --password nimchapusr



ctrlrThe ctrlr command options display information about a controller on a Nimble array. Each array has an Aand B controller (case-sensitive identifiers). One controller is always active and the other always takes thestandby role. Controllers share IP addresses except for the support IP address. Each controller is alsoconfigured with the same set of NICs to provide redundancy in case of a failure. This configuration ensuresthat there is never a conflict during a failover. The IP addresses that are assigned to each NIC and interfaceremain the same. If a failover is triggered, then the new active controller has the same number of links to theswitch as was the case before a failover occurred.

Synopsis

ctrlr --help

ctrlr --list[--array array_name]

ctrlr --info controller_name[--array array_name]

Options



N/A--help

GuestList basic information about thecontrollers on the array where youare logged in.

--list

List basic information about allcontrollers on the specified array.

[--array array_name]

GuestList detailed information about thespecified controller. Valid controllernames are A and B, which are casesensitive.

controller_name--info

List detailed information about thespecified controller on the specifiedarray.


Examples

This example lists basic information about the controllers on an array named greyhound.

Nimble OS $ ctrlr --list --array greyhound----+----------+--------------------+----------------+--------+-------+--------Name State Hostname Support IP Power Fans Temper-

Supplies Status -ature

Status Status----+----------+--------------------+----------------+--------+-------+--------A standby greyhound-A 192.0.2.54 alerted OK OKB active greyhound-B 192.0.2.55 alerted OK OK


ctrlr

This example shows information about controller B on an array named greyhound.

Nimble OS $ ctrlr --info B --array greyhoundName: BSerial number: AC-102724-C2State: activeHostname: greyhound-BSupport IP address: 192.0.2.55Support IP netmask: 255.255.255.0Support IP nic: eth1Hostname:Power supply: alerted

power-supply1 at left rear: okpower-supply2 at right rear: missing

Cooling fans: OKfan1 at lower front of controller B: ok, speed: 10608rpmfan2 at lower left rear of controller B: ok, speed: 10608rpmfan3 at lower right rear of controller B: ok, speed: 10608rpmfan4 at upper right front of controller B: ok, speed: 8295rpmfan5 at upper left front of controller B: ok, speed: 8910rpmfan6 at upper left rear of controller B: ok, speed: 8520rpm

Temperature sensors: OKmotherboard at motherboard: ok, temperature: 22Cbp-temp2 at right-side backplane: ok, temperature: 34C

System partition status: OKLast AutoSupport contact: N/A



dateThe date command options display or modify the date and time of the array. If the array is connected to avalid NTP server IP address, then the time settings on the array synchronize with the time settings on theNTP server. In this case, do not modify the date locally. However, if the array is connected to an invalid NTPserver IP address, then the time settings on the array do not synchronize with the time settings on the NTPserver.

Synopsis

date --help

date[--utc][--edit {hh:mm[:ss]|'YYYY-MM-DD hh:mm[:ss]']

Options



N/A--help

GuestList the Coordinated UniversalTime on an array.

N/A--utc

PowerUser

Use --edit with care. Modify thedate and time on an array and dis-able the connection between thearray and a previously specifiedNTP server. If specified with --utc,modify Coordinated Universal Timeto the supplied argument.

{hh:mm[:ss]|'YYYY-MM-DDhh:mm[:ss]''

--edit

Examples

This example lists the date and time on an array as Pacific Daylight Time.

Nimble OS $ dateWed Jul 9 15:29:59 PDT 2014

This example lists the date and time on an array as Coordinated Universal Time.

Nimble OS $ date --utcWed Jul 9 22:29:37 UTC 2014

This example modifies the date and time on an array.

Nimble OS $ date --edit '2013-07-08 15:33:27'WARNING: Setting date manually disables the NTP server setting


date

diskThe disk command options manage disks on an array. An array supports hard disk drives (HDDs) and solidstate drives (SSDs). The size of the disk depends on the array model. Some HDDs are used to build theRAID and others can be spares that are used to replace failing drives. SSDs can only be active, and they arenot part of the RAID configuration.

When you remove a hard disk drive (HDD) from an array, it is either removed from the existing RAID orreplaced as a spare, depending on the state of the RAID. If you remove a solid state disk (SSD), it is removedfrom the existing cache capacity.

Synopsis

disk --help

disk --list[--array array_name][--shelf_location shelf_location]

disk --info slot[--array array_name][--shelf_location shelf_location]

disk --add slot[--array array_name]--shelf_location shelf_location[--force]

disk --remove slot[--array name]--shelf_locationshelf_location

Options



N/A--help

GuestList basic information about thedisks on an array, showing thetype, slot, serial number, size, diskstate, RAID status, shelf serialnumber, and shelf location foreach.

--list

List basic information about thedisks on the specified array. Spe-cify this option in a multi-arrayconfiguration. It is optional in asingle-array configuration.


List basic information about thedisks on the specified shelf. If thisoption is not specified, then alldisks on all shelves are listed.

[--shelf_location shelf_location]


disk


GuestList detailed information about thedisk at a specified slot number in asingle-array configuration.

slot--info

List detailed information about alldisks for a specified array in amulti- array configuration. Includethis option in a multi-array configur-ation. It is optional in a single-arrayconfiguration.


List detailed information about thedisk at the specified shelf location.If this option is not specified, thenonly disks for the head shelf A (A.0)or B (B.0) are listed.

[--shelf_location shelf_location]

PowerUser

Add a disk at the specified slot ona single-array configuration.

slot--add

Add a disk at the specified slot ona multi-array configuration. Includethis option in a multi-array configur-ation. It is optional in a single-arrayconfiguration.


Add a disk at the specified shelflocation on a specified array. Thisoption is mandatory.

--shelf_location shelf_location

Forcibly add the specified disk. Thisoption is mandatory if the disk toadd is in a foreign state.

[--force]

PowerUser

Remove a disk from the specifiedslot in a single-array configuration.

slot--remove

Remove a disk from the specifiedslot on a specified array in a multi-array configuration. Include thisoption in a multi-array configura-tion. It is optional in a single-arrayconfiguration.


Remove a disk from the specifiedslot on the specified shelf location.This option is mandatory.

--shelf_locationshelf_location

Examples

This example lists all disks on a standalone (single) array.

Nimble OS $ disk --list------+--------------------+----+---------+-------+--------+---------+-----Slot # Serial # Type Disk Size Disk RAID Shelf Shelf

(GB) State Status Serial Loca--tion

------+--------------------+----+---------+-------+--------+---------+-----



1 WD-WCAW32373319 HDD 1000.20 in use spare AA-100257 A.02 WD-WCAW30555873 HDD 1000.20 in use okay AA-100257 A.03 WD-WMAW30010098 HDD 1000.20 in use okay AA-100257 A.04 WD-WCAW30549295 HDD 1000.20 in use okay AA-100257 A.05 N/A N/A N/A void N/A AA-100257 A.06 N/A N/A N/A void N/A AA-100257 A.07 N/A N/A N/A void N/A AA-100257 A.08 CVPO040402ZP080JGN SSD 80.03 in use N/A AA-100257 A.09 CVPO04030150080JGN SSD 80.03 in use N/A AA-100257 A.010 N/A N/A N/A void N/A AA-100257 A.011 N/A N/A N/A void N/A AA-100257 A.012 N/A N/A N/A void N/A AA-100257 A.013 WD-WCAW30597086 HDD 1000.20 in use okay AA-100257 A.014 WD-WCAW30606284 HDD 1000.20 in use okay AA-100257 A.015 WD-WCAW30606703 HDD 1000.20 in use okay AA-100257 A.016 WD-WCAW30527176 HDD 1000.20 in use okay AA-100257 A.01 CVPR208103WZ600FGN SSD 600.13 in use N/A AC-100182 A.12 Z29036W600009136H45Q HDD 3000.59 in use okay AC-100182 A.13 Z290LRCK00009136H440 HDD 3000.59 in use spare AC-100182 A.14 9XK0H5N600009135E6GN HDD 3000.59 in use okay AC-100182 A.15 9XK06BFJ0000S111K944 HDD 3000.59 in use okay AC-100182 A.16 Z290LAW80000S110DX86 HDD 3000.59 in use okay AC-100182 A.17 Z290372V0000914024J2 HDD 3000.59 in use okay AC-100182 A.18 9XK0KBZ400009131N1NV HDD 3000.59 in use okay AC-100182 A.19 Z2909KED00009133BHZ5 HDD 3000.59 in use okay AC-100182 A.110 Z290KYG600009138MTYB HDD 3000.59 in use okay AC-100182 A.111 Z290LNP9000091380XUM HDD 3000.59 in use okay AC-100182 A.112 9XK06NF00000S111K9X6 HDD 3000.59 in use okay AC-100182 A.113 9XK07TQN0000S112MQAQ HDD 3000.59 in use okay AC-100182 A.114 9XK06B6G0000S111K9MH HDD 3000.59 in use okay AC-100182 A.115 9XK06AYR0000S110UGRY HDD 3000.59 in use okay AC-100182 A.116 9XK06NEP0000S110UGCD HDD 3000.59 in use okay AC-100182 A.1

This example lists only the disks on the specified shelf.

Nimble OS $ disk --list --shelf_location A.0------+--------------------+----+---------+-------+--------+---------+-----Slot # Serial # Type Disk Size Disk RAID Shelf Shelf


------+--------------------+----+---------+-------+--------+---------+-----1 WD-WCAW32373319 HDD 1000.20 in use spare AA-100257 A.02 WD-WCAW30555873 HDD 1000.20 in use okay AA-100257 A.03 WD-WMAW30010098 HDD 1000.20 in use okay AA-100257 A.04 WD-WCAW30549295 HDD 1000.20 in use okay AA-100257 A.05 N/A N/A N/A void N/A AA-100257 A.06 N/A N/A N/A void N/A AA-100257 A.07 N/A N/A N/A void N/A AA-100257 A.08 CVPO040402ZP080JGN SSD 80.03 in use N/A AA-100257 A.09 CVPO04030150080JGN SSD 80.03 in use N/A AA-100257 A.010 N/A N/A N/A void N/A AA-100257 A.011 N/A N/A N/A void N/A AA-100257 A.012 N/A N/A N/A void N/A AA-100257 A.013 WD-WCAW30597086 HDD 1000.20 in use okay AA-100257 A.014 WD-WCAW30606284 HDD 1000.20 in use okay AA-100257 A.015 WD-WCAW30606703 HDD 1000.20 in use okay AA-100257 A.016 WD-WCAW30527176 HDD 1000.20 in use okay AA-100257 A.0

This example shows information about the hard disk drive in slot 1 in a single-array configuration. The outputis truncated to avoid line wrapping.



Nimble OS $ disk --info 1Shelf location #: A.0Slot #: 1HBA: 0Port: 15Serial: WD-WCAW32373319Type: HDDDisk size: 1000.2 GBDisk state: in useRaid state: sparePercent resynchronized: N/ACurrent resync speed: N/AAverage resync speed: N/AModel: WDC WD1003FBYX-0Vendor: NimbleFirmware version: 1V01Smart Data Attributes:Raw read error rate(value/trough/threshold/raw/updated): 200/200/51/5/Ju...Spin up time(value/trough/threshold/raw/updated): 174/172/21/4291/Jul 15...Start stop count(value/trough/threshold/raw/updated): 100/100/0/393/Jul ...Reallocated sector count(value/trough/threshold/raw/updated): 200/200/1 ...Seek error rate(value/trough/threshold/raw/updated): 200/200/0/0/Jul 15 ...Power on hours(value/trough/threshold/raw/updated): 91/91/0/6890/Jul 15 ...Power cycle count(value/trough/threshold/raw/updated): 100/100/0/392/Jul...Power off retract count(value/trough/threshold/raw/updated): 200/200/0/3...Temperature C(value/trough/threshold/raw/updated): 116/99/0/31/Jul 15 20...Current pending sector(value/trough/threshold/raw/updated): 200/200/0/0/...Offline uncorrectable(value/trough/threshold/raw/updated): 200/200/0/0/ ...UDMA CRC error count(value/trough/threshold/raw/updated): 200/200/0/0/Ju...

This example shows information about the disk in slot 1. Because the --shelf_location option is specified inthis example, only the disks that are located in slot 1 at the specified shelf location are listed. The output istruncated to avoid line wrapping.

Nimble OS $ disk --info 1 --shelf_location A.1Shelf location #: A.1Slot #: 1HBA: 0Port: 15Serial: CVPR208103WZ600FGNType: SSDDisk size: 600.127 GBDisk state: in useRaid state: N/APercent resynchronized: N/ACurrent resync speed: N/AAverage resync speed: N/AModel: INTEL SSDSA2CW60Vendor: NimbleFirmware version: 0362Smart Data Attributes:Spin up time(value/trough/threshold/raw/updated): 100/100/0/0/Jul 15 201...Start stop count(value/trough/threshold/raw/updated): 100/100/0/0/Jul 15...Reallocated sector count(value/trough/threshold/raw/updated): 100/100/0/...Power on hours(value/trough/threshold/raw/updated): 100/100/0/10495/Jul ...Power cycle count(value/trough/threshold/raw/updated): 100/100/0/27/Jul ...Power off retract count(value/trough/threshold/raw/updated): 100/100/0/2...Host write count(value/trough/threshold/raw/updated): 100/100/0/344912/J...Available reserved space(value/trough/threshold/raw/updated): 100/100/10...Media wearout indicator(value/trough/threshold/raw/updated): 99/99/0/0/J...



This example adds a disk to slot 13 at the specified shelf location A.0 and verifies the change in a single-arrayconfiguration. The disk resynchronizes with the rest of the array. The --shelf_location option is mandatory inthis example.

Nimble OS $ disk --add 13 --shelf_locationA.0Nimble OS $ disk --list------+--------------------+----+---------+-------+--------+---------+-----Slot # Serial # Type Disk Size Disk RAID Shelf Shelf


------+--------------------+----+---------+-------+--------+---------+-----1 WD-WCAW32373319 HDD 1000.20 in use okay AA-100257 A.02 WD-WCAW30555873 HDD 1000.20 in use okay AA-100257 A.03 WD-WMAW30010098 HDD 1000.20 in use okay AA-100257 A.04 WD-WCAW30549295 HDD 1000.20 in use okay AA-100257 A.05 N/A N/A N/A void N/A AA-100257 A.06 N/A N/A N/A void N/A AA-100257 A.07 N/A N/A N/A void N/A AA-100257 A.08 CVPO040402ZP080JGN SSD 80.03 in use N/A AA-100257 A.09 CVPO04030150080JGN SSD 80.03 in use N/A AA-100257 A.010 N/A N/A N/A void N/A AA-100257 A.011 N/A N/A N/A void N/A AA-100257 A.012 N/A N/A N/A void N/A AA-100257 A.013 WD-WCAW30597086 HDD 1000.20 in use spare AA-100257 A.014 WD-WCAW30606284 HDD 1000.20 in use okay AA-100257 A.015 WD-WCAW30606703 HDD 1000.20 in use okay AA-100257 A.016 WD-WCAW30527176 HDD 1000.20 in use okay AA-100257 A.0

This example removes a disk from slot 13 at the specified shelf location A.0 and verifies the change in asingle-array configuration. The --shelf_location option is mandatory in this example.

Nimble OS $ disk --remove 13 --shelf_locationA.0Nimble OS $ disk --list------+--------------------+----+---------+-------+------------------+-----Slot # Serial # Type Disk Size Disk RAID Shelf Shelf


------+--------------------+----+---------+-------+--------+---------+-----1 WD-WCAW32373319 HDD 1000.20 in use resynch AA-100257 A.02 WD-WCAW30555873 HDD 1000.20 in use okay AA-100257 A.03 WD-WMAW30010098 HDD 1000.20 in use okay AA-100257 A.04 WD-WCAW30549295 HDD 1000.20 in use okay AA-100257 A.05 N/A N/A N/A void N/A AA-100257 A.06 N/A N/A N/A void N/A AA-100257 A.07 N/A N/A N/A void N/A AA-100257 A.08 CVPO040402ZP080JGN SSD 80.03 in use N/A AA-100257 A.09 CVPO04030150080JGN SSD 80.03 in use N/A AA-100257 A.010 N/A N/A N/A void N/A AA-100257 A.011 N/A N/A N/A void N/A AA-100257 A.012 N/A N/A N/A void N/A AA-100257 A.013 WD-WCAW30597086 HDD 1000.20 removed N/A AA-100257 A.014 WD-WCAW30606284 HDD 1000.20 in use okay AA-100257 A.015 WD-WCAW30606703 HDD 1000.20 in use okay AA-100257 A.016 WD-WCAW30527176 HDD 1000.20 in use okay AA-100257 A.01 CVPR208103WZ600FGN SSD 600.13 in use N/A AC-100182 A.12 Z29036W600009136H45Q HDD 3000.59 in use okay AC-100182 A.13 Z290LRCK00009136H440 HDD 3000.59 in use spare AC-100182 A.14 9XK0H5N600009135E6GN HDD 3000.59 in use okay AC-100182 A.15 9XK06BFJ0000S111K944 HDD 3000.59 in use okay AC-100182 A.16 Z290LAW80000S110DX86 HDD 3000.59 in use okay AC-100182 A.17 Z290372V0000914024J2 HDD 3000.59 in use okay AC-100182 A.18 9XK0KBZ400009131N1NV HDD 3000.59 in use okay AC-100182 A.1



9 Z2909KED00009133BHZ5 HDD 3000.59 in use okay AC-100182 A.110 Z290KYG600009138MTYB HDD 3000.59 in use okay AC-100182 A.111 Z290LNP9000091380XUM HDD 3000.59 in use okay AC-100182 A.112 9XK06NF00000S111K9X6 HDD 3000.59 in use okay AC-100182 A.113 9XK07TQN0000S112MQAQ HDD 3000.59 in use okay AC-100182 A.114 9XK06B6G0000S111K9MH HDD 3000.59 in use okay AC-100182 A.115 9XK06AYR0000S110UGRY HDD 3000.59 in use okay AC-100182 A.116 9XK06NEP0000S110UGCD HDD 3000.59 in use okay AC-100182 A.1



encryptkeyThe encryptkey command options manage the encryption master key and its associated passphrase.

The master key is protected by a passphrase and is used to encrypt the keys that are used to encrypt volumedata. This command provides options to create, enable, disable, and delete the master key, and to changethe passphrase that is used to protect the master key.

After creating the master key, it can be in two possible states: active and inactive. In the active state, themaster key is available to unlock the keys that are used to encrypt volume data. When inactive, the masterkey is not available, and access to encrypted data is not possible. To change the state of the master key frominactive to active, use --enable_master and enter the passphrase.

Note No characters appear on the screen as you type the passphrase for any of the encryptkey commandoptions. Not even asterisks show an obfuscated value.

Synopsis

encryptkey --help

encryptkey --info

encryptkey --create_master

encryptkey --enable_master

encryptkey --disable_master

encryptkey --delete_master

encryptkey --change_passphrase

Options



N/A--help

OperatorDisplay the status of the masterkey. Initialized is true only if themaster key has been created. Act-ive is true only if the master keyhas been unlocked using thepassphrase and is available foruse.

N/A--info

Adminis-trator

Create the passphrase-encryptedmaster key. You must interactivelyspecify and confirm the pass-phrase. The passphrase value canbe any printable characters, and itslength must be between 8 and 64characters, inclusive.

The group encryption_scope is setto group and the group encryp-tion_cipher is set to aes-256-xts.

N/A--create_master


encryptkey


OperatorActivate, or enable, the master key.You must interactively specify thepassphrase.

N/A--enable_master

Adminis-trator

Force the master key into the inact-ive state. You must interactivelyspecify the passphrase.

Note You can still take snapshotsof encrypted volumes after dis-abling the master key.

N/A--disable_master

Adminis-trator

Delete the master key. You can dothis only if no encrypted volumesexist.

Deleting the master key is the onlyway to turn off the encryption fea-ture if, for example, the passphraseis lost.

N/A--delete_master

Adminis-trator

Change the master key pass-phrase. You must interactivelyspecify the old passphrase andthen specify and confirm the newpassphrase.

N/A--change_passphrase

Examples

This example identifies that encryption is uninitialized and inactive on the Nimble Storage group.

Nimble OS $ encryptkey --infoInitialized: NoActive: No

This example shows detailed information about a Nimble Storage group where encryption is enabled (initializedand active).

Nimble OS $ encryptkey --infoInitialized: YesActive: Yes

Note If you disable the master key by using the --disable_master option, then encryption is inactive in the--info output.

This example creates the master key and specifies its passphrase interactively. This command also enablesthe master key.

Nimble OS $ encryptkey --create_masterEnter new passphrase:Retype new passphrase:

This example reenables the master key after the --disable_master option is used.

Nimble OS $ encryptkey --enable_masterEnter passphrase:



This example disables the master key after creating it. Encrypted volumes go offline and are inoperative untilyou enable the master key. If you have volumes that are not encrypted, then those volumes are still accessible.The --disable_master capability is provided only through the CLI, not the GUI.

Nimble OS $ encryptkey --disable_masterEnter passphrase:

This example deletes the master key. This allows recovering a system where the passphrase has been lost.If this happens, any encrypted volumes are permanently inaccessible, and they must be deleted before thisoperation will succeed. The --delete_master capability is provided only through the CLI, not the GUI.

Nimble OS $ encryptkey --delete_master

This example changes the passphrase for the master key interactively. There is no indication of successfulcompletion. If you type an incorrect value for the current passphrase, or if you type and confirm values thatdo not match for the new passphrase, then an error identifies the issue.

Nimble OS $ encryptkey --change_passphraseEnter passphrase:Enter new passphrase:Retype new passphrase:



failoverThe failover command options perform a controller failover on an array. The active controller restarts andassigns the active role to the standby controller.

Synopsis

failover --help

failover[--array array_name][--force][--non_interactive]

Options



N/A--help

PowerUser

Perform a controller failover on thespecified array, which must berunning in redundant controllermode (active/standby). You mustspecify the --array array_name op-tion in a multi-array configuration.Specifying this option is not re-quired in a single-array configura-tion.

array_name--array

Forcibly fail over the controllers onan array even if the validationchecks that the system runs beforeinitiating the failover fail.

N/A[--force]

Override the default behavior ofhaving to type "yes" to completethe command. Use this suboptionwith care to avoid unexpectedlytaking the array offline.

N/A[--non_interactive]

Examples

This example forces a failover of a controller in a single-array configuration.

Nimble OS $ failoverWARNING: This operation will fail over the array.Type yes to continue, no to cancel: yesINFO: Initiated controller failover.

This example forces a failover of a controller named greyhound in a multi-array configuration.

Nimble OS $ failover --array greyhoundWARNING: This operation will fail over the array.Type yes to continue, no to cancel: yesINFO: Initiated controller failover.


failover

fcThe fc command options manage Fibre Channel interfaces on a Nimble CS300, CS500, or CS700 array.

The Nimble CS200 and CS400 series arrays do not support Fibre Channel host bus adapters (HBAs).

Synopsis

fc --help

fc --list[--array {name|serial_number}]

fc --info interface_name[--array {name|serial_number}][--ctrlr {A|B}]

fc --edit interface_name[--array {name|serial_number}][--ctrlr {A|B}]--admin_state {online|offline}[--force]

fc --update_config

fc --regenerate_wwn wwnn_base[--non_interactive]

Options



N/A--help

GuestList all discovered Fibre Channelinterfaces for arrays in the group.

--list

List all discovered Fibre Channelinterfaces on the specified array.

[--array {name|serial_number}]

GuestShow detailed information aboutthe specified Fibre Channel inter-face.

interface_name--info

Show detailed information about aFibre Channel interface on a spe-cified array. Provide the array nameor serial number.

[--array {name|serial_number}]

Show detailed information about aFibre Channel interface on a spe-cified controller. Valid controllernames are A and B, which are casesensitive.

[--ctrlr {A|B}]


fc


PowerUser

Modify the specified Fibre Channelinterface.

interface_name--edit

Modify a Fibre Channel interfaceon the specified array.

[--array {name|serial_number}

Modify a Fibre Channel interfaceon the specified controller. Validcontroller names are A and B,which are case sensitive.

[--ctrlr {A|B}]

Set the specified Fibre Channel in-terface to be online or offline. If youspecify offline and initiators areconnected to the interface, thenyou must also use the --force op-tion.

--admin_state {online|offline}

Forcibly set the administrative stateof the specified Fiber Channel inter-face.

[--force]

PowerUser

Run fc --update_config only if in-structed to do so by Nimble Stor-age Support. Update the FibreChannel configuration based onthe current hardware configurationafter a hardware upgrade or down-grade on both controllers of aNimble array.

N/A--update_config

PowerUser

Regenerate the World Wide NodeName (WWNN) and all World WidePort Names (WWPNs) of FibreChannel interfaces in the group toset the non-fixed bits of the WWNNto the specified wwnn_base. Thevalue is six hex digits between00:00:01 and FF:FF:FF, inclusive.

wwnn_base--regenerate_wwn

Override the default behavior ofhaving to type "yes" to completethe command.

[--non_interactive]

Examples

This example lists the Fibre Channel Interfaces on a CS300 array named greyhound. The output is truncatedto avoid line wraps.

Nimble OS $ fc --list --arraygreyhoundArray: greyhound------+-----+-----+------+----+------------------------+----------------------Name Ctrlr Admin Fabric Link WWNN WWPN

Status------+-----+-----+------+----+------------------------+----------------------fc5.1 A online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:01fc6.1 A online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:02



fc5.1 B online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:03fc6.1 B online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:04

This example shows information about the fc5.1 Fibre Channel interface on controller A of an array namedgreyhound.

Nimble OS $ fc --info fc5.1--controller AName: fc5.1Array: greyhoundController: AAdmin Status: onlineLink Status: upOperational Status: operationalFabric Logged In: yesLink Speed: 16GMax Link Speed: 16GWWNN: 56:c9:ce:90:ad:d6:3a:00WWPN: 56:c9:ce:90:ad:d6:3a:01FC-ID: 0x012800PCI bus ID: 0000:84:00.0HBA port: 0HBA slot: 2Firmware version: 1.1.65.5Fabric switch name: MY-FC1Fabric switch port: 40Fabric switch WWNN: 10:00:50:eb:1a:01:09:00Fabric switch WWPN: 20:28:50:eb:1a:01:09:00Fabric WWN: 10:00:50:eb:1a:01:09:00Connected Initiators:------------------+-----------------------+-----------------------Alias WWNN WWPN------------------+-----------------------+-----------------------c22_esx1_hba1 20:00:00:90:fa:53:a0:a0 10:00:00:90:fa:53:a0:a0c22_esx1_hba2 20:00:00:90:fa:53:a0:a1 10:00:00:90:fa:53:a0:a1c22_win7_port0 20:00:00:90:fa:53:9f:08 10:00:00:90:fa:53:9f:08c22_win7_port1 20:00:00:90:fa:53:9f:09 10:00:00:90:fa:53:9f:09c22win8hba1 20:00:00:90:fa:53:43:8c 10:00:00:90:fa:53:43:8cc22win8hba2 20:00:00:90:fa:53:43:8d 10:00:00:90:fa:53:43:8dc23_esx2_hba1 20:00:00:90:fa:53:a2:80 10:00:00:90:fa:53:a2:80c23_esx2_hba2 20:00:00:90:fa:53:a2:81 10:00:00:90:fa:53:a2:81c23_esx3_hba2 20:00:00:0e:1e:19:5e:a0 21:00:00:0e:1e:19:5e:a0c23_esx3_hba3 20:00:00:0e:1e:19:5e:a1 21:00:00:0e:1e:19:5e:a1

This example sets the fc5.1 Fibre Channel interface on controller A to be offline.

Nimble OS $ fc --edit fc5.1--controller A --admin_stateoffline --force

This example updates the Fibre Channel configuration upon the advice of Nimble Storage Support afterperforming a hardware upgrade or downgrade (adding or removing Fibre Channel HBAs) on both controllersof a Nimble array.

Nimble OS $ fc --update_config

This example allows Fibre Channel zoning to be configured before the Nimble array you purchased arriveson site. Follow these steps:

1 Read this fc command section to review the process to follow.



2 Plan zoning for the Nimble array you purchased, with the understanding that you can change thewwnn_base value after you set up the array.

3 In a standard maintenance window, configure zoning for the Nimble array on the Fibre Channel switches.4 When the Nimble array arrives on site, install and set up the array by following the instructions in the

Nimble Storage Installation Guide. This step applies unique system-assigned WWNN and WWPN values,which you will modify later in this procedure.

5 Complete the commands in the following example, using values that are appropriate for your environment.

The example shows the remaining steps in the process on a Nimble array named greyhound, where theinterfaces are named fc5.1 and fc6.1.


Status------+-----+-----+------+----+------------------------+----------------------fc5.1 A online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:01fc6.1 A online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:02fc5.1 B online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:03fc6.1 B online yes 16G 56:c9:ce:90:ad:d6:3a:00 56:c9:ce:90:ad:d6:3a:04

Nimble OS $ fc --edit fc5.1 --ctrlr A --admin_state offline

Nimble OS $ fc --edit fc6.1 --ctrlr A --admin_state offline

Nimble OS $ fc --edit fc5.1 --ctrlr B --admin_state offline

Nimble OS $ fc --edit fc6.1 --ctrlr B --admin_state offline

Nimble OS $ fc --list --arraygreyhound......Nimble OS $ fc --regenerate_wwn 12:34:56--non_interactive


Status------+-----+-----+------+----+------------------------+----------------------fc5.1 A online yes 16G 56:c9:ce:90:12:34:56:00 56:c9:ce:90:12:34:56:01fc6.1 A online yes 16G 56:c9:ce:90:12:34:56:00 56:c9:ce:90:12:34:56:02fc5.1 B online yes 16G 56:c9:ce:90:12:34:56:00 56:c9:ce:90:12:34:56:03fc6.1 B online yes 16G 56:c9:ce:90:12:34:56:00 56:c9:ce:90:12:34:56:04

In this example, because 12:34:56 is specified as the wwnn_base value, the WWNN is changed from56:c9:ce:90:ad:d6:3a:00 to 56:c9:ce:90:12:34:56:00 and the first WWPN is set to 56:c9:ce:90:12:34:56:01.The WWPNs are numbered in order from the lowest interface to the highest interface, starting first withcontroller A and then controller B, as shown in the final fc --list output in the prior command examples. Thecommand with the --regenerate_wwn option brings the Fibre Channel interfaces back online automatically.



groupThe group command options manage groups.

Synopsis

group --help

group --list

group --info

group --edit[--name name][--dnsserver server][--ntpserver server][--domainname domain_name][--autosupport {yes|no}][--support_tunnel {yes|no}][--smtp_server smtp_server][--smtp_port smtp_port][--smtp_auth {yes|no}][--smtp_username username][--smtp_encrypt_type {none|starttls|ssl}][--smtp_from_addr email_addr][--smtp_to_addr email_addr][--send_event_data {yes|no}][--alert_level {info|warning|critical}][--proxyserver server][--proxyport port][--proxyuser username][--proxypasswd password][--default_vol_reserve percent][--default_vol_quota percent][--default_vol_warn {percent|mb}][--default_snap_reserve percent][--default_snap_quota percent][--default_snap_warn {percent|mb}][--isns_enable {yes|no}][--isns_server isns_server][--isns_port isns_port][--snmp_trap_enabled {yes|no}][--snmp_trap_host snmp_trap_hostname][--snmp_trap_port snmp_trap_port][--snmp_get_enabled {yes|no}][--snmp_community snmp_community][--snmp_get_port snmp_get_port][--snmp_sys_location snmp_sys_location][--snmp_sys_contact snmp_sys_contact][--syslog_enabled {yes|no}][--syslog_server syslog_server][--syslog_port syslog_port][--encryption_cipher {aes-256-xts|none}][--encryption_scope {group|volume}]


group

[--encryption_mode {available|secure}][--inactivity_timeout minutes]

group --create_throttle[--description text][--days days][--at time][--until time][--bandwidth megabits]

group --delete_throttle id

group --edit_throttle id[--description text][--days days][--at time][--until time][--bandwidth megabits]

group --autosupport_validate

group --autosupport_initiate

group --merge_validate group_name[--username user_name]--password password[--passphrase]

group --merge group_name[--username user_name]--password password[--passphrase]

group --unset_http_proxy

group --list_limits

Options



N/A--help

GuestList groups that share the samesubnet with the current group.

N/A--list

GuestProvide detailed information aboutthe current group.

N/A--info




PowerUser

Modify the name of a group. Youmust include this option in a multi-array configuration. If you includethis option in a single-array config-uration, you modify the group nameto the specified name value.

[--name name]--edit

Modify the IP address of the DNSserver that is in use. Repeat thisoption to specify IP addresses formultiple DNS servers.

[--dnsserver server]

Modify the hostname or IP addressfor the NTP server that is used bya group.

[--ntpserver server]

Modify the DNS domain name thatis used by a group.

[--domainname server]

Enable or disable automaticallysending AutoSupport data to theNimble Storage Support team.

[--autosupport {yes|no}]

Enable or disable Nimble StorageSupport to establish a secure con-nection to the group to gather dia-gnostic data.

[--support_tunnel {yes|no}]

Modify the hostname or IP addressof an SMTP server that the groupuses to send email alerts and eventdata to specified recipients.

[smtp_server smtp_server]

Modify the SMTP port number touse. Default: 25. You must also in-clude the --smtp_server optionwhen you modify the port number.

[--smtp_port smtp_port]

Enable or disable SMTP authentic-ation. Default: no (disable). If youenable SMPT encryption, then youmust also enable SMTP authentic-ation.

[--smtp_auth {yes|no}]

Modify the SMTP authenticationusername and password. Theusername value must start with analphabetic character and can be upto 64 alphanumeric characters.When prompted, interactively spe-cify a password for the SMTP ac-count. The password value can beblank or it can be up to 255 print-able characters. You can repeatthe prior password value.

[--smtp_username username]

[--smtp_encrypt_type{none|starttls|ssl}]




Modify the level of encryption forSMTP. Default: none. Requiresusing SMTP authentication whenencryption is enabled by specifyinga value of starttls (start transportlayer security) or ssl (secure sock-ets layer). The starttls type can bean appropriate choice if you imple-mented cloud-based email. The ssltype can be an appropriate choiceif you have a secure SMTP serverinstalled on your network.

Modify the email address fromwhich the group sends alerts andevent data. It does not have to bea valid email address, but it musthave a valid email address format.Include the group name for easyidentification and filtering.

[--smtp_from_addr email_addr]

Modify one or more email ad-dresses for alert and event recipi-ents. Repeat this option to specifyas many TO email addresses asneeded.

[--smtp_to_addr email_addr]

Enable or disable sending eventdata to the Nimble Storage Supportteam. Default: yes (enabled). Whenenabled, you do not need toprovide contact details for NimbleStorage Support.

[--send_event_data {yes|no}]

Specify the minimum level at whichalerts are triggered.

[--alert_level {info|warning|critical}]

Modify the hostname or IP addressof the HTTP proxy server. If noproxy server is specified, a directHTTP connection is established.The array uses the HTTP protocolto download software updates andpost event data.

[--proxyserver server]

Modify the port number that theHTTP server uses.

[--proxyport port]

Modify the username of the HTTPproxy server.

[--proxyuser username]

Modify the password that the HTTPproxy server uses.

[--proxypasswd password]

Modify the percentage that is usedas the default value for reservespace when you create a volumefor a group.

[--default_vol_reserve percent]




[--default_vol_quota percent] Modify the percentage that is usedas the default value for the volumequota when you create a volumefor a group.

Modify the default value that trig-gers sending an alert when theavailable space of a volume re-serve reaches this threshold. Thisvalue is used to set the defaultvalue on a newly created volume.

[--default_vol_warn {percent|mb}]

Modify the percentage that is usedas the default value for any reservespace when you create a snapshoton a volume.

[--default_snap_reserve percent]

Modify the percentage that is usedas the default value for snapshotreserve space when you create avolume.

[--default_snap_quota percent]

Modify the default value at whichan alert is sent when the availablespace of the snapshot reservereaches this threshold. This valueis used to set the default value ona newly created volume.

[--default_snap_warn {percent|mb}]

Enable or disable the InternetStorage Name Service (iSNS)management services for thegroup. The iSNS settings do notapply to Fibre Channel arrays.

[--isns_enable {yes|no}]

Specify the iSNS server that isused to publish iSCSI endpoints.

[--isns_server isns_server]

Modify the iSNS server port num-ber.

[--isns_port isns_port]

Enable or disable SNMP traps.[--snmp_trap_enabled {yes|no}]

Modify the hostname of the SNMPtrap destination. Only one SNMPtrap is currently available.

[--snmp_trap_host snmp_trap_host-name]

Modify the port number of the SN-MP trap destination. The defaultdestination port is 162.

[--snmp_trap_port snmp_trap_port]

Enable or disable SNMP Gets.[--snmp_get_enabled {yes|no}]

[--snmp_community snmp_com-munity]




Modify the name of the SNMPcommunity. The default communityis public. You can use alphanumer-ic characters and the - (hyphen), :(colon), and . (period) specialcharacters. The name must startwith an alphanumeric character andcan be up to 64 characters.

Modify the SNMP responder portnumber. The default get port num-ber is 161.

[--snmp_get_port snmp_get_port]

Modify the SNMP system locationthat is used to respond to SNMPv2-MIB::sysLocation.

[--snmp_sys_location sn-mp_sys_location]

Modify the SNMP system contactthat is used to respond to SNMPv2-MIB::sysContact.

[--snmp_sys_contact sn-mp_sys_contact]

Enable or disable sending syslogmessages from the Nimble groupto a remote syslog server. Default:no (syslog is disabled).

[--syslog_enabled {yes|no}]

Specify the remote syslog serverthat receives syslog messagesfrom the Nimble group.

[--syslog_server syslog_server]

Modify the remote syslog serverport number. Default: 514. Validvalues: 1 through 65535, inclusive.

[--syslog_port syslog_port]

Specify the default cipher to useduring encryption. A value of"none" indicates no encryption. Avalue of "aes-256-xts" indicates theuse of the AES-256-XTS cipher.

[--encryption_cipher {aes-256-xts|none}]

Specify whether the default encryp-tion_cipher setting can be overrid-den when creating a new volume,or is forced to be used. A value of"group" indicates that the value isapplied across the entire group andcannot be changed. A value of"volume" means that the settingcan be overridden at volume cre-ation time.

[--encryption_scope{group|volume}]

Specify whether the master keypassphrase must be entered onarray startup ("secure" mode) toaccess encrypted volumes, orwhether the array remembers themaster key across a restart ("avail-able" mode).

[--encryption_mode {available|se-cure}]




Set the number of minutes thatmust pass without any user activitybefore a timeout occurs and usersare logged out.

[--inactivity_timeout minutes]

PowerUser

Create a group-wide bandwidththrottle for replication. Throttles atthe group level limit the total replic-ation bandwidth across all down-stream partners. The system auto-matically assigns an ID to thethrottle schedule.

Specify at least one suboption.--create_throttle

Describe the bandwidth throttle. Ifthe description includes spaces,enclose the description text inquotation marks.


Specify the days of the week forwhich the bandwidth throttle is ef-fective. Separate the values withcommas. For example:

Mon,Tue,Thu

Specify the value all to indicate alldays of the week (the default).

[--days {all | days}]

Specify the time of day at which thebandwidth throttle is activated.

[--at time]

Specify the time of day at which thebandwidth throttle is deactivated.

[--until time]

Specify the maximum bandwidthto use for replication, expressed inmegabits per second. Use 0 (zero)to stop replication traffic or unlim-ited to turn off throttling.

[--bandwidth megabits]

PowerUser

Delete the specified bandwidththrottle for replication. The ID isassigned by the system. Usegroup --info to view all throttleswith their IDs.

id--delete_throttle




PowerUser

Modify the specified bandwidththrottle for replication. Use group--info to determine the throttle ID.Specify at least one suboption.

id--edit_throttle

Modify the description of the band-width throttle. If the description in-cludes spaces, enclose the descrip-tion text in quotation marks.


Modify the days of the week forwhich the bandwidth throttle is ef-fective. Separate the values withcommas. For example:

Mon,Tue,Thu

Specify the value all to indicate alldays of the week (the default).

[--days {all | days}]

Modify the time of day at which thebandwidth throttle is activated.

[--at time]

Modify the time of day at which thebandwidth throttle is deactivated.

[--until time]

Modify the maximum bandwidth touse for replication, expressed inmegabits per second. Use 0 (zero)to stop replication traffic or unlim-ited to turn off throttling.

[--bandwidth megabits]

PowerUser

Validate the AutoSupport configur-ation for a group.

N/A--autosupport_validate

PowerUser

Immediately send event informationfrom the group to the Nimble Stor-age Support team. You can usethis option in addition to configuringperiodic AutoSupport messages byusing the --edit --autosupport yesoption.

N/A--autosupport_initiate




Adminis-trator

Validate the configuration of thespecified group to merge it with thecurrent group. This operationchecks group objects for conflicts.If conflicts occur, then the informa-tion is listed so that you can resolvethe conflicts before merging thegroups.

group_name--merge_validate

Specify the administrative user-name associated with the group tovalidate before merging with thisgroup. The default value is admin.

[--username user_name]

Specify the administrative pass-word associated with the group tovalidate before merging with thisgroup.

--password password

If encryption is enabled on thegroup that is the source of themerge being validated, specify theencryption passphrase for thesource group.

[--passphrase]

Adminis-trator

Merge the specified group of iSCSIarrays into the current group ofiSCSI arrays. Use group--merge_validate to check for con-flicts before merging two groups.After the groups are merged, allarrays from the merged group areplaced in a new pool in the currentgroup. Administer the arrays andvolumes from this group. Merginggroups of Fibre Channel arrays iscurrently not supported.

group_name--merge

Specify the administrative user-name associated with the group tomerge with this group. The defaultvalue is admin.

[--username user_name]

Specify the administrative pass-word associated with the group tomerge with this group.

--password password

If encryption is enabled on thegroup that is the source of themerge, specify the encryptionpassphrase for the source group.

[--passphrase]

PowerUser

Remove HTTP proxy server set-tings from the current group. After-wards, the group no longer usesan HTTP proxy to connect to theNimble Storage Support team.

N/A--unset_http_proxy




GuestList the current count, maximumlimit, and warning threshold forseveral group criteria, as well asscope, if applicable.

N/A--list_limits

Examples

This example lists the groups on a shared subnet.

Nimble OS $ group --list------------------------------+----------------+--------------------------------Name Mgmt IP Address Version------------------------------+----------------+--------------------------------group-array7 192.0.2.83 2.3.1.0-234720-optgroup-array8 192.0.2.86 2.3.1.0-234720-optgroup-array3 192.0.2.59 2.3.1.0-234619-optgroup-array5 192.0.2.77 2.2.3.0-155034-optspark 192.0.2.80 2.2.6.0-229590-optINFO: Only groups that share a subnet with this group (group-array2) arediscovered.

This example shows detailed information about the group that the array where you are logged in to the CLIis a member. The output is truncated to save space.

Nimble OS $ group --infoGroup name: group-array2Group Management IP: 192.0.2.51/255.255.255.0Group Discovery IP: 172.18.120.55/255.255.255.0Group leader array: array2Member array(s): array2Unreachable member array(s):Version: 2.3.1.0-234720-optNTP server: time.nimblestorage.comTimezone: America/Los_AngelesSMTP server:SMTP port: 25SMTP authentication: NoSMTP username:SMTP password: (on file if set)SMTP encryption type: NONEMinimum alert email severity level: WARNINGAlert email recipient address(es):Alert email from address:Send event data to Nimble Storage Support: YesSend AutoSupport data to Nimble Storage Support: YesAllow Nimble Storage Support to establish secure connection to array: Yes......User inactivity timeout: 90 minute(s)Encryption master key set: NoEncryption default settings scope: noneEncryption default cipher: noneEncryption security mode: noneEncryption activated: No



This example shows detailed information about the same group after encryption is configured. The output istruncated to save space.

Nimble OS $ group --infoGroup name: group-array2Group Management IP: 192.0.2.51/255.255.255.0Group Discovery IP: 172.18.120.55/255.255.255.0Group leader array: array2Member array(s): array2Unreachable member array(s):Version: 2.3.1.0-234720-opt......User inactivity timeout: 90 minute(s)Encryption master key set: YesEncryption default settings scope: groupEncryption default cipher: aes-256-xtsEncryption security mode: secureEncryption activated: Yes

This example modifies the group name and AutoSupport configuration.

Nimble OS $ group --edit --name greyhound2--autosupport yes

This example configures secure SMTP for the group.

Nimble OS $ group --edit--smtp_server mail.companyname.com --smtp_port 25--smtp_auth yes --smtp_username smtp.user1--smtp_encrypt_type ssl --smtp_from_addr [email protected]_to_addr [email protected] --send_event_data yesEnter password:Nimble OS $

This example creates a bandwidth throttle that limits replication bandwidth to 10 Mbps on Tuesdays from6:00 AM until 7:00 AM.

Nimble OS $ group --create_throttle --description morning --days Tue--at 06:00AM --until 07:00AM --bandwidth 10

This example modifies the bandwidth throttle with the ID of 8 to permit 20 mbps during the permitted replicationtime.

Nimble OS $ group --edit_throttle 8 --bandwidth 20

This example deletes the bandwidth throttle for replication with the ID of 8.

Nimble OS $ group --delete_throttle 8

This example validates the AutoSupport configuration for a group with two arrays.

Note If the validation fails, an error message reports a potential reason. In some cases, an INFO messagemight suggest commands to use to diagnose the issue.

Nimble OS $ group --autosupport_validateINFO: Successfully validated autosupport configuration on array array5INFO: Successfully validated autosupport configuration on array array7INFO: Successfully validated autosupport configuration.



This example sends AutoSupport information from the group to Nimble Storage Support.

Nimble OS $ group --autosupport_initiate

This example validates two groups before using the --merge option to merge the groups.

Nimble OS $ group --merge_validate group21 --user admin--password dsfgH456

This example merges the group named Seattle into the current group.

Nimble OS $ group --merge Seattle --user admin--password dsfgH456

This example clears the HTTP proxy server settings for the current group.

Nimble OS $ group --unset_http_proxy

This example lists limits for the group. The output is truncated to save space.

Nimble OS $ group --list_limits---------------+---------------+----------------------+-------+-------+---------Object Scope Type Scope Name Count Warning Maximum---------------+---------------+----------------------+-------+-------+---------array group 1 4 4array pool - 4 4array pool default 1 4 4chapuser group 0 960 1024initiator group 0 9500 10000initiator initiatorgrp - 240 256initiatorgrp group 1 960 1024partner group 0 8 10partner pool - 8 10perfpolicy group 15 45 50pool group 1 4 4protsched group 6 950 1000......snapshot group 0 36000 40000snapshot pool default 0 9000 10000snapshot vol - 900 1000snapcoll volcoll - 900 1000

NOTE: Snapshot counts for pool/group scope are for high retention volumes only.



haltThe halt command options halt an entire group, an array, or both controllers on a specified array. If you haltan array, it stops both controllers and turns off the array. To restart the array or controller, you have to pressthe Power button on the front of the array.

Synopsis

halt --help

halt[--array array_name][--controller {A | B|][--group {group_name][--force][--non_interactive]

Options



N/A--help

PowerUser

Halt the specified array. If you haltan array, it stops both controllersand turns off the array. To restartthe array, press the Power buttonon the front of the array.

array_name--array

Halt the specified controller on thespecified array. Valid controllernames are A or B, which are casesensitive.. You can omit the --con-troller option if there is a single ar-ray in a group, an uninitialized ar-ray, or if entered on a member ar-ray in a group.

[--controller {A | B|]

Override the default behavior ofhaving to type "yes" to completethe command. Use this suboptionwith care to avoid unexpectedlytaking the array or controller offline.

--non_interactive


halt


PowerUser

Halt the entire group when you runthis command on the group leader.Both controllers of all arrays in agroup are then halted and poweris automatically turned off. If anyarray fails to respond to the haltrequest, then the group leader ar-ray remains operational. To restartthe arrays in the group, press thePower button on the front of eacharray.

group_name--group

Override the default behavior ofhaving to type "yes" to completethe command. Use this suboptionwith care to avoid unexpectedlytaking the group or controller off-line.

--non_interactive

Halt the remaining arrays in agroup when one or more arrayscannot be reached. For example,an array can be unreachable if it isalready halted.

[--force]

Examples

This example halts an array named NM127f.

Nimble OS $ halt --array NM127fWARNING: This operation will halt the array. Restarting the array willrequire physically powering it back on. Type yes to continue, no tocancel: yesINFO: The controller shelf is being turned off. Therefore you can no longermanage the group.INFO: After the controller shelf has been turned off, you can turn off anyexpansion shelves that are attached to the array.INFO: Power on the expansion shelves first. Then power on the controllershelf and log in to start managing the group again.

This example halts all controllers on all arrays in a group named Acme_cluster. You do not need to specifythe group name. When you issue this command option on the group leader, it runs on the group that you arelogged in to.

Nimble OS $ halt --groupWARNING: This operation will halt all arrays in the group.Restarting the group will require physically powering onall arrays in the group. Type yes to continue, no to cancel: yesINFO: The controller shelf is being turned off. Therefore you can no longermanage the group.INFO: After the controller shelf has been turned off, you can turn off anyexpansion shelves that are attached to the array.INFO: Power on the expansion shelves first. Then power on the controllershelf and log in to start managing the group again.



initiatorgrpThe initiatorgrp command options control array access by grouping initiators that share a set of commoncharacteristics.

A given Nimble array supports access through the iSCSI or Fibre Channel (FC) protocol, not both.

• An iSCSI initiator group is a set of initiators that are allowed to access a specific volume. After the initiatorgroup is created, add iSCSI initiators to the group. All initiators in the group are granted access to theassigned volume(s).

For example, to create an initiator group named exchange and assign an iSCSI initiator to it, you need torun two commands: one to create the group and one to add the iSCSI initiators.

• A Fibre Channel initiator group is a set of initiators that are allowed to access specific volumes, or LUNs.The World Wide Port Names (WWPNs) for the host bus adapters (HBAs) on a host machine are used tocreate an initiator group. If a given WWPN is not in an initiator group that has an ACL to a volume (LUN),that host cannot access the volume.

Synopsis

initiatorgrp --help

initiatorgrp --list

initiatorgrp --info initiatorgrp_name

initiatorgrp --create initiatorgrp_name[--description text]

initiatorgrp --delete initiatorgrp_name

initiatorgrp --edit initiatorgrp_name[--name new_name][--description text]

initiatorgrp --add_initiators initiatorgrp_name[--label label][--initiator_name iqn][--ipaddr ip_address][--initiator_alias alias][--wwpn wwpn][--force]

initiatorgrp --remove_initiator initiatorgrp_name[--label label][--initiator_alias alias][--wwpn wwpn]

initiatorgrp --add_subnets initiatorgrp_name--label subnet_label

initiatorgrp --remove_subnet initiatorgrp_name--label subnet_label[--force]


initiatorgrp

Options



N/A--help

OperatorList all configured initiator groups.N/A--list

OperatorShow detailed information aboutthe specified initiator group.

initiatorgrp_name--info

OperatorCreate a new iSCSI or FibreChannel initiator group with thespecified name. After creation, useinitiatorgrp --add_initiators toadd members to the group.

initiatorgrp_name--create

Add a description for the new initi-ator group. If there are spaces inthe description, enclose the text inquotation marks.


OperatorDelete the specified initiator group.If any volumes include this initiatorgroup in access control records,run initiatorgrp --remove_initi-ators to remove the group fromthose records first.

initiatorgrp_name--delete

OperatorModify attributes of the specifiedinitiator group. Specify one or bothof the --name and --descriptionsuboptions.

initiatorgrp_name--edit

Modify the name of the specifiedinitiator group.

[--name new_name]

Modify the description of the spe-cified initiator group. If there arespaces in the description, enclosethe text in quotation marks.





OperatorAdd one or more members to thespecified iSCSI or Fibre Channelinitiator group.

initiatorgrp_name--add_initiators

Add an iSCSI initiator with thisunique label of at least two charac-ters to the specified initiator group.The label describes a set of attrib-utes made up of the initiator name,IP address, and subnet combina-tion (also called an access controllist, or ACL).

[--label label]

Add an iSCSI initiator with thisiSCSI Qualified Name (IQN) to thespecified initiator group. Repeatthis option to specify more than oneinitiator name. Each initiator namemust have an associated IP ad-dress that you can view by typingthe --ipaddr option. Leave the IPaddress blank for the initiator if youprefer not to authenticate usingboth the name and IP address.

[--initiator_name iqn]

Add an iSCSI initiator with this IPaddress to the specified initiatorgroup. Repeat this option to specifymore than one initiator IP address,or specify * to match all IP ad-dresses. Each initiator IP addressmust have an associated namespecified using the --initiator_nameoption. Leave the name blank if youprefer not to authenticate usingboth name and IP address.

[--ipaddr ip_address]

Add a Fibre Channel initiator withthis alias of up to 32 characters tothe specified initiator group. Repeatthis option to specify more than oneinitiator alias. Each initiator aliasmust have an associated WorldWide Port Name (WWPN) specifiedusing the --wwpn option. Leave theWWPN blank when using a previ-ously saved initiator alias.

[--initiator_alias alias]

[--wwpn wwpn]




Add a Fibre Channel initiator withthis WWPN to the specified initiatorgroup. Repeat this option to specifymore than one initiator WWPN.Each initiator WWPN can have anassociated alias specified using the--initiator_alias option. Leave thealias blank if you prefer not to as-sign an initiator alias. Even if thealias is blank, if the specifiedWWPN and alias pair are used inanother initiator group, the systemwill apply the alias when searchingfor, and finding, the same mappedvalues used elsewhere. The aliasand WWPN have system-levelscope.

Update or remove conflicting FibreChannel initiator aliases and for-cibly adds the Fibre Channel initiat-or to the specified initiator group.

[--force]

OperatorRemove an initiator from the spe-cified initiator group. Specify aniSCSI or Fibre Channel suboptionas appropriate for the initiatorgroup.

initiatorgrp_name--remove_initiator

Remove an iSCSI initiator with thisunique label from the specified ini-tiator group. The label describes aset of attributes made up of the ini-tiator name, IP address, and sub-net combination (also called anaccess control list, or ACL).

[--label label]

Remove a Fibre Channel initiatorwith this alias from the specifiedinitiator group. If both initiator_aliasand wwpn are provided, they mustbe synchronized. If they are notsynchronized, the initiator will notbe removed from the initiator group.

[--initiator_alias alias]

Remove a Fibre Channel initiatorwith this WWPN from the specifiedinitiator group.

[--wwpn wwpn]




OperatorAdd target subnets for the specifiediSCSI initiator group to discoverand access volumes. This optionhas no meaning for Fibre Channelinitiator groups.

initiatorgrp_name--add_subnets

Add a subnet with this label to thespecified initiator group. Use sub-net --list to get a list of subnets.Repeat this option to specify morethan one subnet.

--label subnet_label

OperatorRemove a target subnet from thespecified iSCSI initiator group. Thisoption has no meaning for FibreChannel initiator groups.

initiatorgrp_name--remove_subnets

Remove a subnet with this labelfrom the specified initiator group.Use initiatorgrp --list to seewhich initiator groups have associ-ated subnets. Then use initiat-orgrp --info initiatorgrp_name toget a list of potential subnets to re-move.

--label subnet_label

Forcibly remove a target subnetfrom the specified initiator group.

[--force]

Examples

This example shows a list of current initiator groups on an iSCSI Nimble array. A value of All in the Numberof Subnets column means that no subnets are associated with the initiator group.

Nimble OS $ initiatorgrp --list------------------------------+--------------------------+-----------------Initiator Group Name Number of Initiators Number of Subnets------------------------------+--------------------------+-----------------initiatorgroup1 2 1initiatorgroup2 7 All

This example shows a list of current initiator groups on a Fibre Channel Nimble array.

Nimble OS $ initiatorgrp --list------------------------------+--------------------------+-----------------Initiator Group Name Number of Initiators Number of Subnets------------------------------+--------------------------+-----------------a11-al4 2a11-al4-5 4a11-al5 2a12-al6 2a12-al7 2C22Win5 2C22win4 2a11-al2-RHEL 2a11-al3-OL 2esxcluster 6



This example shows detailed information about the iSCSI initiator group named initiatorgroup1.

Nimble OS $ initiatorgrp --info initiatorgroup1Name: initiatorgroup1Description:Access Protocol: iscsiCreated: Apr 10 2014 14:56:45Last configuration change: Apr 30 2014 14:00:03Number of Subnets: 1

Subnet Label: Subnet-1.141.0.0Number of Initiators: 2

Initiator Label: volumetwo-v38270Initiator Name: iqn.2012-11.com.nimblestorage:volumetwo-v38270Initiator IP Address: *

Initiator Label: volumeone-v40dc27Initiator Name: iqn.2012.com.nimblestorage:volumeone-v40dc27Initiator IP Address: *

This example shows detailed information about the Fibre Channel initiator group named esxcluster.

Nimble OS $ initiatorgrp --info esxclusterName: esxclusterDescription:Access Protocol: fcCreated: Jul 23 2014 17:48:18Last configuration change: Jul 23 2014 17:55:07Number of Initiators: 6

Initiator: A11_hba2 (21:00:00:0e:1e:19:60:90)Initiator: A11_hba3 (21:00:00:0e:1e:19:60:91)Initiator: Esx2_hba1 (21:00:00:0e:1e:19:60:40)Initiator: Esx2_hba2 (21:00:00:0e:1e:19:60:41)Initiator: Esx1_hba1 (10:00:00:90:fa:53:a0:a0)Initiator: Esx1_hba2 (10:00:00:90:fa:53:a0:a1)

This example creates an iSCSI initiator group named grouplevel2 and then verifies that the group exists.

Nimble OS $ initiatorgrp --create grouplevel2 --description"group level two iSCSI initiators"

Nimble OS $ initiatorgrp --list------------------------------+--------------------------+-----------------Initiator Group Name Number of Initiators Number of Subnets------------------------------+--------------------------+-----------------grouplevel2 0 Allinitiatorgroup1 2 1initiatorgroup2 7 All

Nimble OS $ initiatorgrp --info grouplevel2Name: grouplevel2Description: group level two iSCSI initiatorsAccess Protocol: iscsiCreated: Jul 10 2014 11:06:47Last configuration change: Jul 10 2014 11:06:47Number of Subnets: AllNumber of Initiators: 0

This example shows that there are no access control records for the iSCSI initiator group named grouplevel2and then deletes the group.

Nimble OS $ initiatorgrp --list------------------------------+--------------------------+-----------------



Initiator Group Name Number of Initiators Number of Subnets------------------------------+--------------------------+-----------------grouplevel2 0 Allinitiatorgroup1 2 1initiatorgroup2 7 All

Nimble OS $ initiatorgrp --delete grouplevel2

This example modifies the name and description of the iSCSI initiator group named grouplevel2 and thenshows the changes.

Nimble OS $ initiatorgrp --list------------------------------+--------------------------+-----------------Initiator Group Name Number of Initiators Number of Subnets------------------------------+--------------------------+-----------------grouplevel2 0 Allinitiatorgroup1 2 1initiatorgroup2 7 All

Nimble OS $ initiatorgrp --edit grouplevel2 --name group-level-2--description "second-level group"

Nimble OS $ initiatorgrp --list------------------------------+--------------------------+------------------Initiator Group Name Number of Initiators Number of Subnets------------------------------+--------------------------+------------------group-level-2 0 Allinitiatorgroup1 2 1initiatorgroup2 7 All

Nimble OS $ initiatorgrp --info group-level-2Name: group-level-2Description: second-level groupAccess Protocol: iscsiCreated: Jul 10 2014 11:06:47Last configuration change: Jul 10 2014 11:47:07Number of Subnets: AllNumber of Initiators: 0

This example adds one initiator member to the iSCSI initiator group named group-level-2.

Nimble OS $ initiatorgrp --add_initiators group-level-2--initiator_name iqn.2012-11.com-company

--ipaddr 10.12.130.211

This example removes an initiator from the iSCSI initiator group named group-level-2.

Nimble OS $ initiatorgrp group-level-2 --remove_initiator--label iqn2

This example adds one subnet to the iSCSI initiator group named group-level-2.

Nimble OS $ initiatorgrp --add_subnets group-level-2--label data1

This example removes the data1 subnet from the iSCSI initiator group named group-level-2.

Nimble OS $ initiatorgrp --remove_subnet group-level-2--label data1



ipThe ip command options manage IP configuration settings.

The array management IP address is a floating address. It is assigned to a physical port by the system. ThisIP address is used to access the GUI and CLI on the array. The controller uses this IP address to have anactive role. The discovery IP address is also a floating address. It is assigned to a physical port by the system.SCSI initiators use this IP address to discover targets. This array management IP address and the managementIP address can share the same IP address or have unique IP addresses.

Each controller on the Nimble array has multiple port pairs that are used as data ports. You can configurethese ports as part of the network configuration. Data ports are paired to ensure high availability (HA). Thenumber of port pairs depends on your model.

Each controller is also assigned a static IP address to have direct access to a controller.

Synopsis

ip --help

ip --list[--netconfig netconfig_name][--array array_name]

ip --info ipaddr[--netconfig netconfig_name][--array array_name]

ip --add ipaddr[--netconfig netconfig_name][--array array_name]--type {data|management|support}[--nic nic_name][--ctrlr {A|B}]

ip --edit ipaddr[--netconfig netconfig_name][--array array_name][--type {data|discovery|management|support}][--nic nic_name][--newaddr ipaddr][--ctrlr {A|B}][--force_ip_update]

ip --delete ipaddr[--netconfig netconfig_name][--array array_name][--type {data|discovery|management|support}][--ctrlr {A|B}][--force_ip_update]


ip

Options



N/A--help

GuestList all configured data, manage-ment, and diagnostic (support) IPaddresses.

--list

List the data, management, anddiagnostic (support) IP addressesfor the specified network configura-tion. Use netconfig --list to getthe names of network configura-tions. Typical names are {active |backup | draft}.

[--netconfig netconfig_name]

List the data, management, anddiagnostic (support) IP addressesfor the specified array. Use array--list to get the names of arrays.


GuestShow detailed information aboutthe specified IP address.

ipaddr--info

Show detailed information aboutthe specified IP address in thespecified network configuration.Use netconfig --list to get thenames of configurations.


Show detailed information aboutthe specified IP address on thespecified array. Use array --list toget the names of arrays.





PowerUser

Add an IP address to the networkconfiguration for an array.

ipaddr--add

Add the specified data, manage-ment, or support (diagnostic) IPaddress to the specified networkconfiguration.


Add the specified data, manage-ment, or support (diagnostic) IPaddress to the specified array.


Specify the type of IP address be-ing added.

--type {data|management|support}

Add a data IP address to the spe-cified NIC. Values depend on thehardware configuration, and caninclude eth1 through eth6 for theCS-Series or eth1, eth2, tg1, andtg2 for the CS-Series "G" configur-ation (for CS200 and CS400 mod-els).

[nic nic_name]

Add a support IP address to thespecified controller.

[--ctrlr {A|B}]




PowerUser

Modify the specified IP address onthe network configuration for anarray.

ipaddr--edit

Modify the specified data, discov-ery, management, or support (dia-gnostic) IP address for the spe-cified network configuration.


Modify the specified data, discov-ery, management, or support (dia-gnostic) IP address for the spe-cified array.


Modify the type for the specified IPaddress. Valid values are data,discovery (although this type hasno effect on a Fibre Channel array),management, or support.

[--type {data|discovery|manage-ment|support}]

Modify a data IP address for thisNIC. Values depend on the hard-ware configuration, and can includeeth1 through eth6 for the CS-Seriesor eth1, eth2, tg1, and tg2 for theCS-Series "G" configuration (forCS200 and CS400 models).

[--nic nic_name]

Modify a previously configured IPaddress.

[--newaddr ipaddr]

Modify a support IP address for thespecified controller.

[--ctrlr {A|B}]

Forcibly modify a data or discoveryIP address in an active networkconfiguration. The command failsunless this option is used.

[--force_ip_update]




PowerUser

Delete the specified IP addressfrom a network configuration on anarray.

ipaddr--delete

Delete the specified data, discov-ery, management, or support (dia-gnostic) IP address from the spe-cified network configuration.


Delete the specified data, discov-ery, management, or support (dia-gnostic) IP address from the spe-cified array.


Delete an IP address configuration.Valid values are data, discovery,management, or support.

[--type {data|discovery|manage-ment|support}]

Delete a support IP address fromthe specified controller.

[--ctrlr {A|B}]

Forcibly delete a data or discoveryIP address in an active networkconfiguration. The command failsunless this option is used.

[--force_ip_update]

Examples

This example shows information about the array IP configuration.

Nimble OS $ ip --list---------------+--------+------+----------+------------------IP Address NIC Status Type Controller---------------+--------+------+----------+------------------192.0.2.209 eth1 up management A192.0.2.209 eth1 up discovery A198.51.100.209 eth1 up data A198.51.100.210 eth2 up data A198.51.100.211 eth3 up data A198.51.100.212 eth4 up data A192.0.2.209 eth1 up support A192.0.2.210 eth1 up support B

This example shows detailed information about an IP address in the active network configuration.

Nimble OS $ ip --info 192.0.2.209 --netconfig activeIP address: 192.0.2.209NIC: eth1Link status: upArray: c20-array2Controller: BType: management, discovery

This example adds a support IP address to controller B.

Nimble OS $ ip --add 10.12.148.209 --type support --ctrlr B

This example modifies a data IP address and lists the change to verify the modification.



Nimble OS $ ip --edit 198.51.100.209 --type data --newaddr 198.51.100.109

Nimble OS $ ip --list---------------+--------+------+----------+------------------IP Address NIC Status Type Controller---------------+--------+------+----------+------------------192.0.2.209 eth1 up management A192.0.2.209 eth1 up discovery A198.51.100.109 eth1 up data A198.51.100.210 eth2 up data A198.51.100.211 eth3 up data A198.51.100.212 eth4 up data A192.0.2.209 eth1 up support A192.0.2.210 eth1 up support B

This example deletes the support IP address for controller B and then lists the IP addresses to verify thedeletion.

Nimble OS $ ip --delete 192.0.2.210 --type support --ctrlr B

ip --list---------------+--------+------+----------+------------------IP Address NIC Status Type Controller---------------+--------+------+----------+------------------192.0.2.209 eth1 up management A192.0.2.209 eth1 up discovery A198.51.100.109 eth1 up data A198.51.100.210 eth2 up data A198.51.100.211 eth3 up data A198.51.100.212 eth4 up data A192.0.2.209 eth1 up support A



migrationThe migration command options provide information about data migration activity.

Synopsis

migration --help

migration --list[--array_unassign][--pool_rebal][--vf_reloc]

migration --info {array|pool|volume}[--array_unassign][--pool_rebal][--vf_reloc]

Options



N/A--help

GuestList data-migration activity that isrelated to unassigning arrays frompools, rebalancing array usage inpools, or relocating a volume familyto a different pool. Specify one ofthe suboptions each time you runmigration --list.

{--array_unassign|--pool_re-bal|--vf_reloc}

--list

GuestShow information about data-migra-tion activity that is related to thespecified array being unassignedfrom its pool, the specified poolbeing rebalanced, or the specifiedvolume family being relocated to adifferent pool. A volume family is acollection of volumes with a singleroot volume. A root volume is avolume that has no parent. Specifyone of the argument/suboptionpairs each time you run migra-tion --info.

{array_name --array_unas-sign|pool_name --pool_re-bal|volume_name --vf_reloc}

--info

Examples

This example shows that no migration of array unassignment is currently active.

Nimble OS $ migration --list --array_unassignNone.

This example shows information about unassigning an array from its pool.


migration

Nimble OS $ migration --info c20-array2 --array_unassignArray Unassign:--------------------+----------------+----------------------Array Data Estimated

Remaining (MB) Completion--------------------+----------------+----------------------c20-array2 932 2 min



netconfigThe netconfig command options manage a network configuration.

Synopsis

netconfig --help

netconfig --list

netconfig --info {active|backup|draft}

netconfig --create_draft_from {active|backup}[--force]

netconfig --validate {active | backup | draft}[--force_repl][--force_initiator_groups]

netconfig --activate {active|backup}[--force_repl][--force_ip_update][--force_initiator_groups]

netconfig --edit {active|backup|draft}[--iscsi_automatic_connection_method {yes|no}][--iscsi_connection_rebalancing {yes|no}][--force_ip_update]

netconfig --delete {backup|draft}

Options



N/A--help

GuestList network configurations.N/A--list

GuestProvide detailed information aboutthe specified network configuration.

{active|backup|draft}--info

PowerUser

Create a draft network configura-tion from the specified active orbackup network configuration.

{active|backup}--create_draft_from

Forcibly create a draft networkconfiguration if a draft already ex-ists.

[--force]


netconfig


PowerUser

Validate the specified networkconfiguration.

{active|backup|draft}--validate

Ignore inconsistent network config-urations for replication partnerswhen validating the specified net-work configuration.

[--force_repl]

Ignore initiators assigned to sub-nets when validating the specifiednetwork configuration.

[--force_initiator_groups]

PowerUser

Activate the specified networkconfiguration and makes it thenewly active network configuration.

backup--activate

Ignore inconsistent network config-urations for replication partnerswhen activating the specified net-work configuration.

[--force_repl]

Allow activating the specified net-work configuration and updatingthe discovery or data IP addressesfor the active configuration.

[--force_ip_update]

Ignore initiators assigned to sub-nets when activating the specifiednetwork configuration.


PowerUser

Modify the specified network config-uration. Specify at least one subop-tion.

{active|backup|draft}--edit

Redirect connections from a spe-cified iSCSI target IP to the bestdata IP that is based on connectioncounts. This option has no effecton a Fibre Channel array.

[--iscsi_automatic_connec-tion_method {yes|no}]

Rebalance iSCSI connections byperiodically breaking existing con-nections that are out of balance toallow the host to reconnect to an-other data IP address. This optionhas no effect on a Fibre Channelarray.

[--iscsi_connection_rebalancing{yes|no}]

Allow updating the discovery ordata IP addresses for the activenetwork configuration.

[--force_ip_update]

PowerUser

Delete the specified network config-uration. You cannot delete the act-ive network configuration.

{backup|draft}--delete

Examples

This example lists the network configurations for an array.



Nimble OS $ netconfig --list--------+---------------------+---------------------+--------------------Name Last Modified Active Since Last Active--------+---------------------+---------------------+--------------------backup Jun 27 2014 11:22:45 N/A Jun 27 2014 11:22:55active Jun 27 2014 11:22:55 Jun 27 2014 11:22:45 N/A

This example shows information about the active network configuration on a Fibre Channel array.

Nimble OS $ netconfig --info activeGroup Management IP: 192.0.2.19Group leader array: array7Member array(s): array7ISCSI Automatic connection method: YesISCSI Connection rebalancing : Yes

Routes:---------------+---------------+---------------Destination Netmask Gateway---------------+---------------+---------------0.0.0.0 0.0.0.0 203.0.113.1

Subnets:---------------------+-----------------+-------+--------------+----+-----Label Network Type Discovery IP VLAN MTU---------------------+-----------------+-------+--------------+----+-----data1 192.0.2.0/23 Data 192.0.2.61 0 9000mgmt-only 192.0.2.0/21 Mgmt 192.0.2.19 0 1500Subnet-1.101.0.0 1.101.0.0/16 Data N/A 2101 1500Subnet-1.102.0.0 1.102.0.0/16 Data N/A 2102 1500Subnet-1.103.0.0 1.103.0.0/16 Data N/A 2103 1500Subnet-1.104.0.0 1.104.0.0/16 Data N/A 2104 1500Subnet-1.105.0.0 1.105.0.0/16 Data N/A 2105 1500Subnet-1.106.0.0 1.106.0.0/16 Data N/A 2106 1500Subnet-1.107.0.0 1.107.0.0/16 Data N/A 2107 1500Subnet-1.108.0.0 1.108.0.0/16 Data N/A 2108 1500Subnet-1.109.0.0 1.109.0.0/16 Data N/A 2109 1500Subnet-1.110.0.0 1.110.0.0/16 Data N/A 2110 1500

Array Network Configuration: array7Controller A IP: 192.0.2.11Controller B IP: 192.0.2.18---------+------------------------+---------------+------NIC Subnet Label Data IP Address Tagged---------+------------------------+---------------+------eth1 mgmt-only N/A Noeth2 N/A Noeth3 data1 192.0.2.62 Noeth3.2101 Subnet-1.101.0.0 1.101.3.35 Yeseth3.2102 Subnet-1.102.0.0 1.102.3.35 Yeseth3.2103 Subnet-1.103.0.0 1.103.3.35 Yeseth3.2104 Subnet-1.104.0.0 1.104.3.35 Yeseth3.2105 Subnet-1.105.0.0 1.105.3.35 Yeseth3.2106 Subnet-1.106.0.0 1.106.3.35 Yeseth3.2107 Subnet-1.107.0.0 1.107.3.35 Yeseth3.2108 Subnet-1.108.0.0 1.108.3.35 Yeseth3.2109 Subnet-1.109.0.0 1.109.3.35 Yeseth3.2110 Subnet-1.110.0.0 1.110.3.35 Yeseth4 data1 192.0.2.91 Noeth4.2101 Subnet-1.101.0.0 1.101.194.35 Yeseth4.2102 Subnet-1.102.0.0 1.102.194.35 Yes



eth4.2103 Subnet-1.103.0.0 1.103.194.35 Yeseth4.2104 Subnet-1.104.0.0 1.104.194.35 Yeseth4.2105 Subnet-1.105.0.0 1.105.194.35 Yeseth4.2106 Subnet-1.106.0.0 1.106.194.35 Yeseth4.2107 Subnet-1.107.0.0 1.107.194.35 Yeseth4.2108 Subnet-1.108.0.0 1.108.194.35 Yeseth4.2109 Subnet-1.109.0.0 1.109.194.35 Yeseth4.2110 Subnet-1.110.0.0 1.110.194.35 Yes

This example creates a draft from the active network configuration and then lists the results.

Nimble OS $ netconfig --create_draft_from active

Nimble OS $ netconfig --list----------+----------------------+----------------------+----------------------Name Last Modified Active Since Last Active----------+----------------------+----------------------+----------------------backup Jun 27 2014 11:22:45 N/A Jun 27 2014 11:22:55active Jun 27 2014 11:22:55 Jun 27 2014 11:22:45 N/Adraft Jul 17 2014 15:14:34 N/A N/A

This example validates a draft network configuration.

Nimble OS $ netconfig --validate draftINFO: Configuration is valid.

If the validation fails, an INFO message identifies what issues to resolve. For example, on an iSCSI array:

Nimble OS $ netconfig --validate backupERROR: Failed to validate netconfig. Invalid argument.INFO: Must configure at least one iSCSI and at least one group enabled subnet.

This example activates the draft network configuration.

Nimble OS $ netconfig --activate draft

This example edits the draft network configuration on an iSCSI array to enable iSCSI connection rebalancing.

Nimble OS $ netconfig --edit draft --iscsi_connection_rebalancing yes

This example deletes the draft network configuration.

Note If you delete the backup network configuration, you have to modify the active configuration and activatethe modified version.

Nimble OS $ netconfig --delete draft



nicThe nic command options manage Network Interface Cards (NICs) on a Nimble array.

NICs are the hardware that manages any physical ports on an array. You can manage settings, such asframe size, on the NIC.

Note Do not enable jumbo frames on switches unless jumbo frames are also configured on the NICs.

Synopsis

nic --help

nic --list[--netconfig {active|backup|draft}][--array {array_name|serial_number}]

nic --info nic_name[--netconfig {active|backup|draft}][--array {array_name|serial_number}]

nic --assign nic_name[--netconfig {active|backup|draft}][--array {array_name|serial_number}][--subnet subnet_label][--tagged {yes|no}][--data_ip ip_address]

nic --unassign nic_name[--netconfig {active|backup|draft}][--array {array_name|serial_number}][--subnet subnet_label]

Options



N/A--help

GuestList all NICs, or the NICs associ-ated with the specified networkconfiguration or the NICs on thespecified array.

--list

List the NICs for a specified net-work configuration.

[--netconfig {active|backup|draft}]

List the NICs on the specified array.[--array {array_name | serial_num-ber}]


nic


GuestShow detailed information aboutthe specified NIC.

nic_name--info

Show detailed information aboutthe specified NIC on the specifiednetwork configuration.


Show detailed information aboutthe specified NIC on the specifiedarray.

[--array {array_name | serial_num-ber}]

PowerUser

Assign a subnet on the specifiedNIC.

nic_name--assign

Assign a subnet on the specifiedNIC on the specified network con-figuration.


Assign a subnet on the specifiedNIC on the specified array.

[--array {array_name | serial_num-ber}]

Specify the subnet to assign. Runsubnet --list to get currently unas-signed values for subnet_label.

[--subnet subnet_label]

Specify whether the NIC uses atagged assignment on the specifiedsubnet. A tagged assignmentmeans that traffic for the subnet onthis NIC will carry the 802.1Q framewith the VLAN ID for the subnet. ANIC can have at most one un-tagged assignment and zero ormany tagged assignments.

[--tagged {yes|no}]

Specify the data IP address.[--data_ip ip_address]

PowerUser

Unassign a subnet from the spe-cified NIC.

nic_name--unassign

Unassign a subnet from the spe-cified NIC on the specified networkconfiguration.


Unassign a subnet from the spe-cified NIC on the specified array.


Examples

This example lists the NICs on an iSCSI array. The output is truncated to avoid line wrapping.

nic --list-------+-------+-----+-----------------+----------------+-----------------Name Link Link MAC Subnet IP Addresses

Status SpeedA/B

-------+-------+-----+-----------------+----------------+-----------------eth1 up/up 1G 00:25:90:75:18:90 mgmt-data 192.0.2.51,...eth2 up/up 1G 00:25:90:75:18:91 mgmt-data



eth3 up/up 1G 00:E0:ED:18:25:06 data1 198.51.100.56eth4 up/up 1G 00:E0:ED:18:25:07 data1 198.51.100.57eth5 up/up 1G 00:E0:ED:1C:FF:66 data1 198.51.100.55,...eth6 up/up 1G 00:E0:ED:1C:FF:67 data1 198.51.100.59

This example lists the NICs on a Fibre Channel array. The output is truncated to avoid line wrapping and tosave space.

nic --list---------+-------+-----+-----------------+----------------+-------------------Name Link Link MAC Subnet IP Addresses

Status SpeedA/B

---------+-------+-----+-----------------+----------------+-------------------eth1 up/up 1G 00:25:90:8C:F2:3A mgmt-only 192.0.2.18,...eth2 up/up 1G 00:25:90:8C:F2:3B N/Aeth3 up/up 10G 00:25:90:E0:A5:71 data1 192.0.2.61,...eth3.2101 up/up 10G 00:25:90:E0:A5:71 Subnet-1.101.0.0 1.101.3.35eth3.2102 up/up 10G 00:25:90:E0:A5:71 Subnet-1.102.0.0 1.102.3.35eth3.2103 up/up 10G 00:25:90:E0:A5:71 Subnet-1.103.0.0 1.103.3.35eth3.2104 up/up 10G 00:25:90:E0:A5:71 Subnet-1.104.0.0 1.104.3.35eth3.2105 up/up 10G 00:25:90:E0:A5:71 Subnet-1.105.0.0 1.105.3.35eth3.2106 up/up 10G 00:25:90:E0:A5:71 Subnet-1.106.0.0 1.106.3.35eth3.2107 up/up 10G 00:25:90:E0:A5:71 Subnet-1.107.0.0 1.107.3.35eth3.2108 up/up 10G 00:25:90:E0:A5:71 Subnet-1.108.0.0 1.108.3.35eth3.2109 up/up 10G 00:25:90:E0:A5:71 Subnet-1.109.0.0 1.109.3.35eth3.2110 up/up 10G 00:25:90:E0:A5:71 Subnet-1.110.0.0 1.110.3.35eth4 up/up 10G 00:25:90:E0:A5:70 data1 10.18.122.91eth4.2101 up/up 10G 00:25:90:E0:A5:70 Subnet-1.101.0.0 1.101.194.35eth4.2102 up/up 10G 00:25:90:E0:A5:70 Subnet-1.102.0.0 1.102.194.35

This example shows detailed information for the eth2 NIC on an iSCSI array.

Nimble OS $ nic --info eth2Name: eth2Location on Controller A: 0,1Location on Controller B: 0,1Present on Controller A: YesPresent on Controller B: YesLink Status on Controller A: upLink Status on Controller B: upMax Supported Link Speed: 1GInterface Type: TPNegotiated Link Speed on Controller A: 1GNegotiated Link Speed on Controller B: 1GMAC Address on Controller A: 00:25:90:75:18:9DMAC Address on Controller B: 00:25:90:75:18:91Subnet: mgmt-data (192.0.2.0/255.255.255.0)Type: MgmtVLAN Id: 0MTU: 1500IP Address:

This example shows detailed information for the eth3.2101 NIC on a Fibre Channel array.

Nimble OS $ nic --info eth3.2101Name: eth3.2101Location on Controller A: 1,0Location on Controller B: 1,0Present on Controller A: YesPresent on Controller B: Yes



Link Status on Controller A: upLink Status on Controller B: upMax Supported Link Speed: 10GInterface Type: TPNegotiated Link Speed on Controller A: 10GNegotiated Link Speed on Controller B: 10GMAC Address on Controller A: 00:25:90:CA:D5:29MAC Address on Controller B: 00:25:90:E0:A5:71Subnet: Subnet-1.101.0.0 (1.101.0.0/255.255.0.0)Type: DataVLAN Id: 2101MTU: 1500IP Address: 1.101.3.35



partnerThe partner command options manage replication partners and per-partner bandwidth throttles.

When you create a replication partner, you enable one Nimble array to replicate its data to another. The twoarrays must be able to communicate over a network by using ports 4213 and 4214. Replication partners havethe same name as the remote array.

Replication partners can be reciprocal, upstream (the source of replicas), or downstream (the receiver ofreplicas) partners. The replication partners must be configured on both arrays to successfully replicate.

Synopsis

partner --help

partner --list

partner --info partner_name

partner --create partner_name--hostname {ipaddr|hostname}[--control_port port][--data_port port][--description text]--secret shared_secret[--pool pool_name]--subnet subnet_label

partner --edit partner_name[--hostname {ipaddr|hostname}][--control_port port][--data_port port][--description text][--secret shared_secret][--pool pool_name][--new_name partner_name][--subnet subnet_label]

partner --delete partner_name

partner --create_throttle partner_name[--description text][--days days][--at time][--until time][--bandwidth megabits]

partner --edit_throttle partner_name[--description text]--id number[--days days][--at time][--until time][--bandwidth megabits]


partner

partner --delete_throttle partner_name--id number

partner --pause partner_name

partner --resume partner_name

partner --test partner_name

Options



N/A--help

GuestList all configured replication part-ners for the array.

N/A--list

GuestProvide detailed information aboutthe specified replication partner.

partner_name--info




PowerUser

Create a replication partner. Thepartner name must be the arrayname. After creating a replicationpartner on one array, create a recip-rocal, upstream, or downstreampartner on the array configured asthe replication partner.

partner_name--create

Specify the IP address or hostnameof the management IP address forthe replication partner.

--hostname {ipaddr|hostname}

Specify the port number of thecontrol interface. If you do not spe-cify this option, the default port4213 is used.

[--control_port port]

Specify the port number of the datainterface. If you do not specify thisoption, the default port 4214 isused.

[--data_port port]

Specify a description of the replica-tion partner. If there are spaces inthe description, enclose the text inquotation marks.


Specify the shared secret that en-sures secure communicationbetween the replication partners.Both replication partners must usethe same shared secret.

--secret shared_secret

Specify the storage pool in whichto create volumes. Any volumesreplicated from this partner arecreated in the specified pool. Rep-lica volumes created as clones ig-nore this parameter and are alwayscreated in the same pool as theirparent volume. If you do not specifythis option, the default storage poolis used.

[--pool pool_name]

Specify the local subnet to use forcommunication with this partner.For example,10.17.0.0/255.255.0.0.

--subnet subnet_label




PowerUser

Modify the configuration of thespecified replication partner. Spe-cify at least one suboption.

partner_name--edit

Modify the IP address or hostnameof the management IP address forthe replication partner.

[--hostname {ipaddr|hostname}]

Modify the port number of the con-trol interface. The default portnumber is 4213.

[--control_port port]

Modify the port number of the datainterface. The default port numberis 4214.

[--data_port port]

Modify the description of the replic-ation partner.


Modify the shared secret that en-sures secure communicationbetween the replication partners.Both replication partners must usethe same shared secret.

[--secret shared_secret]

Modify the storage pool in which tocreate volumes. Any volumes rep-licated from this partner are createdin the specified pool. Replicavolumes created as clones ignorethis parameter and are always cre-ated in the same pool as their par-ent volume. Modifying thepool_name does not affect existingreplica volumes.

[--pool pool_name]

Modify the name of the replicationpartner. The name must match thegroup name of the replication part-ner

[--new_name partner_name]

Modify the local subnet to use forcommunication with this partner.For example,10.17.0.0/255.255.0.0.


PowerUser

Delete the specified replicationpartner. If a volume collection isbeing replicated to a replicationpartner, then subsequent replica-tion based on that collection fails.

partner_name--delete




OperatorCreate a per-partner bandwidththrottle. You can create per-partnerreplication throttles only if there isno array-wide bandwidth throttle.You can create multiple per-partnerthrottles, but the throttles cannotoverlap.

partner_name--create_throttle

Describes the throttle. The systemautomatically assigns an ID to thethrottle schedule. If the descriptionincludes spaces, enclose the de-scription text in quotation marks.


Specifies the days of the week onwhich the throttle is effective, sep-arated by commas. For example,

Tue,Thur

You can specify the value all to in-dicate all days of the week, whichis the default if you do not specifythis option.

[--days days]

Specify the time of day at which thethrottle is activated.

--at time

Specify the time of day at which thethrottle is deactivated. This valuemust be later than the --at timevalue.

--until time

Specify the maximum bandwidthto use for replication in megabitsper second. Use 0 (zero) to stopreplication traffic, or unlimited toturn off throttling.

--bandwidth megabits




OperatorModify the specified per-partnerbandwidth throttle.

partner_name--edit_throttle

Modify the description of thethrottle.


Specify the ID of the throttle tomodify. Use the --info option to de-termine the throttle ID.

--id number

Modify the days of the week onwhich the throttle is effective, sep-arated by commas.

[--days days]

Modify the time of day at which thethrottle is activated.

--at time

Modify the time of day at which thethrottle is deactivated.

--until time

Modify the maximum bandwidth touse for replication, specified inmegabits per second. Use 0 (zero)to stop replication traffic, or unlim-ited to turn off throttling.

--bandwidth megabits

OperatorDelete the specified per-partnerbandwidth throttle.

partner_name--delete_throttle

Specify the ID of the bandwidththrottle to delete. The ID is as-signed by the system. Use part-ner --info to view all throttles andget the number you need.

--id number

OperatorPause replication to or from thespecified replication partner. In-progress replications are stoppeduntil resumed. This state is storedpersistently and remains in forceacross system restarts.

partner_name--pause

OperatorResume the paused replication toor from the specified replicationpartner.

partner_name--resume

OperatorTest the network connection to thespecified replication partner. Bothpartners must be configured for thetest to succeed.

partner_name--test

Examples

This example lists configured replication partners.

Nimble OS $ partner --list--------------------+------------------+---------------+----------Partner Hostname Status Throttled

Bandwidth



--------------------+------------------+---------------+----------array7 array7 disconnected unlimitedarray1 192.0.2.93 connected unlimitedarray2 192.0.2.57 connected unlimited

This example shows details about a replication partner named array1.

Nimble OS $ partner --info array1Name: array1Description:Hostname: 192.0.2.93Control port: 4213Data port: 4214Pool: defaultPaused: NoConnected: NoConnection error: N/AConfiguration synchronized: NoSynchronization error:Throttled bandwidth: unlimitedThrottles: N/ASubnet type: DataSubnet: Subnet-1.101.0.0 (1.101.0.0/255.255.0.0)Array serial: AC-109019Replication version: 63Created: Jul 24 2014 23:41:26Last configuration change: Sep 5 2014 11:53:31

This example creates a replication partner with a secret of nimblereplica and a description of San Jose array.Because values for the control and data ports are not provided, the defaults of 4213 and 4214 are used.

Nimble OS $ partner --create array1 --description "San Jose array"--secret nimblereplica --subnet 1.101.0.0/255.255.0.0

This example modifies the shared secret for a replication partner. In this case, the shared secret has to bechanged on the replication partner, too.

Nimble OS $ partner --edit array1 --secret mycoreplication

This example deletes the replication partner named array7.

Nimble OS $ partner --delete array7

This example creates a per-partner bandwidth throttle for the replication partner array2 that allows replicationtraffic Monday through Wednesday from 2 PM until 5 PM.

Nimble OS $ partner --create_throttle array2 --description "afternoon limit"--days Mon,Tue,Wed --at 14:00 --until 17:00 --bandwidth 10

This example modifies a per-partner bandwidth throttle with the ID of 26 for the replication partner array2.The modification allows replication traffic Monday through Wednesday from 3 PM until 5 PM and changesthe bandwidth.

Nimble OS $ partner --edit_throttle array2 --id 26--days Mon,Tue,Wed --at 15:00 --until 17:00--bandwidth 20 --description "afternoon replication limit"

This example deletes the throttle with the ID of 26.



Nimble OS $ partner --delete_throttle array1 --id 26

This example pauses all replication to the replication partner named array2.

Nimble OS $ partner --pause array2

This example resumes replication to the replication partner named array2.

Nimble OS $ partner --resume array2

This example tests connectivity to the replication partner named array1.

Nimble OS $ partner --test array1Successfully contacted partner.



perfpolicyThe perfpolicy command options manage performance policies.

You can use performance policies as a set of optimizations that includes block size, compression, as well ascaching. It ensure that the volume performance represents the best configuration for its intended use. Bydefault, a volume uses the default performance policy, which is for 4096 byte blocks with full compressionand caching enabled.

For replication volumes, the same performance policy must exist on each replication partner.

Block size should be set to match the application block size. If the application block size is not known, itshould be set to the largest common denominator of the majority of I/O requests. If in doubt, set low (minimum4KB), because setting it too high can reduce performance severely, while setting it too low reduces performanceby a small amount.

Caching should generally be enabled. It helps most with non-sequential (random) access. Caching shouldbe left on unless the volume is known to be either not read much or read sequentially (for example, a volumeholding log files). If caching is turned off, the array will not cache any data for the volume but it continues tocache internal metadata.

Compression can, and should, be left on unless the volume is known to hold mostly incompressible data. Inthis case, turning off compression will improve performance by a small amount.

Synopsis

perfpolicy --help

perfpolicy --list

perfpolicy --info policy_name

perfpolicy --create policy_name[--description text][--blocksize bytes][--compress {yes|no}][--cache {yes|no}][--cache_policy {normal|aggressive}][--space_policy {offline|non_writable}]

perfpolicy --edit policy_name[--newname policy_name][--description text][--compress {yes|no}][--cache {yes|no}][--cache_policy {normal|aggressive][--space_policy {offline|non_writable}]

perfpolicy --delete policy_name[--force]

Options



N/A--help


perfpolicy


GuestList all configured performancepolicies. Several predefined per-formance policies are provided,which are based on common applic-ation best practices.

N/A--list

GuestProvide detailed information aboutthe specified performance policy.

policy_name--info




OperatorCreate the specified performancepolicy. The block size of a perform-ance policy cannot be changedonce it has been created.

policy_name--create

Specify a description of the perform-ance policy. If there are spaces inthe description, enclose the text inquotation marks.


Specify a block size to be used forvolumes created with the specifiedperformance policy. Supportedblock sizes are 4096 bytes (4 KB),8192 bytes (8 KB), 16384 bytes (16KB), and 32768 bytes (32 KB). Ifyou do not specify this option, thedefault block size of 4096 bytes (4KB) is used. You cannot changethe after you create the perform-ance policy.

[--blocksize bytes]

Specify whether data in associatedvolumes should be compressed. Ifyou do not specify this option, thedefault of yes is used, and data iscompressed.

[--compress {yes|no}]

Specify whether data in associatedvolumes should be cached. If youdo not specify this option, the de-fault of yes is used, and data iscached.

[--cache {yes|no}]

[--cache_policy {normal|aggress-ive}]




Specify how data of an associatedvolume must be cached if datacaching is enabled. The normalpolicy caches data but skips undercertain conditions, such as sequen-tial I/O. The aggressive policy ac-celerates caching of all data that isassociated with this volume, regard-less of sequentiality. You want touse the aggressive policy duringthe initial copy of a dataset for anew volume. However, it maycause the data that is associatedwith other volumes to be evictedfrom cache sooner. It may alsocause greater wear on the flash-based cache over an extendedperiod of time. Therefore, you maywant to revert to normal cachingafter the data load has been com-pleted. If you do not specify thisoption, the default of normal isused.

Specify the state of the volumeupon a space-constraint violationsuch as volume quota violation,snapshot quota violation, volumesabove their volume reserve orsnapshot reserve if the pool freespace is exhausted. The "offline"space policy takes the volume off-line. The "non_writable" spacepolicy disallows write operations onthe volume, but allows unmap andread operations. If you do not spe-cify this option, the default of offlineis used.

[--space_policy {offline|non_writ-able}]




OperatorModify the specified performancepolicy. If there are spaces in thepolicy_name, enclose the value inquotation marks. Specify at leastone suboption.

policy_name--edit

Modify the name of the perform-ance policy

[--newname policy_name]

Modify the description of the per-formance policy.


Modify whether data in associatedvolumes should be compressed.

[--compress {yes|no}]

Modify whether data in associatedvolumes should be cached.

[--cache {yes|no}]

Modify the cache policy used whendata in associated volumes iscached.

[--cache_policy {normal|aggress-ive}]

Modify the space policy used.[--space_policy {offline|non_writ-able}]

PowerUser

Delete the specified performancepolicy. You cannot delete a perform-ance policy that is associated witha volume. Remove the associationbefore you delete the performancepolicy.

policy_name--delete

Forcibly delete the specified per-formance policy even if there arevolumes associated with it.

[--force]

Examples

This example lists the configured performance policies, including predefined policies.

Nimble OS $ perfpolicy --list---------------------------+----------+--------+-----+-----------------------Performance Policy Block Size Compress Cache Cache PolicyName (bytes)---------------------------+----------+--------+-----------------------------default 4096 Yes Yes normalExchange 2003 data store 4096 Yes Yes normalExchange 2007 data store 8192 Yes Yes normalExchange 2010 data store 32768 Yes Yes normalExchange log 16384 Yes No normalHyper-V CSV 4096 Yes Yes normalOracle OLTP 8192 Yes Yes normalSharePoint 8192 Yes Yes normalSQL Server 8192 Yes Yes normalSQL Server 2012 8192 Yes Yes normalSQL Server Logs 4096 Yes No normalVMware ESX 4096 Yes Yes normalVMware ESX 5 4096 Yes Yes normal



VMware VDI 4096 Yes Yes normalWindows File Server 4096 Yes Yes normal

This example shows details about the predefined performance policy named default.

Nimble OS $ perfpolicy --info defaultName: defaultDescription: Default performance policyBlock size: 4096 bytesCompress: YesCache: YesCache Policy: normalSpace Policy: offlineCreated: N/ALast configuration change: N/A

This example creates a performance policy that specifies a block size of16384 bytes and includes compression,but does not use cache.

Nimble OS $ perfpolicy --create bigblock--description "big block, no cache" --blocksize 16384 --cache no

This example modifies the performance policy named bigblock so that it uses cache.

Nimble OS $ perfpolicy --edit bigblock --cache yes

This example deletes performance policy after unassociating any associated volumes so that the --forceoption is not needed.

Nimble OS $ perfpolicy --delete bigblock



poolThe pool command options manage storage pools.

Synopsis

pool --help

pool --list

pool --info pool_name

pool --create pool_name--array array_name[--description text]

pool --edit pool_name[--description text][--name new_name]

pool --delete pool_name[--force]

pool --assign pool_name--array array_name

pool --unassign pool_name--array array_name[--force]

pool --merge pool_name--target target_pool

Options



N/A--help

GuestList all storage pools in the group.N/A--list

GuestShow detailed information aboutthe specified storage pool.

pool_name--info

PowerUser

Create a storage pool.pool_name--create

Specify which array to add to thestorage pool. To add multiple ar-rays, repeat this option as manytimes as needed.

--array array_name

Specify a plain-text description ofthe storage pool. If there arespaces in the description, enclosethe text in quotation marks.



pool


PowerUser

Modify the specified storage pool.Specify at least one suboption.

pool_name--edit

Modify the plain-text description ofthe specified storage pool.


Modify the name of the specifiedstorage pool.

[--name new_name]

PowerUser

Delete the specified storage pool.You cannot delete the default pool.Before you start to delete a pool,make sure that there are novolumes assigned to the pool. Usevol --list --pool pool_name to seeif the pool you plan to delete hasany volumes assigned to it. If anyvolumes are assigned, use vol--move to move those volumes toanother storage pool.

pool_name--delete

Forcibly delete the specified stor-age pool, even if it containsvolumes that were deleted butwhose space is still being re-claimed.

[--force]

PowerUser

Assign arrays to the specified stor-age pool.

pool_name--assign

Specify an array to add to the pool.To assign multiple arrays to thepool, repeat this option as manytimes as needed.

--array array_name

PowerUser

Unassign, or remove, arrays fromthe specified storage pool.

pool_name--unassign

Specify an array to remove fromthe pool. To unassign multiple ar-rays from the pool, repeat this op-tion as many times as needed.

--array array_name

Forcibly unassign the specified ar-ray or arrays from the pool even ifthe specified arrays are unreach-able.

[--force]




PowerUser

Merge the specified storage poolinto the specified target pool. Allvolumes on the specified pool aremoved to the target pool and thespecified pool is then deleted.Likewise, all arrays in the pool areassigned to the target pool. Thename of the newly merged pool isautomatically truncated to a maxim-um of 255 characters.

pool_name--merge

Specify the target, or destination,pool into which the storage pool ismerged.

--target target_pool

Examples

This example lists all configured storage pools. In this example, only the default storage pool appears.

Nimble OS $ pool --list--------------+-----------+----------+-----------------------------------------Pool Capacity(MB) Usage(MB) Arrays--------------+-----------+----------+-----------------------------------------default 15738305 2719551 array7

This example shows detailed information about the default group.

Nimble OS $ pool --info defaultPool Name: defaultPool Description: Default poolCreated: N/ALast configuration change: N/AArrays in the pool:Array mktg, Capacity (MB): 185502916, Usage (MB): 11468728Array sales, Capacity (MB): 65394722, Usage (MB): 8399605Arrays being unassigned from the pool:Pool capacity (MB): 250897638Pool cache capacity (MB): 305152Pinnable cache capacity (MB): 662Pinned cache capacity (MB): 0Pinned volumes :Pool usage (MB): 19868333Pool unused reserve (MB): 20482561Pool free space (MB): 210546744Volumes in the pool: vol10,vol11,SQL-2012-Server,SQL-2012-Server-Data,SQL-2012-Server-LogSnapshot collection count: 1200Snapshot count: 7092

This example creates a storage pool named marketing that includes the array named array7.

Nimble OS $ pool --create marketing --array array7

This example changes the name of the marketing storage pool to marketingteam.

Nimble OS $ pool --edit marketing --name martketingteam

This example deletes a storage pool named marketingteam.



Nimble OS $ pool --delete marketingteam

This example assigns an array named MKT2 to the storage pool named marketingteam.

Nimble OS $ pool --assign marketingteam --array MKT2

This example unassigns an array named MKT2 from the storage pool named marketingteam.

Nimble OS $ pool --unassign marketingteam --array MKT2

This example merges the storage pool named marketingteam into the storage pool named corporatepool.

Nimble OS $ pool --merge marketingteam --target corporatepool



prottmplThe prottmpl command options manage protection templates, on which volume collection schedules andretention are based. You cannot edit or delete the protection templates provided by Nimble Storage.

Protection templates provide a way to create a set of data protection policies that meet specific goals, andapply them as volumes and collections are created. Protection templates consist of sets of snapshotsschedules, replication schedules, and retention limits. They prefill the protection information when creatingvolume collections. You can create protection templates as needed, but you cannot edit or delete the predefinedprotection templates.

All the volumes assigned to a collection use the same settings for schedules and retention, so the snapshotsand replications trigger for all volumes in the collection simultaneously.

After a volume collection is created, changes to it do not affect the template. Changes to the template do notaffect previously created volume collections.

Synopsis

prottmpl --help

prottmpl --list

prottmpl --info template_name

prottmpl --create template_name[--description text]--app_sync {none|vss|vmware}[--app_server server][--app_id {exchange|sql2005|sql2008|sql2012|exchange_dag|sql2014}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username user_name][--vcenter_password password]--schedule name--repeat period--repeat_unit {minutes|hours|days|weeks}[--at time][--until time][--days {all|day1,day2,...}][--retain number][--replicate_to partner][--replicate_every number][--num_retain_replica number][--alert_threshold hh:mm][--snap_verify {yes|no}][--skip_db_consistency_check {yes|no}][--disable_appsync {yes|no}][--external_trigger {yes|no}]

prottmpl --edit template_name[--newname template_name][--description text][--app_sync {none|vss|vmware}]


prottmpl

[--app_server server][--app_id {exchange|sql2005|sql2008|sql2012|exchange_dag|sql2014}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username user_name][--vcenter_password password]

prottmpl --delete template_name

prottmpl --addsched template_name--schedule name--repeat period--repeat_unit {minutes | hours | days | weeks}[--at time][--until time][--days {all | day1,day2,...}][--retain number][--replicate_to partner][--replicate_every number][--num_retain_replica number][--alert_threshold hh:mm][--snap_verify {yes|no}][--skip_db_consistency_check {yes|no}][--disable_appsync {yes|no}][--external_trigger {yes|no}]

prottmpl --editsched template_name--schedule name[--newname name][--repeat period][--repeat_unit {minutes|hours|days|weeks}][--at time][--until time][--days {all|day1,day2,...}][--retain number][--replicate_to partner][--replicate_every number][--num_retain_replica number][--alert_threshold hh:mm][--snap_verify {yes|no}][--skip_db_consistency_check {yes|no}][--disable_appsync {yes|no}][--external_trigger {yes|no}]

prottmpl --deletesched template_name--schedule schedule_name

Options



N/A--help




GuestList protection templates.N/A--list

GuestProvide detailed information aboutthe specified protection templateand its schedules.

template_name--info




OperatorCreate the specified protectiontemplate.

template_name--create

Specify a plain-language descrip-tion of the protection template. Thisis useful to specify what the protec-tion template was designed to op-timize. If there are spaces in thedescription, enclose the text inquotation marks.


Define the application synchroniza-tion to apply. If you specify vsssynchronization, supply the --app_*credentials. If you specify vmwaresynchronization, supply the--vcenter_* credentials.

--app_sync {none|vss|vmware}

Specify the application server whenvss synchronization is enabled.

[--app_server server]

Define the application running onthe server when vss synchroniza-tion is enabled.

[--app_id {ex-change|sql2005|sql2008|sql2012|ex-change_dag|sql2014}]

Specify the cluster name if the ap-plication that uses vss synchroniz-ation is running within a Windowsclustering environment.

[--app_cluster_name cluster_name]

Specify the instance name of theservice if the application that usesvss synchronization is runningwithin a Windows clustering envir-onment.

[--app_service_name ser-vice_name]

Specify the host name of thevCenter server with which theNimble array will communicatewhen vmware synchronization isenabled.

[--vcenter_hostname server]

Specify the Windows user name touse to create a Nimble account onthe vCenter server when vmwaresynchronization is enabled.

[--vcenter_username user_name]

Specify the password associatedwith the user name when vmwaresynchronization is enabled.

[--vcenter_password password]

Specify the snapshot schedule toassociate with this protection tem-plate. Use --addsched to add moreschedules to the protection tem-plate after creating it.

--schedule name

--repeat period




Specify the frequency of snapshotsevery --repeat_unit. If you do notspecify this option, the defaultvalue of 1 is used.

Specify the unit of time for --repeatto define the frequency of snap-shots. If you do not specify this op-tion, the default value of days isused.

--repeat_unit{minutes|hours|days|weeks}

Specify the time of day to start tak-ing snapshots. If you do not specifythis option, the default value of12:00 (midnight) is used.

[--at time]

Specify the time of day to stop tak-ing snapshots. If you do not specifythis option, the default value of11:59 (PM) is used if a stop time isappropriate for the repeat unit. Forexample, if you take snapshotsonce daily, you do not need thisoption.

[--until time]

Specify on which days to takesnapshots unless the repeat unit isweeks. You can enter a comma-separated list of days, such asMon,Wed,Fri. If you do not specifythis option, the default value of allis used.

[--days {all|day1,day2,...}]

Specify the maximum number ofsnapshots to keep. After this num-ber is reached, older snapshots canbe deleted to make room for newones if the space is needed. If rep-lication is enabled on this schedule,the array always retains the latestreplicated snapshot.

[--retain number]

Specify the replication partner forreplicated snapshots. Use part-ner --create on both arrays toconfigure replication partners.

[--replicate_to partner]

Specify that a certain number ofsnapshots assigned to the sched-ule should be replicated. For ex-ample, setting this to 5 replicatesevery fifth snapshot. If snapshotsare replicated and you do not spe-cify this option, all snapshots arereplicated.

[--replicate_every number]

Specify the number of snapshotsto retain on the replication partner.

[--num_retain_replica number]




[--alert_threshold hh:mm] If replicating a snapshot takes morethan this amount of time to com-plete, an alert will be generated. Ifyou do not specify this option, thedefault of 24 hours is used. Enter00:00 to disable this alert.

Specify whether to run a verificationtool on snapshots created by thisschedule. Use this option withsnapshot schedules of a volumecollection that has application syn-chronization. The tool used to verifysnapshots depends on the type ofapplication. For example, if the ap-plication synchronization is vss andthe application ID is exchange, theeseutil tool is run on the snap-shots. If verification fails, the logsare not truncated.

[--snap_verify {yes|no}]

Specify whether to skip consistencychecks for database files on snap-shots created by this schedule. Usethis option with snapshot schedulesof a volume collection that has ap-plication synchronization of vss, theapplication ID is exchange_dag.(MS Exchange 2010 or later usingDatabase Available Group),--snap_verify is set to yes, and--disable_appsync is set to no.

[--skip_db_consistency_check{yes|no}]

Specify whether to disable applica-tion-synchronized snapshots andcreate crash-consistent snapshotsinstead.

[--disable_appsync {yes|no}]

Specify whether to use an extern-ally driven schedule with no internaltimers to create manual snapshots.

[--external_trigger {yes|no}]




OperatorModify the specified protectiontemplate. New volume collectionsbased on the template are affectedby the modifications, but existingvolume collections are not. Specifyat least one suboption.

template_name--edit

Modify the name of the protectiontemplate.

[--newname template_name]

Modify the plain-language descrip-tion of the protection template.


Modify the application synchroniza-tion to apply.


Modify the application server forvss synchronization.


Modify the application running onthe server for vss synchronization.


Modify the cluster name if the ap-plication that uses vss synchroniz-ation is running within a Windowsclustering environment.


Modify the instance name of theservice if the application that usesvss synchronization is runningwithin a Windows clustering envir-onment.


Modify the host name of the vCen-ter server with which the Nimblearray communicates for vmwaresynchronization.


Modify the Windows user name forvmware synchronization.


Modify the password associatedwith the user name for vmwaresynchronization.


OperatorDelete the specified protectiontemplate.

template_name--delete




OperatorAdd a schedule to the specifiedprotection template.

template_name--addsched

Specify the name of the snapshotschedule to associate with thisprotection template.

--schedule name

Specify the frequency of snap-shots. If you do not specify this op-tion, the default value of 1 is used.

--repeat period




[--at time]


[--until time]

Specify the days on which to takesnapshots unless the repeat unit isweeks. You can enter a comma-separated list of days, such asMon,Wed,Fri. If you do not specifythis option, the default value of allis used.



[--retain number]










If replicating a snapshot takes morethan this amount of time to com-plete, an alert will be generated. Ifyou do not specify this option, thedefault of 24 hours is used. Enter00:00 to disable this alert.

[--alert_threshold hh:mm]



Specify whether to skip consistencychecks for database files on snap-shots created by this schedule. Usethis option with snapshot schedulesof a volume collection that has ap-plication synchronization of vss, theapplication ID is exchange_dag.(MS Exchange 2010 or later usingDatabase Available Group),--snap_verify is set to yes, and--disable_appsync is set to no.









OperatorModify the specified schedule onthe specified protection template.Specify at least one suboption inaddition to --schedule name.

template_name--editsched

Specify the name of the snapshotschedule to modify.

--schedule name

Modify the name of the snapshotschedule.

[--newname name]

Modify the frequency of snapshotswithin each --repeat_unit.

[--repeat period]

Modify the unit of time for --repeatto define the frequency of snap-shots.

[--repeat_unit{minutes|hours|days|weeks}]

Modify the time of day to start tak-ing snapshots.

[--at time]

Modify the time of day to stop tak-ing snapshots.

[--until time]

Modify the days on which to takesnapshots unless the repeat unit isweeks.

[--days ]

Modify the maximum number ofsnapshots to keep.

[--retain number]

Modify the replication partner forreplicated snapshots.


Modify that a certain number ofsnapshots assigned to the sched-ule should be replicated.


Modify the number of snapshots toretain on the replication partner.


Modify whether to generate an alertif replicating a snapshot takes morethan this amount of time to com-plete.


Modify whether to run a verificationtool on snapshots created by thisschedule.


Modify whether to skip consistencychecks for database files on snap-shots created by this schedule.


Modify whether to disable applica-tion-synchronized snapshots andcreate crash-consistent snapshotsinstead.






Modify whether to use an externallydriven schedule with no internaltimers to create manual snapshots.

OperatorDelete the specified schedule fromthe specified protection template.

template_name--deletesched

Specify the schedule to delete.--schedule schedule_name

Examples

This example lists available protection templates. In this example, only the predefined templates exist.

Nimble OS $ prottmpl --list------------------------------------+-----------------------------------------Protection Template ApplicationName Synchronization------------------------------------+-----------------------------------------Retain-30Daily noneRetain-48Hourly-30Daily-52Weekly noneRetain-90Daily none

This example shows detailed information about the Retain-30Daily protection template.

Note This protection template is one of the predefined templates, so you cannot modify or delete it.

Nimble OS $ prottmpl --info Retain-30DailyName: Retain-30DailyDescription: Provides daily snapshots retained for 30 daysApplication synchronization: noneApplication server: N/AApplication ID: N/ACluster name: N/AService name: N/AVMware vCenter hostname: N/AVMware vCenter username: N/AVMware vCenter password: N/ACreated: N/ALast configuration change: N/ASchedule Name: daily

Description:Type: Nimble ScheduleRepeats: 1 day(s)At: 0:00:00 a.m.Until: N/ADays: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayNumber of snapshots to retain: 30Snapshot verification: N/ASkip database consistency check: N/ADisable appsync: NoNumber of snapshots to retain on replica: 0Replicate every: N/AReplicate to:Alert threshold: 24:00Created: N/ALast configuration change: N/ALast timing configuration change: N/A

This example creates a new protection template named highrepl.



Nimble OS $ prottmpl --create highrepl--description "use when high replication is needed"--app_sync none --schedule replicated --repeat 1 --repeat_unit day--days Monday,Tuesday,Thursday --retain 8 --replicate_to array7--replicate_every 1 --num_retain_replica 40 --snap_verify no

This example modifies the protection template named highrepl to replicate once a week, and to retain 31snapshots and 52 replicas.

Nimble OS $ prottmpl --edit highrepl --schedule replicated--repeat 1 --repeat_unit weeks --retain 31 --replicate_to array7--replicate_every 1 --num_retain_replica 52 --snap_verify no

This example deletes a protection template named highrepl.

Nimble OS $ prottmpl --delete highrepl

This example adds an hourly schedule to the protection template named highrepl.

Nimble OS $ prottmpl --addsched highrepl--schedule hourly --repeat 1 --repeat_unit hours--retain 25 --snap_verify no

This example modifies the hourly schedule that is associated with the protection template named highrepl.

Nimble OS $ prottmpl --editsched highrep --schedule hourly--repeat 2 --repeat_unit hours

This example removes a schedule named hourly from the protection template named highrepl.

Nimble OS $ prottmpl --deletesched highrepl --schedule hourly



rebootThis command reboots an entire group of arrays, an array, or a controller. If you want to stop I/O traffic withoutrebooting, you must use the halt command. The reboot command causes a reboot without a power cycle.

Synopsis

reboot --help

reboot --array array_name[--controller {A|B|][--non_interactive]

reboot --group[--non_interactive]

Options



N/A--help

PowerUser

Reboot the specified array.array_name--array

Reboot the specified controller onan array. Valid controller namesare A and B, which are case sens-itive. If you do not specify this op-tion, both controllers on the spe-cified array are rebooted.

[--controller {A|B|]

Override the default behavior ofhaving to type "yes" to completethe command. Use this suboptionwith care to avoid unexpectedlytaking the array or controller offlinefor a short time and disrupting clientconnections.

--non_interactive

PowerUser

Reboot the entire group when yourun this command on the groupleader. If any array fails to respondto the reboot request, then thegroup leader array remains opera-tional.

N/A--group

Override the default behavior ofhaving to type "yes" to completethe command. Use this suboptionwith care to avoid unexpectedlytaking the group offline for a shorttime and disrupting client connec-tions.

--non_interactive


reboot

Examples

This example cancels rebooting the array where you are logged in.

Nimble OS $ rebootWARNING: This operation will reboot the array.Type yes to continue, no to cancel: noINFO: Canceling reboot

This example reboots the group without prompting for confirmation. You must run this command on the groupleader array.

Nimble OS $ reboot --group --non_interactive



routeThe route command options manage network routes. Specify a network route either in "network/netmask"(dotted quad) format (for example, 10.12.0.100/255.255.0.0) or "network/mask_bits" (slash) format (forexample, 10.12.0.100/16). When the system must connect to a remote array or host, it checks the routingtable to determine if a known path exists. If the remote system is in a subnet to which the system has access,it tries to connect along that interface.

Synopsis

route --help

route --list[--netconfig {active|backup|draft}]

route --info network_route[--netconfig {active|backup|draft}]

route --add network_route--netconfig {active|backup|draft}--gateway gateway

route --edit network_route[--netconfig {active|backup|draft}][--network network_route][--gateway gateway]

route --delete network_route[--netconfig {active|backup|draft}]

Options



N/A--help

GuestList all configured routes.--list

List all configured routes on thespecified network configuration.


GuestProvide detailed information aboutthe specified network route. Theroute is Destination/Netmask fromthe --list output.

network_route--info

Provide detailed information aboutthe specified network route on thespecified network configuration.


PowerUser

Add the specified network route.network_route--add

Add the specified network route onthe specified network configuration.

--netconfig {active|backup|draft}

Add the specified network route forthe specified gateway.

--gateway gateway


route


PowerUser

Modify the specified network route.Specify at least one suboption.

network_route--edit

Modify the specified network routeon the specified network configura-tion.


Modify the specified network routefor a new destination network.

[--network network_route]

Modify the specified network routefor the specified gateway.

[--gateway gateway]

PowerUser

Delete the specified network route.network_route--delete

Specify the network configurationfrom which to delete the specifiednetwork route.


Examples

This example lists the routes in the active network configuration.

Nimble OS $ route --list --netconfig active---------------+---------------+---------------Destination Netmask Gateway---------------+---------------+---------------0.0.0.0 0.0.0.0 10.12.12.110.1.0.0 255.255.255.0 10.11.0.2

This example provides detailed information about one route. Notice how the network_route value isDestination/Netmask from the --list output.

Nimble OS $ route --info 10.1.0.0/255.255.255.0Destination: 10.1.0.0Netmask: 255.255.255.0Gateway: 10.11.0.2

This example adds a network route to the draft network configuration.

route --add 10.12.134.209/255.255.0.0 --gateway 0.12.0.0--netconfig draft

This example edits a network route.

route --edit 0.12.134.209/255.255.0.0 --network 10.12.136.209/255.255.0.0--gateway 10.12.0.0

This example deletes the route at 0.0.0.0/0.0.0.0.

Nimble OS $ route --delete 0.0.0.0/0.0.0.0



setupThe setup command options configure an array.

You can set up an array with the interactive setup wizard on the command line. To learn more about usingthe interactive setup wizard, see the Nimble OS Installation and Configuration Guide. Alternatively, you canspecify the options on the command line as described here. If you use the non-interactive command line,then you must specify all mandatory settings as command line options.

Note Some options do not appear to be mandatory in the --help output and man page to accommodaterunning the same setup command on both iSCSI and Fibre Channel arrays. Read the option descriptionsto see whether a specific option is mandatory for the access protocol you are using.

Synopsis

setup --help

setup[--group_name group_name]--name array_name[--domainname domain_name][--dnsserver server][--ntpserver server][--timezone zone]--mgmt_ipaddr ip_addr--subnet_label label--subnet_addr network/netmask[--subnet_type {mgmt|data|mgmt,data}][--subnet_mtu mtu]--default_gateway ip_addr[--data_ipaddr ip_addr][--discovery_ipaddr ip_addr][--support_ipaddr ip_addr][--iscsi_automatic_connection_method {yes|no}][--iscsi_connection_rebalancing {yes|no}]--accept_license[--view_license]

Options



N/A--help


setup


Adminis-trator

Specify the name of a group. Asingle-array group is by defaultnamed the default group.

[--group_name group_name]

Specify the name of this array.--name array_name

Specify a DNS domain name.[--domainname domain_name]

Specify the IP address of the DNSserver to use. Repeat this optionto specify IP addresses for multipleDNS servers.

[--dnsserver server]

Specify a host name or an IP ad-dress for the NTP server to use.

[--ntpserver server]

Specify a time zone for this array.[--timezone zone]

Specify a management IP address.--mgmt_ipaddr ip_addr

Specify a subnet on a NIC.--subnet_label

Specify the subnet IP address.--subnet_addr

Specify the subnet type. Configureat least one data subnet on iSCSIarrays. You can configure morethan one. On iSCSI arrays, datasubnets are used extensively. OnFibre Channel arrays, data subnetsare optimal for handling replicationtraffic and are required for intra-group communication in multi-arraygroups. In a single-array FibreChannel group, a data subnet isoptional. Use the managementsubnet for replication.

[--subnet_type {mgmt|data|mg-mt,data}]

Specify the subnet maximumtransmission unit (MTU). If you donot specify this option, the defaultof 1500 is used.

[--subnet_mtu mtu]

Specify the default gateway IP ad-dress.

--default_gateway ip_addr

Specify the data IP address. Con-figure at least one data IP on iSCSIarrays. On Fibre Channel arrays,you can specify an IP address, orleave the value empty(--data_ipaddr ''), to bypass thisoption. If IP addresses are spe-cified on Fibre Channel arrays, thedata IPs are used for handling rep-lication traffic and intra-group com-munication.

[--data_ipaddr ip_addr]

[--discovery_ipaddr ip_addr]




Specify the discovery IP address.If you do not specify this option, themanagement IP address is used.

Specify the support IP address. In-clude this argument twice. Thenthe first IP address entered is as-signed to Controller A and thesecond to Controller B. You mustassign static IP addresses to allowarray access if the management IPaddress is not accessible.

[--support_ipaddr ip_addr]

Redirect connections to the bestdata IP address based on connec-tion counts. If you do not specifythis option on an iSCSI array, thedefault of yes is used. This optionhas no effect in a Fibre Channelarray.

[--iscsi_automatic_connec-tion_method {yes|no}]

Rebalance the iSCSI connectionby periodically breaking existingconnections that are out of bal-ance. If you do not specify this op-tion on an iSCSI array, the defaultof yes is used. This option has noeffect in a Fibre Channel array.

[--iscsi_connection_rebalancing{yes|no}]

Accept the terms and conditions ofuse, the end user license agree-ment (EULA), and third-party soft-ware notices.

--accept_license

List the terms and conditions ofuse, the EULA, and third-partysoftware notices.

[--view_license]

Examples

This example non-interactively sets up an iSCSI array. To learn more about using the interactive setup, seethe Nimble Storage Installation and Configuration Guide.

Nimble OS $ setup --group_name default \--name array7 \--domainname admin.nimblestorage.com \--dnsserver 8.8.8.8 \--ntpserver time.nimblestorage.com \--timezone America/Los_Angeles--subnet_addr 10.12.147.253/255.255.0.0 --subnet_type management,data \--subnet_addr 10.12.155.253/16 --subnet_type management,data \--subnet_addr 10.12.0.0/255.255.0.0 --subnet_type management,data \--subnet_addr 10.12.0.0/16 --subnet_type management,data \--mgmt_ipaddr 10.12.147.253 \--discovery_ipaddr 10.12.145.253 \--support_ipaddr 10.12.149.253 \--support_ipaddr 10.12.151.253 \--data_ipaddr 10.12.153.253 \



--data_ipaddr 10.12.155.253 \--data_ipaddr 10.12.157.253 \--data_ipaddr 10.12.159.253 \--default_gateway 10.12.255.254 \--accept_license



shelfThe shelf command options manage expansion shelves on an array.

Synopsis

shelf --help

shelf --list--array array_name[--ctrlr {A|B}]

shelf --info serial_number--array array_name[--verbose]

shelf --show_topology--array array_name[--ctrlr {A|B}]

shelf --add serial_number--array array_name[--force]

shelf --activate serial_number--array array_name[--force]

Options



N/A--help

GuestList expansion shelves on the spe-cified array.

--array array_name--list

List expansion shelves on the spe-cified controller on the specifiedarray.

[--ctrlr {A|B}]

GuestProvide detailed information aboutthe specified expansion shelf onthe specified array. Get the seri-al_number from --list output.

serial_number --array array_name--info

Show additional information aboutthe specified expansion shelf.

[--verbose]

GuestShow the topology that all shelveson the specified array are connec-ted on.

--array array_name--show_topology

Show the topology that all shelveson the specified controller on thespecified array are connected on.

[--ctrlr {A|B}]


shelf


PowerUser

Add the specified expansion shelfto the specified array. Get the seri-al_number from the label on theshelf. Once you add an expansionshelf to an array, you cannot re-move it.

serial_number --array array_name--add

Forcibly add the specified expan-sion shelf to the specified array.

[--force]

PowerUser

Activate the specified expansionshelf on the specified array. Activ-ating an expansion shelf preparesand formats it to store user data.

serial_number --array array_name--activate

Forcibly activate the specified ex-pansion shelf on the specified ar-ray.

[--force]

Examples

This example lists the expansion shelves on an array named array7.

Nimble OS $ shelf --list --array array7-----------+---------+-------+---------+-------+-------+-------+---------Serial # Model State Location Power Fans Temp Is Flash

Supply Status Status ShelfStatus

-----------+---------+-------+---------+-------+-------+-------+---------AC-109019 CS700 online A.0 OK OK OK NoAC-103333 ES1-H65 online A.P1.1 OK OK OK NoAC-103322 ES1-H65 online A.P2.1 OK OK OK NoAC-109019 CS700 online B.0 OK OK OK NoAC-103333 ES1-H65 online B.P1.1 OK OK OK NoAC-103322 ES1-H65 online B.P2.1 OK OK OK No

This example shows detailed information about one expansion shelf on an array named array7. The outputis truncated to save space.

Nimble OS $ shelf --info AC-109019 --array array7Serial #: AC-109019Model: CS70025922 2014-09-05,18:56:52.882370-07 ERROR: plat:_plat_get_hw_nvram_card_type:Failed to open /proc/bus/pci/devices (errno 2)Extended Model: CS700-2T4F-48T-3200FSIs Flash Shelf: NoLocation: A.0 B.0State: onlineUsable capacity (MB): 32001478Raw capacity (MB): 45785374Usable cache capacity (MB): 3052288Raw cache capacity (MB): 3052391Power supply: OK

power-supply1 at left rear: OKpower-supply2 at right rear: OK

Cooling fans: OKfan1-A at lower front of controller A: 11772 rpmfan2-A at lower left rear of controller A: 11908 rpmfan3-A at lower right rear of controller A: 12223 rpm



fan4-A at upper right front of controller A: 11670 rpmfan5-A at upper left front of controller A: 12053 rpmfan6-A at upper left rear of controller A: 12061 rpmfan1-B at lower front of controller B: 9486 rpmfan2-B at lower left rear of controller B: 10242 rpmfan3-B at lower right rear of controller B: 10072 rpmfan4-B at upper right front of controller B: 9758 rpmfan5-B at upper left front of controller B: 9851 rpmfan6-B at upper left rear of controller B: 9928 rpm

Temperature sensors: OKmotherboard-A at motherboard: 38 degree Cbp-temp1-A at left-side backplane: 24 degree Cmotherboard-B at motherboard: 38 degree Cbp-temp2-B at right-side backplane: 20 degree C

Location on A: 0Location on B: 0Hardware state of A: readyHardware state of B: readyShelf sw type of A: Head ShelfShelf sw type of B: Head ShelfLast known disk set:Number of disks: 16......

This example shows the topology of expansion shelves on controller A of an array named array7.

Nimble OS $ shelf --show_topology --array array7 --ctrlr A[AC-109019].A.SAS PORT1 --> [AC-103333].A.IN[AC-109019].A.SAS PORT2 --> [AC-103322].A.IN

This example adds an expansion shelf to an array named array7.

Nimble OS $ shelf --add AA-102081 --array array7

This example activates an expansion shelf on an array named array7.

Nimble OS $ shelf --activate AA-102081 --array array7



snapThe snap command options manage snapshots.

Snapshots are point-in-time copies of volumes that can be brought online and used immediately, cloned, andreplicated. The initial snapshot shares its original data with the volume from which it was created. Eachsuccessive snapshot consumes some space when it captures the changes that occurred on the volume. Thechanged blocks remain compressed, so snapshot capacity consumption is efficient.

Stagger snapshot schedules to ensure that application synchronization, I/O quiescing, database verification,and similar actions have time to complete before the next schedule starts.

Synopsis

snap --help

snap --list[--vol volume_name][--all]

snap --info snap_name--vol volume_name

snap --edit snap_name--vol volume_name[--name new_name][--description text]

snap --online snap_name--vol volume_name

snap --offline snap_name--vol volume_name[--force]

snap --cksum snap_name--vol volume_name

snap --delete snap_name--vol volume_name

Options



N/A--help

GuestList snapshots for the specifiedvolume. Specify this suboption or--all, not both.

[--vol volume_name]--list

List snapshots for all volumes.Specify this suboption or --volvolume_name, not both.

[--all]


snap


GuestProvide detailed information aboutthe specified snapshot in the spe-cified volume.

snap_name --vol volume_name--info

OperatorModify the specified snapshot.Specify at least one suboption.

snap_name --vol volume_name--edit

Modify the name of the specifiedsnapshot.

[--name new_name]

Modify the description of the spe-cified snapshot or adds a descrip-tion to it. If there are spaces in thedescription, enclose the text inquotation marks.


OperatorBring the specified snapshot online.snap_name --vol volume_name--online

OperatorTake the specified snapshot offline.Initiators cannot connect to asnapshot that is offline. Taking asnapshot offline fails if there areopen connections from initiatorsunless --force is used.

snap_name --vol volume_name--offline

Forcibly take the specified snap-shot offline even if it has openconnections.

[--force]

OperatorCompute the checksum of thespecified snapshot to verify dataintegrity.

snap_name --vol volume_name--cksum

PowerUser

Delete the specified snapshot.Snapshots must be offline to bedeleted.

snap_name --vol volume_name--delete

Examples

This example lists snapshots for the volume named vdi. The output is truncated to avoid line wrapping.

Nimble OS $ snap --list --vol vdi---------+--------------------+----------+------+-------+------------Volume Snapshot Size Online Status New DataName Name (MB) (MB)---------+--------------------+----------+------+-------+------------vdi vdi-volcoll-vdi-volcoll-2014-09-05::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-09-04::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-09-02::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-09-01::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-08-31::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-08-30::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-08-29::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-08-28::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-08-27::00:00:00.000 4194304...vdi vdi-volcoll-vdi-volcoll-2014-08-22::00:00:00.000 4194304...

This example provides detailed information about the specified snapshot.



Nimble OS $ snap --info 9lives-vc1-daily-2014-09-05::00:00:00.000 --vol 9livesName: 9lives-vc1-daily-2014-09-05::00:00:00.000Volume name: 9livesSerial number: cdf437b74e248c706c9ce9003e217f89iSCSI target:Description: Replicated by protection policy 9lives-vc1 schedule dailySize (MB): 994304Status: OkayAllow writes: NoOnline: NoOffline reason: UserNew data (MB): 0New data compression: N/ANumber of connections: 0

iSCSI: 0FC: 0

Schedule: dailyOrigination group name/ID: 9livesIs replica: YesReplication status: N/ACreated: Sep 5 2014 00:01:13Last configuration change: Sep 5 2014 00:05:28Access Control List:Initiators connected:

This example modifies a snapshot to add a description and give it a simpler name.

Nimble OS $ snap --edit9lives-vc1-daily-2014-09-05::00:00:00.000 --vol 9lives--newname snapforreplica05--description "snapshot taken on the 5th, for replication"

This example brings a snapshot online.

Nimble OS $ snap --online9lives-vc1-daily-2014-09-05::00:00:00.000 --vol 9lives

This example takes a snapshot offline.

Nimble OS $ snap --offline9lives-vc1-daily-2014-09-05::00:00:00.000 --vol 9lives

This example verifies data integrity of the snapshot named 9lives-vc1-daily-2014-09-05::00:00:00.000.

Nimble OS $ snap --cksum 9lives-vc1-daily-2014-09-05::00:00:00.000--vol 9lives

INFO: Computing checksum for snapshot9lives-vc1-daily-2014-09-05::00:00:00.000 of volume 9lives...

Checksum(v1.4): 0xffffffff

This example deletes the snapshot named 9lives-vc1-daily-2014-09-05::00:00:00.000.

Nimble OS $ snap --delete 9lives-vc1-daily-2014-09-05::00:00:00.000--vol 9lives



snapcollThe snapcoll command options manage snapshot collections. Snapshot collections are associated withvolume collections.

Snapshot collections are replicated in the order that the collections were taken. If a snapshot cannot bereplicated, the system indefinitely attempts to complete the replication. These pending snapshot collectionsare not deleted by the system, but they can be manually deleted after pausing the replication partner.

Except when initiated manually, snapshot collections are not created by the admin user; the system createsthem after successful snapshot schedules complete. These snapshot collections are named with the volumecollection name, schedule, and timestamp.

Synopsis

snapcoll --help

snapcoll --list[--volcoll volcoll_name]

snapcoll --info snapcoll_name[--volcoll volcoll_name]

snapcoll --edit snapcoll_name[--volcoll volcoll_name][--name new_name][--description text][--replicate {yes|no}]

snapcoll --delete snapcoll_name[--volcoll volcoll_name]

Options



N/A--help

GuestList all snapshot collections.N/A--list

List all snapshot collections associ-ated with the specified volume col-lection. Use volcoll --list to getvalues for volcoll_name.

[--volcoll volcoll_name]

GuestProvide detailed information aboutthe specified snapshot collection.

snapcoll_name--info

Provide detailed information aboutthe specified snapshot collectionassociated with the specifiedvolume collection.



snapcoll


OperatorModify the specified snapshot col-lection.

snapcoll_name--edit

Modify the specified snapshot col-lection associated with the spe-cified volume collection..


Modify the name of the specifiedsnapshot collection.

[--name new_name]

Modify the plain-language descrip-tion of the specified snapshot col-lection. This is useful to identifywhat the snapshot collection wasdesigned to optimize. If there arespaces in the description, enclosethe text in quotation marks.


Enable or disable replication for thespecified snapshot collection.

[--replicate {yes|no}]

PowerUser

Delete the specified snapshot col-lection.

snapcoll_name--delete

Delete the specified snapshot col-lection associated with the spe-cified volume collection.


Examples

This example lists the snapshot collections for the volume collection named TestRep.

Nimble OS $ snapcoll --list --volcoll TestRep-----------------+-----------------------------------+-------+-----------Volume Collection Snapshot Collection Num ReplicationName Name Snaps Status-----------------+-----------------------------------+-------+-----------TestRep TestRep-FiveMinutes-2010-12-28::11:50:00.000 1 PendingTestRep TestRep-FiveMinutes-2010-12-28::11:45:00.000 1 PendingTestRep TestRep-FiveMinutes-2010-12-28::11:40:00.000 1 In-progressTestRep TestRep-FiveMinutes-2010-12-28::11:35:00.000 1 Complete

This example shows information about a collection of daily snapshots on a volume collection namedvolume1--1754979654.

Nimble OS $ snapcoll --info volume1--1754979654-daily-2014-07-16::00:00:00.000--volcoll volume1--175497654Name: volume1--175497654-daily-2014-07-16::00:00:00.000Description: Created by protection policy volume1--175497654 schedule dailyVolume collection name: volume1--1754979654Origination group name/ID: group-c20-array2Is replica: NoIs complete: YesIs manual: NoIs externally triggered: NoReplication status: N/AReplication started: N/AReplication completed: N/A



Created: Jul 16 2014 00:00:00Snapshots:

Volume: volume1Snapshot: volume1--1754979654-daily-2014-07-16::00:00:00.000

This example changes the name and replication setting for a snapshot collection named XCHG.

Nimble OS $ snapcoll --edit XCHG --name EXCHANGE--volcoll volume1--1754979654 --replicate no

This example deletes the snapshot collection named TestRep on the volume collection Rep1.

Note Snapshot collections cannot be deleted if they are in use by replication. If needed, pause or unconfigurereplication to delete a snapshot collection.

Nimble OS $ snapcoll --delete TestRep --volcoll Rep1



softwareThe software command options manage the Nimble software that is installed on an array.

You can download, upload, cancel an upload, and monitor software update status in real time.

You can have the currently installed version and one update version downloaded and ready for installation.Only one newer version can be stored at a time.

If your array does not have Internet access, you must download the software from the Nimble Storage Supportsite.

Synopsis

software --help

software --list

software --info version[--view_license]

software --download version[--force]

software --download_status[--interval seconds]

software --cancel_download

software --precheck[--force]

software --update[--force][--accept_license]

software --update_status[--verbose]

software --resume_update[--accept_license]

Options



N/A--help

GuestList all available software images.N/A--list


software


GuestProvide detailed information aboutthe specified software version.

version--info

Show the terms and conditions ofuse, the end user license agree-ment (EULA), and third-party soft-ware notices for the specified soft-ware version.

[--view_license]

PowerUser

Start to download the specifiedsoftware version.

version--download

Forcibly download the currentlyrunning software version.

[--force]

PowerUser

Show the status of a softwaredownload.

--download_status

Specify the number of secondsafter which to refresh the status.Set this to 0 (zero) to disable thestatus refresh messages.

[--interval seconds]

PowerUser

Cancel a software download.N/A--cancel_download

PowerUser

Perform verification checks on thearray to verify that a software up-date can succeed.

--precheck

Perform most verification checks,but skip the checks that can beoverridden during the update byusing the --force option then.

[--force]

PowerUser

Start to update the array to thedownloaded software version.

--update

Forcibly start the software update,even if it might cause I/O errors onactive volumes by restarting theactive controller.

[--force]

Accept the terms and conditions ofuse, the EULA, and third-partysoftware notices.

[--accept_license]

PowerUser

Show the status of a software up-date.

--update_status

Show the status of a software up-date on each array being updated.

[--verbose]

PowerUser

Resume a software update thattimed out or failed before all mem-ber arrays were updated.

--resume_update

Accept the terms and conditions ofuse, the EULA, and third-partysoftware notices.

[--accept_license]



Examples

This example lists available software versions on the array.

Nimble OS $ software --list-----------------+-----------+--------------------------------------------------Version Status Size (MB)-----------------+-----------+--------------------------------------------------2.1.5.0-118394-opt installed 8082.1.5.0-117582-opt rollback 8082.1.5.0-122684-opt downloaded unknown

This example provides detailed information about software version 2.1.5.0-118394-opt.

Nimble OS $ software --info 2.1.5.0-118394-optVersion: 2.1.5.0-118394-optStatus: installedSize: 808 MBRelease Date: 2014-08-21Release Notes: NoneFixes bugs:

This example forcibly downloads software version2.1.5.0-118394-opt, which is currently installed on the array.

Nimble OS $ software --download 2.1.5.0-118394-opt --force

This example shows the current status of a software download, refreshed every 10 seconds.

Nimble OS $ software --download_status --interval 10

This example cancels an in-progress software download.

Nimble OS $ software --cancel_downloadSuccess

This example performs verification checks on a software download before installing the software version.

Nimble OS $ software --precheckINFO: Software Update precheck passed.

This example begins a software update.

Nimble OS $ software --update

This example shows the status of an in-progress software update.

Nimble OS $ software --update_statusUpdating group to version: 2.1.5.0-122684-optGroup update start time Oct 5 2013 19:54:57Group update end time N/A

Updating array: array7Array update status: 1 of 7: Controller B is unpacking update package



sshkeyThe sshkey command options manage secure shell (SSH) authorized keys.

SSH uses public keys and cryptography to authenticate users. When there is a public key on one end of anetwork connection and the matching private key on another, a user does not have to manually type thepassword. SSH keys make it possible to create scripts that perform certain tasks without having to manuallylog in to the array. You can use RSA and DSA algorithms. RSA is used both for encryption and signing. DSAis used only for signing.

Synopsis

sshkey --help

sshkey --list[--user user_name]

sshkey --info key_name[--user user_name]

sshkey --add key_name--type {dsa|rsa}--key keystring[--user user_name]

sshkey --edit key_name[--type {dsa|rsa}][--key keystring][--user user_name]

sshkey --delete key_name[--user user_name]

Options



N/A--help

Adminis-trator

List all currently stored SSH keysor the SSH key for the specifieduser. For each key, you will see thekey name and type, but not thekeystring. To see the keystring, usethe --info option.

[--user user_name]--list

Adminis-trator

Show detailed information aboutthe specified SSH key.

key_name--info

Show detailed information aboutthe specified user's ssh key.

[user_name]


sshkey


Adminis-trator

Specify the name of the SSH key.The key must exist before you addit.

key_name--add

Specify the type of SSH key authen-tication used.

--type {dsa|rsa}

Specify the DSA or RSA string thatconstitutes the SSH key. When youadd the key, specify only the en-crypted portion of the key. Do notinclude the ssh_dss or ssh_rsaat the start of the string or theusername@hostname at the end.

Important Do not include spacesat the start or end of the key. In-clude only the key string itself.

--key keystring

Add the SSH key for the specifieduser.

[--user user_name]

Adminis-trator

Modify the specified SSH key. Youcan change the type (dsa or rsa)and the keystring, but you cannotchange the key name.

key_name--edit

Modify the type of SSH key authen-tication used.

[--type {dsa|rsa}]

Modify the DSA or RSA string thatconstitutes the SSH key.

[--key keystring]

Modify the SSH key for the spe-cified user.

[--user user_name]

Adminis-trator

Delete the specified SSH key.key_name--delete

Delete the SSH key for the spe-cified user.

[--user user_name]

Examples

This example lists the current SSH keys.

Nimble OS $ sshkey --list--------------------+------------------------------+---------User Name Type--------------------+------------------------------+---------cgrey greybit rsaguest login rsa

This example lists only the guest user.

Nimble OS $ sshkey --list --user guest--------------------+------------------------------+---------User Name Type--------------------+------------------------------+---------guest login rsa



This example shows detailed information about the SSH key named greybit.

Nimble OS $ sshkey --info greybitUser: cgreyName: greybitType: rsaKey: AAAAB3NzaC1yc2EAAAABIwAAAQEA1w+9D0j4w49/xltKPbMKnwUEq7vlOntXx5vtaS3UGgeT+beCo2ERfRJCVGIZZAUuA0COAwu3Y9J4wvvihuv7ri1UzR1U

This example adds an RSA SSH key to the system for the power user.

Nimble OS $ sshkey --add power --type rsa--key AAAAB3NzaC1yc2EAAAABIwAAAQEA1w+9D0j4w49/xltKPbMKnwUEq7vlOntXx5vtaS3UGgeT+beCo2ERfRJCVGIZZAUuA0COAwu3Y9J4wvvihuv7ri1UzR1U --user poweruser

This example edits the keystring for the RSA SSH key named power. The output is truncated to avoid linewrapping.

Nimble OS $ sshkey --edit power --type rsa--key AAAAB3NzaC1yc2EAAAADAQABAAABAQDRt7osLN4w7CoibK58f9GYn/l2JKqfS8Y0wy9BPeCGdOfNEv5TxSZBYNwMANZx2fC5yHzs7JJY85DsEce/65dUjRFDOhHoil...uLyL8vfrxeVtPGjXWPPcKv64hTQRoyIxmW9Mb27nF2fJYy69WZNqvlJ/VAvjsnRuh/J42BVB...+5gLzJ1j4GEnjBFm8IWnZ2PanhiAwIGZKwEXzU4iQfdujuPY5bOC... --user "power user"

This example deletes the RSA SSH key named power.

Nimble OS $ sshkey --delete power --user poweruser



statsThe stats command options display array statistics. You can specify the period of interest, items of interest,and display options. The default output includes a set of system utilization statistics.

Synopsis

stats --help

stats[--from [[yyyy-]mm-dd,]hh:mm[:ss]][--to [[yyyy-]mm-dd,]hh:mm[:ss]][--duration [+]hh:mm[:ss]][--array array_name][--disk {all|1,2,...}][--shelf_location slot][--net {all|nic1,nic2,...}][--fc {all|fc1,fc2,...}][--perf {composite|vol}][--latency][--iosize][--replication][--partner {all|composite|partner1,partner2...}][--vol {all|composite|vol1,vol2,...}][--interval seconds][--range][--show_time][--diff][--mb][--gb][--hdr {0|intervals}][--csv]

Options



N/A--help


stats


GuestSpecify the beginning time forwhich statistics are to be displayed.When used alone, the value de-faults to 'now'.

[--from [[yyyy-]mm-dd,]hh:mm[:ss]]

Specify the ending time for whichstatistics are to be displayed. Whenused alone, the value defaults to'now', creating a live statisticsstream.


Specify the length of time for whichstatistics are to be displayed. Whenused with --from, it specifies theduration starting at the --from time.When used with --to, it specifiesthe duration ending at the --to time.When used alone, it is equivalentto specifying --from "now minusduration", or if the specified dura-tion begins with a '+', it is equival-ent to specifying --to "now plusduration".

[--duration [+]hh:mm[:ss]]

Display statistics from the specifiedarray. For disk and net work statist-ics, this option is required whenmultiple arrays exist in the group.For volume statistics, this option isnot required, and if not specified,group-wide aggregate values aredisplayed.


Display statistics for disk utilizationfrom the disk in the specified slot.

[--disk {all|1,2,...}] [--shelf_locationslot]

Display statistics for network utiliz-ation of all NICs or the specifiedNICs.

[--net {all|nic1,nic2,...}]

Display statistics for all FibreChannel ports or the specifiedports.

[--fc {all|fc1,fc2,...}]

Display statistics for system orvolume performance.

[--perf {composite|vol}]

Display additional latency detailswith the --perf output.

[--latency]

Display additional I/O details withthe --perf output.

[--iosize]

[--replication]




Display statistics for replications.Specify either the --partner subop-tion to specify one, all, or somereplication partners or the --volsuboption to specify one, all, orsome volumes.

Display statistics for one, all (as acomposite or individually), or somereplication partners. Use partner--list to get partner1,partner2,...values.

[--partner {all|composite|part-ner1,partner2,...}]

Display statistics for one, all (as acomposite or individually), or somevolumes. Use vol --list to getvol1,vol2,... values.

[--vol {all|composite|vol1,vol2,...}]

Display statistics in the specifiedintervals in seconds. If not spe-cified, the latest values for theperiod are displayed.

[--interval seconds]

Display the minimum, maximum,and average values for the spe-cified statistics.

[--range]

Display a timestamp for each inter-val.

[--show_time]

Display statistics as differencesfrom the previous interval.

[--diff]

Display rx and tx statistics inmegabytes rather than the defaultof kilobytes. The column headersin the command output are rxMBand txMB instead of rxKB andtxKB.

[--mb]

Display rx and tx statistics in giga-bytes rather than the default ofkilobytes. The column headers inthe command output are rxGB andtxGB instead of rxKB and txKB.

[--gb]

Display header lines at the spe-cified interval other than the defaultof every 20 intervals. Specify 0(zero) to omit column headers alto-gether.

[--hdr {0|intervals}]

Display statistics as a comma-sep-arated list instead of as a space-separated list.

[--csv]



Examples

Note To stop the scrolling display of statistics output when running the command interactively, press theCtrl+c keys at any time.

These examples show stats command output, first without any parameters and then with defined parameters.The output is truncated to save space and prevent line wrapping.

Nimble OS $ statsStats from 2014-09-02,12:09:43 to 2038-01-18,19:14:07

reads writes seqRead% nsMemHit% nsSsdHit% netRxKB...12626306004 29069195568 25 17 39 7034286173...12626313650 29069208611 25 17 39 7034294229...12626315679 29069210890 25 17 39 7034297705...12626320142 29069216821 25 17 39 7034312508...12626324223 29069223926 25 17 39 7034316520...12626329577 29069231942 25 17 39 7034323314.........

Nimble OS $ stats --interval 5Will use per-second statisticsStats from 2014-09-02,13:09:36 to 2038-01-18,19:14:07

reads writes seqRead% nsMemHit% nsSsdHit% netRxKB...12647799975 29095666635 25 17 39 7057545676...12647827863 29095708484 25 17 39 7057574592...12647853954 29095752416 25 17 39 7057603817.........

Nimble OS $ stats --diff --mbStats from 2014-09-02,13:16:49 to 2038-01-18,19:14:07

reads writes seqRead% nsMemHit% nsSsdHit% netRxMB...6815 6308 39 15 25 4...-- -- -- -- -- 8...-- -- -- -- -- 1.17...

6252 6592 36 17 27 4...6152 7729 37 14 30 4...5876 6888 38 14 31 9...8397 11263 36 11 37 0.41...2387 2827 39 16 33 6...

...

...

Nimble OS $ stats --perf greyhound --latencyStats from 2014-09-02,13:21:51 to 2038-01-18,19:14:07

io_type 0u-100u 100u-200u 200u-500u 500u-1m 1m-2m...reads -- -- -- -- --...

nsreads -- -- -- -- --...seqreads -- -- -- -- --...writes -- -- -- -- --...reads 7941 13160 4613 671 433...

nsreads 7144 12776 4591 661 429...seqreads 797 384 22 10 4...writes 0 0 0 0 0...

...

...

This example sets the start and end time between which to collect statistics. The output is truncated to preventline wrapping.



Nimble OS $ stats --from 01:10 --to 01:20Stats from 2014-09-02,01:10:00 to 2014-09-02,01:20:00

reads writes seqRead% nsMemHit% nsSsdHit% netRxKB...12655037664 29104182305 25 17 39 7085122631...

This example shows statistics for the eth3 NIC. The output is truncated to save space.

Nimble OS $ stats --net eth3Stats from 2014-08-12,09:00:28 to 2038-01-18,19:14:07dev rxKB rxPackets rxErrors txKB txPackets...eth3 951076338 290812606 3 72776956 148602256...eth3 951076340 290812630 3 72776956 148602264...eth3 951076341 290812647 3 72776956 148602270...eth3 951076342 290812666 3 72776957 148602277...eth3 951076343 290812683 3 72776957 148602283...

...

...

This example shows statistics for the fc5 Fibre Channel port. The output is truncated to save space andprevent line wrapping.

Nimble OS $ stats --fc fc5Stats from 2014-08-12,09:02:30 to 2038-01-18,19:14:07dev rxKB txKB rxBBcreds txBBcreds Inv tx Word CRC E...fc5 147154458457 135485861338 80 8 562 ...fc5 147154720749 135486151251 80 8 562 ...fc5 147154946494 135486425219 80 8 562 ...

...

...

This example shows statistics for the fc5 Fibre channel port in a comma-separated values (CSV) formatshowing gigabytes instead of the default of kilobytes. The output is truncated to save space and prevent linewrapping.

Nimble OS $ stats --fc fc5 --gb --hdr 30 --csvStats from 2014-08-13_11:32:34 to 2038-01-18_19:14:07dev,rxGB,txGB,rxBBcreds,txBBcreds,Inv tx Word,CRC Errors,loss sync,loss ...fc5,159457,148035,80,8,684,0,356,0,1fc5,159457,148035,80,8,684,0,356,0,1fc5,159457,148036,80,8,684,0,356,0,1fc5,159458,148036,80,8,684,0,356,0,1fc5,159458,148036,80,8,684,0,356,0,1......



subnetThe subnet command options manage subnets.

Synopsis

subnet --help

subnet --list[--netconfig {active|backup|draft}]

subnet --info subnet_label[--netconfig {active|backup|draft}]

subnet --add subnet_label--subnet_addr network/netmask[--discovery_ipaddr ipaddr][--type {mgmt|data|mgmt,data}][--subtype {iscsi|group|iscsi,group}][--netzone_type {evenodd|bisect|single}][--netconfig {active|backup|draft}][--vlanid id][--mtu mtu]

subnet --edit subnet_label[--new_label subnet_label][--subnet_addr network/netmask][--discovery_ipaddr ipaddr][--type {mgmt|data|mgmt,data}][--subtype {iscsi|group|iscsi,group}][--netzone_type {evenodd|bisect|single}][--netconfig {active|backup|draft}][--vlanid id][--mtu mtu][--force_ip_update][--force_repl][--force_initiator_groups]

subnet --remove subnet_label[--netconfig {active|backup|draft}][--force_repl][--force_ip_update][--force_unassign_nics][--force_initiator_groups]

Options



N/A--help


subnet


GuestList all configured subnets.N/A--list

List all configured subnets in thespecified network configuration.


GuestProvide detailed information aboutthe specified subnet.

subnet_label--info

Provide detailed information aboutthe specified subnet in the spe-cified network configuration.


PowerUser

Add the specified subnet. Thesubnet_label can be up to 64 char-acters.

subnet_label--add

Specify the subnet address, ex-pressed in Classless Inter-DomainRouting (CIDR) format.

--subnet_addr network/netmask

Specify the subnet discovery IPaddress.

[--discovery_ipaddr ipaddr]

Specify whether the subnet is usedfor data, management, ordata+management traffic. You canspecify multiple types by using acomma-separated list.

[--type {mgmt|data|mgmt,data}]

Specify the subnet subtype for asubnet on an iSCSI array. You canspecify multiple subtypes by usinga comma-separated list.

[--subtype {iscsi|group|iscsi,group}]

Specify the Network Affinity Zonetype for a subnet on an iSCSI ar-ray.

[--netzone_type {evenodd|bi-sect|single}]

Specify the network configurationto which to add the subnet.


Specify the VLAN ID for the subnet.Valid values are in the 1-4094range, inclusive.

[--vlanid id]

Specify the maximum transmissionunit (MTU) for the subnet. Validvalues are in the 512-16000 range,inclusive.

[--mtu mtu]




PowerUser

Modify the specified subnet. Spe-cify at least one suboption.

subnet_label--edit

Modify the label for the specifiedsubnet.

[--new_label new_label]

Modify the subnet address, ex-pressed in CIDR format.

[--subnet_addr network/netmask]

Modify the subnet discovery IP ad-dress.

[--discovery_ipaddr ipaddr]

Modify the subnet type. You canspecify multiple types by using acomma-separated list.

[--type {mgmt|data|mgmt,data}]

Modify the subnet subtype for asubnet on an iSCSI array. You canspecify multiple subtypes by usinga comma-separated list.

[--subtype {iscsi|group|iscsi,group}]

Modify the Network Affinity Zonetype for a subnet on an iSCSI ar-ray.

[--netzone_type {evenodd|bi-sect|single}]

Modify the network configurationwith which the subnet is associ-ated.


Modify the VLAN ID for the subnet.Valid values are in the 1-4094range, inclusive.

[--vlanid id]

Modify the MTU for the subnet.Valid values are in the 512-16000range, inclusive.

[--mtu mtu]

Update the discovery IP addressfor the active network configuration.

[--force_ip_update]

Ignore inconsistent network config-urations for replication partnerswhen editing the specified subnet.

[--force_repl]

Ignore initiator groups assigned tosubnets in the active network con-figuration when editing the spe-cified subnet.





PowerUser

Remove the specified subnet.subnet_label--remove

Specify the network configurationfrom which to remove the subnet.


Ignore inconsistent network config-urations for replication partnerswhen removing the specified sub-net.

[--force_repl]

Remove the specified subnet andupdate the discovery IP addressfor the active network configuration.

[--force_ip_update]

Ignore the NIC assigned to thespecified subnet in the active net-work configuration.

[--force_unassign_nics]

Ignore initiator groups assigned tosubnets in the active network con-figuration when removing the spe-cified subnet.


Examples

This example lists configured subnets on a Fibre Channel array.

Nimble OS $ subnet --list-------------------+----------------+-------+--------------+----+-----Label Network Type Discovery IP VLAN MTU-------------------+----------------+-------+--------------+----+-----data1 192.0.2.0/23 Data 192.0.2.67 0 1500mgmt-data 192.0.4.0/21 Mgmt 192.0.4.15 0 1500Subnet-1.101.0.0 1.101.0.0/16 Data N/A 2101 1500Subnet-1.102.0.0 1.102.0.0/16 Data N/A 2102 1500Subnet-1.103.0.0 1.103.0.0/16 Data N/A 2103 1500Subnet-1.104.0.0 1.104.0.0/16 Data N/A 2104 1500Subnet-1.105.0.0 1.105.0.0/16 Data N/A 2105 1500Subnet-1.106.0.0 1.106.0.0/16 Data N/A 2106 1500Subnet-1.107.0.0 1.107.0.0/16 Data N/A 2107 1500Subnet-1.108.0.0 1.108.0.0/16 Data N/A 2108 1500Subnet-1.109.0.0 1.109.0.0/16 Data N/A 2109 1500Subnet-1.110.0.0 1.110.0.0/16 Data N/A 2110 1500

This example provides detailed information about a configured subnet.

Nimble OS $ subnet --info data1Label: data1Network/Masklen: 192.0.2.0/23Type: DataAllow iSCSI: NoAllow group: YesNetwork Affinity Zone Type: NoneDiscovery IP: 192.0.2.67VLAN Id: 0MTU: 1500

This example adds a subnet to the draft network configuration.



Nimble OS $ subnet --add Subnet-1.102.0.0--subnet_addr 1.101.0.0/16 --type data --netconfig draft--vlanid 2101 --mtu 1500

This example modifies a previously added subnet in the draft network configuration.

Nimble OS $ subnet --edit Subnet-1.102.0.0--netconfig draft --mtu 9000

This example removes a subnet and ignores the initiator groups assigned to it.

Nimble OS $ subnet --remove Subnet-1.102.0.0 --force_initiator_groups



timezoneThe timezone command options manage time zone settings.

Synopsis

timezone --help

timezone --list

timezone --set zone_zone

Options



N/A--help

GuestList all valid time zones for theNimble array.

N/A--list

PowerUser

Set the specified time zone on aNimble array. Use timezone --listto get a list of valid zone_namevalues.

zone_name--set

Examples

This example lists the valid time zones. The output is truncated to save space.

Nimble OS $ timezone --listAsia/BaghdadAsia/BahrainAsia/BakuAsia/BangkokAsia/BeirutAsia/BishkekAsia/BruneiAsia/CalcuttaAsia/Choibalsan......Pacific/SamoaPacific/TahitiPacific/TarawaPacific/TongatapPacific/TrukPacific/WakePacific/WallisPacific/Yap

This example sets the time zone on the array to the time in Stockholm, Sweden.

Nimble OS $ timezone --set Europe/Stockholm


timezone

useradminThe useradmin command options manage user accounts.

Synopsis

useradmin --help

useradmin --list[--role {administrator|poweruser|operator|guest}]

useradmin --info user_name

useradmin --add user_name[--description text][--full_name text][--email_addr email_address][--role {administrator|poweruser|operator|guest}][--inactivity_timeout minutes]

useradmin --edit user_name[--description text][--full_name text][--email_addr email_address][--role {administrator|poweruser|operator|guest}][--inactivity_timeout minutes]

useradmin --disable user_name

useradmin --enable user_name

useradmin --remove user_name

useradmin --passwd[--user user_name]

Options



N/A--help

Adminis-trator

List either all user accounts or useraccounts that are assigned to thespecified role.

[--role {administrator|poweruser|op-erator|guest}]

--list

GuestShow either detailed informationabout the logged-in user if youspecify your own user_name or anyspecified user if you are logged inas a user who is assigned to theAdministrator role.

user_name--info


useradmin


Adminis-trator

Add an account for the specifieduser. The user_name must be al-phanumeric and start with a letter,be 1 to 32 characters, and containno spaces.

user_nameadd

Specify a plain-text description ofthe user account. The text can beblank or can contain up to 255characters. If there are spaces inthe description, enclose the text inquotation marks.


Specify the full name of the useraccount. The text can be blank orstart with a letter, contain up to 64alphanumeric characters, dashes,underscores, or apostrophes, nospaces, no periods.

[--full_name text]

Specify an email address for theuser.

[--email_addr email_address]

Specify the role the user has.[--role {administrator|poweruser|op-erator|guest}]

Set the number of minutes thatmust pass without any user activitybefore a timeout occurs and thisuser is logged out. If you do notspecify this option, the default of30 minutes is used. The minutescannot exceed the inactivity timeoutset for the group.





GuestModify information about thelogged-in user if you specify yourown user_name or any specifieduser if you are logged in as a userwho is assigned to the Administrat-or role. Specify at least one subop-tion.

user_name--edit

Modify the description of the spe-cified user account. If there arespaces in the description, enclosethe text in quotation marks.


Modify the full name of the useraccount.

[--full_name text]

Modify the email address of theuser account.

[--email_addr email_address]

Modify the number of minutes thatmust pass without any user activitybefore a timeout occurs and thisuser is logged out.


Adminis-trator

Modify the role the user has.Logged-in users cannot changetheir own role. You must be as-signed to the Administrator role tomodify a user's role.

[--role {administrator|poweruser|op-erator|guest}]

Adminis-trator

Disable the specified user account.user_name--disable

Adminis-trator

Enable the specified user account.This option succeeds even if theaccount is currently enabled.

user_name--enable

Adminis-trator

Remove the specified user ac-count.

user_name--remove

GuestModify either your own passwordif you do not specify the optional--user option or the password ofthe specified user if you are loggedin as a user who is assigned to theAdministrator role and you do spe-cify --user. The new passwordvalue is case sensitive, must be atleast eight characters, must be dif-ferent from the current password,and cannot include left or rightsquare brackets ([ ]), ampersands(&), semicolons (;), or back singlequotation mark (`).

[--user user_name]--passwd

Examples

This example lists the user accounts on a Nimble array.



Nimble OS $ useradmin --list-------------------+---------------+--------+---------+--------------------Name Role Status Logged in Last login-------------------+---------------+--------+---------+--------------------admin administrator Enabled Y Sep 2 2014 13:47:01chris operator Enabled N Aug 1 2014 14:45:57guest guest Enabled N Aug 22 2014 10:25:45operator operator Enabled N Aug 24 2014 13:53:23pAdmin administrator Enabled Y Sep 2 2014 14:36:53pGuest guest Enabled N Aug 7 2014 12:28:50pOper operator Enabled N Aug 4 2014 15:07:39pPower poweruser Enabled N Sep 2 2014 09:36:46vcplugin poweruser Enabled N Aug 22 2014 10:01:26

This example shows the current settings for the admin user.

Nimble OS $ useradmin --info adminName: adminRole: administratorStatus: enabledLogged in: trueDescription: AdministratorFull name: AdministratorEmail address:Inactivity timeout: 30 minute(s)Last login: Apr 13 2015 09:33:42Last logout: Apr 13 2015 10:13:59Creation time: N/ALast modified: 1Id: 1

This example modifies the description and inactivity timeout for the user account named chris.

Nimble OS $ useradmin --edit chris --description "Chris Green"--inactivity_timeout 90

This example modifies the password of the logged in user.

Nimble OS $ useradmin --passwdEnter current password:Enter new password:Retype new password:Nimble OS $



usersessionThe usersession command options manage user sessions.

Synopsis

usersession --help

usersession --list

usersession --info[--id session_id]

usersession --kill session_id

Options



N/A--help

GuestList either the current user sessionif you are logged in as a user withany role other than Administratoror all user sessions if you arelogged in as a user who is assignedto the Administrator role.

N/A--list

GuestShow either detailed informationabout the current session for thelogged-in user if you do not specifythe optional --id option or the spe-cified user session if you do specify--id. If you are logged in as a userwho is assigned to the Administrat-or role, you can specify somethingother than the current session byincluding the --id session_id option.

[--id session_id]--info

Adminis-trator

Kill the specified user session. Theuser is not logged out, but cannottake any more actions in that ses-sion. You cannot kill the currentuser session. If you try to, you seea message saying that the Ses-sion cannot commit sui-cide.

session_id--kill

Examples

This example lists current user sessions. In this example, only the admin user is logged in to run the command.The admin user is also logged in from multiple separate sessions. The session ID (SID) is a hash (digest)rather than the real SID. The Source IP Addr is the IP address of the computer from which the user loggedin to the command line interface (CLI), the graphical user interface (GUI), or both. A single user can havemultiple user sessions. The Expiry Time (secs) is the number of seconds until this session ends if no useraction is taken. Any user action resets the clock.


usersession

Nimble OS $ usersession--list---------------+----------------------------+---------------+--------------User Session ID Source IP Addr. Expires in

(secs)---------------+----------------------------+---------------+--------------admin 6worApuItdHDcC39dJOnTULgfp0= 192.0.2.177 127

admin 9ukXV/OjUA0T/0mIcOxiZ6J53WM= 192.0.2.177 201

admin Yl9zye/rXZS7z9wSmBWBZmgoimE= 198.51.100.18 727

This example shows details about the current session for the logged-in user.

Nimble OS $ usersession --infoSession ID: Yl9zye/rXZS7z9wSmBWBZmgoimE=User name: adminSource IP: 198.51.100.18Expiry Time (secs): 727

This example shows details about the specified session. The admin user runs this version of the command.

Nimble OS $ usersession --info --id 6worApuItdHDcC39dJOnTULgfp0=Session ID: 6worApuItdHDcC39dJOnTULgfp0=User name: adminSource IP: 192.0.2.177Expiry Time (secs): 127

This example kills the GUI session with a SID of 9ukXV/OjUA0T/0mIcOxiZ6J53WM= for the admin user.Even though this example is somewhat contrived, an administrator user can kill another admin session thatis not the command-line interface from which the kill action is initiated.

Nimble OS $ usersession--kill 9ukXV/OjUA0T/0mIcOxiZ6J53WM=



versionThe version command options display the version of the Nimble OS (NOS) software that is installed on anarray or a group of arrays.

Synopsis

version --help

version[--array name]

Options



N/A--help

GuestSpecify the array for which to showversion information. Use ar-ray--list to get valid name values.If you do not specify this option,then the version information is forthe group.

name[--array]

Examples

This example displays the current version of the NOS software on a group of arrays.

Nimble OS $ versionINFO: Version information is for the group.2.1.4.0-100755-opt

This example displays the current version of the NOS software on an array named greyhound.

Nimble OS $ version --array greyhoundINFO: Version information is for array greyhound2.1.4.0-100755-opt


version

vmwpluginThe vmwplugin command options manage the Nimble OS plugin for the VMware vCenter.

Use the plugin to manage datacenter and datastore array-specific functions, such as cloning, creating, andmanaging datastores that reside on Nimble arrays. To install and use the VMware plugin, provide vCenterhost and authentication information.

Note The plugin is not supported for multiple datastores that are located on one LUN, for one datastore thatspans multiple LUNs, or if the LUN is located on a non-Nimble array.

Synopsis

vmwplugin --help

vmwplugin --list--username username--password password--server server[--port_number port]

vmwplugin --register--username username--password password--server server[--subnet_label subnet_label_for_registration][--port_number port][--client {web|thick}]

vmwplugin --unregister--username username--password password--server server[--port_number port][--client {web|thick}][--group_id group_id]

Options



N/A--help


vmwplugin


GuestList the VMware vCenter plugins.The --username, --password, and--server suboptions are required.

--list

Specify the username of an ac-count that can access the plugin.

--username username

Specify the VMware vCenter pass-word for the specified username.

--password password

Specify the VMware vCenter fullyqualified vCenter server name orIP address.

--server server

Specify the VMware vCenter portnumber. If you do not specify thisoption, the default port 443 is used.

[--port_number port]

PowerUser

Register a VMware vCenter plugin.The --username, --password, and--server suboptions are required.

--register


--username username


--password password


--server server

Specify a subnet label to use forregistration. Example: mgmt-data.If you do not specify this option, nosubnet label is used.

[--subnetlabel subnetlabel_for_re-gistration]



Specify whether to allow access tothe VMware vCenter plugin throughthe web-based or thick (vSphere)client.

[--client {web|thick}]




PowerUser

Unregister a VMware vCenter plu-gin.

The --username, --password, and--server suboptions are required.

--unregister


--username username


--password password


--server server



Specify whether to remove accessto the VMware vCenter pluginthrough the web-based or thick(vSphere) client.

[--client {web|thick}]

Specify the Nimble group for whichto remove access to the VMwarevCenter plugin.

[--group_id group_id]

Examples

This example lists configured VMware vCenter plugins.

Nimble OS $ vmwplugin --list --username vcenteradmin --password mypassword--server 203.0.113.1

This example registers the VMware vCenter plugin. Because the --port option is not specified, the default of443 is used.

Nimble OS $ vmwplugin --register --username vcenteradmin--password mypassword --server 203.0.113.1

This example unregisters a VMware vCenter plugin.

Nimble OS $ vmwplugin --unregister --username vcenteradmin--password mypassword --server 203.0.113.1



volThe vol command options manage volumes.

Volumes are the basic storage units from which the total capacity of an array is apportioned. The array issectioned into volumes. The number of volumes per array depends on storage allocation. In the context ofthe Nimble array, the term volume and LU (logical unit) are synonymous and interchangeable. A numberidentifies each LU, so you might see the term LUN used, too.

Note Keep the following points in mind when you use the encryption feature:

• When you create a volume, either the group configuration or your volume specifications determine whetherthe volume is encrypted. After volume creation, encryption on that volume cannot be changed.

• If you clone a volume, the clone inherits the encryption status of the parent volume. You cannot changethat initial encryption status on the clone.

• If you lose the passphrase for an encrypted volume, the volume is inaccessible and its data is irretrievable.• Performance on CS2xx arrays is slow when accessing encrypted volumes.

Synopsis

vol --help

vol --list[--pool pool_name][--initiatorgrp initiatorgrp_name][--agent_type {smis|none}][--moving][--cache_pinned {yes|no}]

vol --info volume_name

vol --create volume_name--size megabytes[--description text][--perfpolicy name][--cache_pinned {yes|no}][--reserve percent][--quota percent][--warn_level percent][--snap_reserve percent][--snap_quota percent][--snap_warn_level percent][--start_offline][--apply_acl_to {volume|snapshot|both}][--chapuser username][--initiatorgrp group_name][--lun number][--multi_initiator {yes|no}][--pool poolname][--agent_type {smis|none}][--encryption_cipher {aes-256-xts|none}]

vol --edit volume_name[--name name][--description text]


vol

[--size megabytes][--perfpolicy name][--cache_pinned {yes|no}][--readonly {yes|no}][--force][--reserve percent][--quota percent][--warn_level percent][--snap_reserve percent][--snap_quota percent][--snap_warn_level percent][--multi_initiator {yes|no}][--agent_type {smis|none}]

vol --delete volume_name

vol --online volume_name

vol --offline volume_name[--force]

vol --snap volume_name--snapname snapshot_name[--description text][--start_online][--allow_writes]

vol --restore volume_name--snapname snapshot_name

vol --clone volume_name--snapname snapshot_name--clonename clone_name[--description text][--readonly {yes|no}][--reserve percent][--quota percent][--warn_level percent][--snap_reserve percent][--snap_quota percent][--snap_warn_level percent][--start_offline][--apply_acl_to {volume|snapshot|both}][--chapuser username][--initiatorgrp initiatorgrp_name][--lun number][--multi_initiator {yes|no}][--cache_pinned {yes|no}]

vol --assoc volume_name--volcoll collection_name

vol --dissoc volume_name



vol --addacl volume_name--apply_acl_to {volume|snapshot|both}[--chapuser username][--initiatorgrp initiatorgrp_name][--lun number]

vol --removeacl volume_name[--apply_acl_to {volume|snapshot|both}][--chapuser username][--initiatorgrp group_name]

vol --claim volume_name[--partner partner_name]

vol --move volume1,volume2,...--dest_pool destination_pool

vol --abort_move volume_name

Options



N/A--help

GuestList the volumes on the array whereyou run the command.

--list

List the volumes in the specifiedstorage pool. On a Fibre Channelarray, each array must be in aseparate pool.

[--pool pool_name]

List the volumes of the specifiedagent type. The smis externalmanagement agent type is a Stor-age Management Initiative Specific-ation (SMI-S) plugin type that workswith the Microsoft System CenterVirtual Machine Manager (SCVMM)to manage block storage. The noneagent type is the default.

[--agent_type {smis | none}]

List the volumes that are in theprocess of moving to a differentstorage pool.

--moving

List the volumes that are (yes) orare not (no) pinned in cache.

[--cache_pinned {yes|no}]

GuestProvide detailed information aboutthe specified volume.

volume_name--info




OperatorCreate a volume with the specifiedname.

volume_name--create

Create a volume of the specifiedsize in megabytes.

--size megabytes

Specify a description of the volume.If there are spaces in the descrip-tion, enclose the text in quotationmarks.


Associate a performance policywith the volume. If no performancepolicy is specified, the default per-formance policy is used. After youcreate a volume, you can only as-sociate another performance policythat has the same block size withthis volume.

[--perfpolicy name]

Specify whether or not to keep allcontents of this volume in flashcache. The amount of flash neededto pin the volume in cache is equalto the volume quota. Pinning avolume in cache provides consist-ent performance guarantees for alltypes of workloads.


Specify the amount of space thatis reserved for a volume, which isexpressed as a percentage of size.If this option is not specified, thearray default volume reserve set-ting is used to determine theamount of space that is reservedfor this volume.

[--reserve percent]

Apply a quota to a volume as apercentage of the volume size. Ifthis option is not specified, the ar-ray default volume quota setting isused to determine the quota for thisvolume.

[--quota percent]

Specify the threshold based on theavailable space from the volumereserve. If the available spacedrops below the specifiedthreshold, then an alert is triggered.If this option is not specified, thearray default volume warn levelsetting is used to determine thewarning level for this volume.

[--warn_level percent]

[--snap_reserve percent]




Specify the amount of space to bereserved for snapshots of thisvolume as a percentage of size. Ifthis option is not specified, then thearray default snapshot reservesetting is used for the amount ofspace to reserve for snapshots ofthis volume.

Specify the quota of a volumespace as a percentage of volumesize. If this option is not specified,the array default snapshot quotasetting is used for the quota ofsnapshots of this volume.

[--snap_quota percent]

Specify the threshold for availablespace from the snapshot reservebelow which an alert automaticallyappears. If this option is not spe-cified, then the array default snap-shot warn level settings is used toset the warn level for snapshots ofthis volume.

[--snap_warn_level percent]

Start with the volume set to offline.If this option is not specified, thenthe default is to start with thevolume online.

[--start_offline]

Apply the access control recordbeing specified to the volume, itssnapshots, or both. If this option isnot specified, then the default is toapply the ACL to both.

[--apply_acl_to {volume|snap-shot|both}]

Specify the name of a CHAP userwho can access a volume on aniSCSI array. CHAP users can becreated with the chapuser com-mand. If this option is not specified,then the default is to allow accessto any CHAP user. This optiondoes not apply to volumes on aFibre Channel array.

[--chapuser username]

Specify the name of the initiatorgroup to which to restrict access.If this option is not specified, thenaccess is allowed to any initiatorgroup.

[--initiatorgrp initiatorgrp_name]

Specify the logical unit number(LUN) to associate with the volumefor access by Fibre Channel initiat-or groups.

[--lun number]

[--multi_initiator {yes|no}]




Set a volume and its snapshots tobe multi-initiator accessible. Bydefault on an iSCSI array, a volumeand its snapshots can be accessedby a single initiator at any giventime. This option does not apply tovolumes on a Fibre Channel array.

Specify a storage pool to which toassign a volume. Volume data isdistributed across arrays overwhich a specified pool is defined.If this option is not specified, thenthe volume is automatically as-signed to the default pool.

[--pool pool_name]

Specify the external managementagent type. Default: none.

[--agent_type {smis|none}]

Specify the cipher to use duringencryption for this volume. Overrid-ing the default value is allowed onlyif the encryption_scope suboptionfor the group --edit command isset to "volume". If overriding thedefault value is allowed, a value of"none" indicates no encryption. Avalue of "aes-256-xts" indicates theuse of the AES-256-XTS cipher.

Note After volume creation, encryp-tion on that volume cannot bechanged.

[--encryption_cipher {aes-256-xts|none}]




OperatorModify the attributes of the spe-cified volume. Specify at least onesuboption.

volume_name--edit

Modify the volume name. This willcorrespondingly change the targetname associated with this volume.

[--name new_name]

Modify the description of thevolume.


Modify the volume size. Thechanged size does not automatic-ally modify other space-relatedsettings, such as quota, reserve,and warn levels. You must modifythose settings to maintain the samelevels based on the modifiedvolume size.

[--size megabytes]

Modify the performance policy thatis associated with the volume. Thespecified new policy must have ablock size that is the same as theblock size of the currently associ-ated performance policy.

[--perfpolicy name]

Pin the volume in flash cache if youspecify yes.


Set the volume to read/write if youspecify no or to read only if youspecify yes.

[--readonly {yes|no}]

Forcibly set the volume to read onlywhen there are connected initiatorsor when you reduce the size of thevolume.

[--force]

Modify the amount of space that isreserved for the volume as a per-centage of the volume size.

[--reserve percent]

Modify the volume quota as a per-centage of the volume size.

[--quota percent]

Modify the threshold based on theavailable space from the volumereserve. If the available spacedrops below the specifiedthreshold, then an alert is triggered.If this option is not specified, thearray default volume warn levelsetting is used to determine thewarning level for this volume.






Modify the reserved snapshotspace for the volume as a percent-age of the volume size. An alert isgenerated as the reserved snap-shot space decreases and thespecified threshold is reached.

Modify the reserved snapshotquota for the volume as a percent-age of the volume size. An alertmessage is generated when thesnapshot quota is reached.


Modify the available space warninglevel for snapshots of the specifiedvolume.


Set a volume and its snapshots tobe multi-initiator accessible. Bydefault on an iSCSI array, a volumeand its snapshots can be accessedby a single initiator at any giventime. This option does not apply tovolumes on a Fibre Channel array.


Modify the external managementagent type.

[--agent_type {smis|none}]

PowerUser

Delete the specified volume. Beforeyou can delete any existingvolumes, you must take the volumeas well as its associated snapshotsoffline and dissociate any activeconnections.

volume_name--delete

OperatorSet the specified volume online.Setting a volume online allows initi-ators to connect to it.

volume_name--online

OperatorSet the specified volume offline.Setting a volume offline preventsinitiators from connecting to it. Set-ting the volume offline fails if thereare open connections from initiatorsand --force is not specified.

volume_name--offline

Forcibly set the specified volumeoffline, even if there are open con-nections from initiators.

--force




OperatorSpecify the volume to take a snap-shot of.

volume_name--snap

Specify the name of the snapshotto create.

--snapname snapshot_name

Specify an optional description ofthe snapshot. If there are spacesin the description, enclose the textin quotation marks.


Start the snapshot online if youspecify this option. By default,snapshots are set offline when theyare created.

[--start_online]

Enable applications to write to asnapshot if you specify this option.By default, snapshots are read onlywhen they are created.

[--allow_writes]

PowerUser

Restore the specified volume fromone of its snapshots. The volumemust be taken offline before youcan restore it to the snapshot.

volume_name--restore

Specify the snapshot from whichto restore the volume.





OperatorClone the specified volume fromone of its snapshots and then cre-ates a new volume. You can useclones to restore corrupt volumesor to create an environment fortesting changes.

volume_name--clone

Specify the snapshot from whichto create a clone.


Specify the name to assign to thenew, cloned volume.

--clonename clone_name

Provide a description of the clonedvolume. If there are spaces in thedescription, enclose the text inquotation marks.


Set the clone to be a read-only orread/write volume.

[--readonly {yes|no}]

Specify the amount of space thatis reserved for the cloned volumeas a percentage of the volume size.

[--reserve percent]

Specify the quota for the clonedvolume as a percentage of thevolume size.

[--quota percent]

Specify the threshold based on theavailable space from the volumereserve. If the available spacedrops below the specifiedthreshold, then an alert is triggered.If this option is not specified, thearray default volume warn levelsetting is used to determine thewarning level for this clonedvolume.


Specify the reserved snapshotspace for the cloned volume as apercentage of the volume size. Analert is generated as the reservedsnapshot space decreases and thespecified threshold is reached.


Specify the reserved snapshotquota for the cloned volume as apercentage of the volume size. Analert message is generated whenthe snapshot quota is reached.


Specify the available space warn-ing level for snapshots of thecloned volume.


[--start_offline]




Set the cloned volume offline. Bydefault, volumes are set onlinewhen you create them.

Apply the access control recordbeing specified to the clonedvolume, its snapshots, or both. Ifthis option is not specified, then thedefault is to apply the ACL to both.

[--apply_acl_to {volume|snap-shot|both}]

Specify the name of a CHAP userwho can access a cloned volumeon an iSCSI array. If this option isnot specified, then the default is toallow access to any CHAP user.This option does not apply tovolumes on a Fibre Channel array.


Specify the name of the initiatorgroup to which to restrict access.If this option is not specified, thenaccess is allowed to any initiatorgroup.


Specify the logical unit number(LUN) to associate with the clonedvolume for access by Fibre Chan-nel initiator groups.

[--lun number]

Set a cloned volume and its snap-shots to be multi-initiator access-ible. By default on an iSCSI array,a volume and its snapshots can beaccessed by a single initiator at anygiven time. This option does notapply to cloned volumes on a FibreChannel array.


Pin the cloned volume in cache.[--cache_pinned {yes|no}]

OperatorAssociate the specified volume witha volume collection.

volume_name--assoc

Specify the volume collection toassociate the volume with.

--volcoll collection_name

OperatorRemove the specified volume froma volume collection. When avolume is dissociated from avolume collection, any snapshotson the volume are not deletedwhen the corresponding snapshotcollection is deleted, either manu-ally or per-retention-policy for theprotection schedule that they aremanaged by.

volume_name--dissoc




OperatorAdd an access control list (ACL)record to the specified volume.

volume_name--addacl

Apply the access control record tothe volume, its snapshots, or both.

--apply_acl_to {volume|snap-shot|both}

Specify the CHAP user to restrictaccess to. This option does notapply to volumes on a Fibre Chan-nel array.


Specify the initiator group to restrictaccess to.


Specify the logical unit number(LUN) to associate with this volumefor access by a Fibre Channel initi-ator group. Valid LUNs are in the0-2047 range. If not specified, thesystem generates a number. Thisoption does not apply to volumeson an iSCSI array.

[--lun number]

OperatorRemove an access control recordfrom the specified volume.

volume_name--removeacl

Remove the access control recordfrom the volume, its snapshots, orboth.

--apply_acl_to {volume|snap-shot|both}

Remove the access control recordfor the specified CHAP user. Thisoption does not apply to volumeson a Fibre Channel array.


Remove the access control recordfor the specified initiator group.

[--initiatorgrp group_name]

PowerUser

Claim ownership of the specifiedvolume. Claiming ownership of avolume allows the new owner tomodify volume attributes. For ex-ample, when a replica volume isdisassociated on an upstream ar-ray, the volume ownership for thereplica stays with the upstream ar-ray. To modify the volume on thelocal system, claim ownership.

volume_name--claim

Specify the name of a partner towhom volume ownership is as-signed. By default, ownership isassigned to the local array whereyou run the command. Specify thisoption to assign ownership to adifferent array.

[--partner partner_name]




PowerUser

Move the specified list of volumes,related volumes that share datablocks (such as clones or parentsof clones), and snapshots from thecurrent storage pool to anotherpool. Use vol --info to monitor themove. This option does not applyto volumes on Fibre Channel ar-rays.

volume1,volume2,...--move

Specify the storage pool to whichthe volumes, related volumes, andsnapshots will be moved.

--dest_pool destination_pool

PowerUser

Stop moving the specified volumeand its snapshots from one storagepool to another.

volume_name--abort_move

Examples

This example lists all volumes on an array.

Nimble OS $ vol --list--------------------+----------+------+-----------+----------+---------+-------Name Size Online Offline Usage Reserve % Quota%

(MB) Reason (MB)--------------------+----------+------+-----------+----------+---------+-------AppAD01 87041 No Replica 11179 0.00 100.00AppE2K7Node2 153600 No Replica 63550 0.00 100.00EX03-Exchange 512000 Yes N/A 63325 0.00 100.00EX03-ExchangeLog 102400 Yes N/A 23049 0.00 100.00itbackup 1048576 Yes N/A 301628 0.00 100.00share 2097152 Yes N/A 781912 0.00 100.00vcenterbackup 102400 Yes N/A 41024 0.00 100.00

This example shows detailed information about a volume named public that is configured on an iSCSI array.The output is truncated to save space.

Nimble OS $ vol --info publicName: publicSerial number: 38c46c34d60faf846c9ce9058d6e41a2iSCSI target: iqn.2007-11.com.nimblestorage:public-v354fae.0000f.a241Description: public volumeOwned by: greyfulSize (MB): 2097152Pool: defaultMove to pool: N/AMove aborting: N/AMove data migrated: N/AMove data remaining: N/AMove start time: N/AMove estimated completion time: N/APerformance policy: Windows File ServerBlock size (bytes): 4096Reserve: 0.00%Warn level: 80.00%Quota: 100.00%



Snapshot reserve: 0.00%Snapshot warn level: N/ASnapshot quota: unlimitedSnapshot count: 2......Agent Type: noneOnline Snapshots:Encryption cipher: aes-256-xts

This example shows detailed information about a volume named semiprivate that is configured on a FibreChannel array. The output is truncated to save space.

Nimble OS $ vol --info semiprivateName: semiprivateSerial number: 4e136d3f091130236c9ce9006547755fTarget name: 56:c9:ce:90:b9:f2:ca:00Description:Owned by: corpSize (MB): 16777216Pool: defaultMove to pool: N/AMove aborting: N/AMove data migrated: N/AMove data remaining: N/AMove start time: N/AMove estimated completion time: N/APerformance policy: defaultBlock size (bytes): 4096Reserve: 0.00%Warn level: 80.00%Quota: 100.00%Snapshot reserve: 0.00%Snapshot warn level: N/ASnapshot quota: unlimitedSnapshot count: 0Volume usage (MB): 35331Volume compression: 2.65XVolume space saved (MB): 58204......

Access Protocol: fcLUN: 0

Connected Initiators:Initiator: A11_hba3 (21:00:00:0e:1e:19:60:91)

Target FC Interface: (array7 : B : fc6.1) (56:c9:ce:90:4f:a6:c8:06)ALUA: standbyPR Key: 0Target FC Interface: (array7 : B : fc10.1) (56:c9:ce:90:4f:a6:c8:08)ALUA: standbyPR Key: 0Target FC Interface: (array7 : A : fc6.1) (56:c9:ce:90:4f:a6:c8:02)ALUA: active/optimizedPR Key: 0Target FC Interface: (array7 : A : fc10.1) (56:c9:ce:90:4f:a6:c8:04)ALUA: active/optimizedPR Key: 0

...

...

This example creates a volume named publicvol with a quota of 80 percent and no reserve. This is in casethe volume must be expanded later. No ACLs are included. They are added later.



Nimble OS $ vol --create publicvol --size 30--description "for use by everyone" --quota 80 --warn_level 75

This example modifies the size and description of a volume named publicvol and sets the volume to readonly.

Nimble OS $ vol --edit publicvol --size 50 --description "for use by me"--readonly yes

This example deletes the volume named publicvol.

Nimble OS $ vol --delete publicvol

This example brings a volume named publicvol online.

Nimble OS $ vol --online publicvol

This example takes the volume named publicvol offline.

Nimble OS $ vol --offline publicvol --force

This example creates a snapshot of the volume named publicvol and makes the new publicvolsnap snapshotwritable.

Nimble OS $ vol --snap publicvol--snapname publicvolsnap --description "a snapshot of the public volume"--allow_writes

This example takes a volume named publicvol offline, restores it from the snapshot named publicvolsnap,and brings the restored volume online.

Nimble OS $ vol --offline publicvol

Nimble OS $ vol--restore publicvol --snapname publicvolsnap

Nimble OS $ vol --online publicvol

This example lists snapshots, clones a volume named publicvol from its snapshot named publicvolsnap, andthen verifies the success of the operation.


(MB) Reason (MB)--------------------+----------+------+-----------+----------+---------+-------publicvol 30 Yes N/A 0 0.00 80.00

Nimble OS $ snap --list--------------------+--------------------+----------+------+-------+-----------Volume Snapshot Size Online Status New DataName Name (MB) (MB)--------------------+--------------------+----------+------+-------+-----------publicvol publicvolsnap 30 No Okay0

Nimble OS $ vol --clone publicvol --snapname publicvolsnap--clonename publicclone --description "testing version compatibility"




(MB) Reason (MB)--------------------+----------+------+-----------+----------+---------+-------publicclone 30 Yes N/A 0 0.00 100.00publicvol 30 Yes N/A 0 0.00 80.00

This example lists available volume collections and then associates one of the collections with a volumenamed publicvol.

Nimble OS $ volcoll --list--------------------+---------------+------------------------------------------Volume Collection Application Owned ByName Synchronization--------------------+---------------+------------------------------------------volcollone none greyhound

Nimble OS $ vol --assoc publicvol --volcoll volcollone

This example disassociates a volume named publicvol from a volume collection.

Nimble OS $ vol --dissoc publicvol

This example lists available CHAP users on an iSCSI array, adds an ACL for the CHAP user to a volumenamed publicvol, and then shows the ACL definitions. The vol --info output is truncated to save space andprevent line wrapping.

Nimble OS $ chapuser --list------------------------------+------------------------------------------------CHAP User Name Password------------------------------+------------------------------------------------nimblechap nimblechapuser

Nimble OS $ vol --addacl publicvol --apply_acl_to volume--chapuser nimblechap

Nimble OS $ vol --info publicvolName: publicvolSerial number: ff3161997a340eb76c9ce9004ec1399fiSCSI target: iqn.2007-11.com.nimblestorage:publicvol-v5e0c4565c135842b...Description: for use by everyone......Access Control List:

Apply to: volume & snapshotInitiator Group: *CHAP user: *Apply to: volumeInitiator Group: *CHAP user: nimblechap

Connected Initiators:......

This example removes the name of a CHAP user from the access control record on a volume named publicvolon an iSCSI array.



Nimble OS $ vol --removeacl publicvol --apply_acl_to volume --chapusernimblechap

This example claims ownership of a volume named publicvol for a replication partner named greyhound.

Nimble OS $vol --claim publicvol --partner greyhound

This example moves a volume named publicvol to a storage pool named secondary.

Nimble OS $vol --move publicvol --dest_pool secondary

This example stops the in-process move of a volume named publicvol.

Nimble OS $vol --abort_move publicvol



volcollThe volcoll command options manage volume collections. Volume collections are logical groups of volumesthat share protection characteristics, such as snapshot and replication schedules. Volume collection namesare case-sensitive. You can create volume collections or base them on predefined protection templates.Snapshots for all volumes in a collection are captured synchronously to ensure that the data across thesevolumes is mutually consistent. Volumes in a collection share snapshot and replication schedules, as wellas the retention policies for those snapshots. Similarly, during disaster recovery all volumes in a volumecollection simultaneously fail over to the replica array as a group. You need to create a volume collection foreach application.

Volume collections may include multiple schedules. When schedules overlap, snapshots, or replicas arecreated for every schedule. Schedules affect all volumes that are assigned to the volume collection. Volumecollections are limited to one downstream replication partner. If you want to replicate to multiple partners, youmust create a volume collection for each replication partner to which you want to assign replication.

Synopsis

volcoll --help

volcoll --list

volcoll --info volcoll_name

volcoll --create volcoll_name--prottmpl name[--description text]--app_sync {none|vss|vmware}[--app_server server][--app_id {exchange|sql2005|sql2008|sql2012|exchange_dag|sql2014}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username user_name][--vcenter_password password]

volcoll --edit volcoll_name[--newname template_name][--description text][--app_sync {none|vss|vmware}][--app_server server][--app_id {exchange|sql2005|sql2008|sql2012|exchange_dag|sql2014}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username user_name][--vcenter_password password]

volcoll --delete volcoll_name

volcoll --validate volcoll_name

volcoll --addsched volcoll_name--schedule name


volcoll

--repeat period--repeat_unit {minutes|hours|days|weeks}[--at time][--until time][--days {all|day1,day2,...}][--retain number][--replicate_to partner][--replicate_every number][--num_retain_replica number][--alert_threshold hh:mm][--snap_verify {yes|no}][--skip_db_consistency_check {yes|no}][--disable_appsync {yes|no}][--external_trigger {yes|no}]

volcoll --editsched volcoll_name--schedule name[--newname name][--repeat period][--repeat_unit {minutes|hours|days|weeks}][--at time][--until time][--days {all|day1,day2,...}][--retain number][--replicate_to partner][--replicate_every number][--num_retain_replica number][--alert_threshold hh:mm][--snap_verify {yes|no}][--skip_db_consistency_check {yes|no}][--disable_appsync {yes|no}][--external_trigger {yes|no}]

volcoll --deletesched volcoll_name--schedule schedule_name

volcoll --snap volcoll_name--snapcoll_name name[--description text][--start_online][--allow_writes][--replicate][--disable_appsync {yes|no}][--external_trigger {yes|no}][--snap_verify {yes|no}][--skip_db_consistency_check {yes|no}]

volcoll --promote volcoll_name

volcoll --demote volcoll_name--partner name

volcoll --handover volcoll_name--partner name



[--no_reverse][--abort]

volcoll --stop_repl volcoll_name--schedule name

Options



N/A--help

GuestList volume collections.N/A--list

GuestProvide detailed information aboutthe specified volume collection andits schedules. Volume collectionnames are case sensitive.

volcoll_name--info




OperatorCreate the specified volume collec-tion.

volcoll_name--create

Specify a protection template as abasis for defining protection-relatedattributes of the volume collection.If other options are specified, thoseoptions then override attributes thathave been derived from a protec-tion template. Any changes to theprotection template that occur afterthe volume collection is created donot affect any protection attributesof this collection.

--prottmpl name

Specify a plain-language descrip-tion of the volume collection. Ifthere are spaces in the description,enclose the text in quotation marks.


Define the application synchroniza-tion to apply. If you specify vsssynchronization, supply the --app_*credentials. If you specify vmwaresynchronization, supply the--vcenter_* credentials.


Specify the application server whenvss synchronization is enabled.


Define the application running onthe server when vss synchroniza-tion is enabled. Exchange DAGspecifies that it is a Microsoft Ex-change Server 2010 or later sup-porting Database Available Group.


Specify the cluster name if the ap-plication that uses vss synchroniz-ation is running within a Windowsclustering environment.


Specify the instance name of theservice if the application that usesvss synchronization is runningwithin a Windows clustering envir-onment.


Specify the host name of thevCenter server with which theNimble array will communicatewhen vmware synchronization isenabled.


Specify the Windows user name touse to create a Nimble account onthe vCenter server when vmwaresynchronization is enabled.





Specify the password associatedwith the user name when vmwaresynchronization is enabled.


OperatorModify the specified volume collec-tion. New volume collections basedon the template are affected by themodifications, but existing volumecollections are not. Specify at leastone suboption.

volcoll_name--edit

Modify the name of the volumecollection.

[--newname volcoll_name]

Modify the plain-language descrip-tion of the volume collection.


Modify the application synchroniza-tion to apply.


Modify the application server forvss synchronization.


Modify the application running onthe server for vss synchronization.


Modify the cluster name if the ap-plication that uses vss synchroniz-ation is running within a Windowsclustering environment.


Modify the instance name of theservice if the application that usesvss synchronization is runningwithin a Windows clustering envir-onment.


Modify the host name of the vCen-ter server with which the Nimblearray communicates for vmwaresynchronization.


Modify the Windows user name forvmware synchronization.


Modify the password associatedwith the user name for vmwaresynchronization.


PowerUser

Delete the specified volume collec-tion. Disassociate all volumes fromthe volume collection by using vol--dissoc before deleting the volumecollection.

volcoll_name--delete




Validate the specified volume col-lection with the Microsoft VSS ap-plication synchronization. You mustconfigure VSS application synchron-ization before you can validatesynchronization. To avoid affectingperformance, validate no more thanonce a day.

volcoll_name--validate




OperatorAdd a schedule to the specifiedvolume collection.

volcoll_name--addsched

Specify the name of the snapshotschedule to associate with thisvolume collection.

--schedule name

Specify the frequency of snap-shots. If you do not specify this op-tion, the default value of 1 is used.

--repeat period




[--at time]


[--until time]

Specify the days on which to takesnapshots unless the repeat unit isweeks. You can enter a comma-separated list of days, such asMon,Wed,Fri. If you do not specifythis option, the default value of allis used.



[--retain number]










If replicating a snapshot takes morethan this amount of time to com-plete, an alert will be generated. Ifyou do not specify this option, thedefault of 24 hours is used. Enter00:00 to disable this alert.




Specify whether to skip consistencychecks for database files on snap-shots created by this schedule. Usethis option with snapshot schedulesof a volume collection that has ap-plication synchronization of vss, theapplication ID is exchange_dag.,--snap_verify is set to yes, and--disable_appsync is set to no.









OperatorModify the specified schedule onthe specified volume collection.Specify at least one suboption inaddition to --schedule name.

volcoll_name--editsched

Specify the name of the snapshotschedule to modify.

--schedule name

Modify the name of the snapshotschedule.

[--newname name]

Modify the frequency of snapshots.[--repeat period]

Modify the unit of time for --repeatto define the frequency of snap-shots.

[--repeat_unit{minutes|hours|days|weeks}]

Modify the time of day to start tak-ing snapshots.

[--at time]

Modify the time of day to stop tak-ing snapshots.

[--until time]

Modify the days on which to takesnapshots unless the repeat unit isweeks.


Modify the maximum number ofsnapshots to keep.

[--retain number]

Modify the replication partner forreplicated snapshots.


Modify that a certain number ofsnapshots assigned to the sched-ule should be replicated.


Modify the number of snapshots toretain on the replication partner.


Modify whether to generate an alertif replicating a snapshot takes morethan this amount of time to com-plete.


Modify whether to run a verificationtool on snapshots created by thisschedule.


Modify whether to skip consistencychecks for database files on snap-shots created by this schedule.


Modify whether to disable applica-tion-synchronized snapshots andcreate crash-consistent snapshotsinstead.


Modify whether to use an externallydriven schedule with no internaltimers to create manual snapshots.





OperatorDelete the specified schedule fromthe specified volume collection.

volcoll_name--deletesched

Specify the schedule to delete.--schedule schedule_name




OperatorCreate a snapshot of volumes thatare associated with the specifiedvolume collection. Any createdsnapshots are consistent with eachother. If the volume collection isapplication synchronized (VMwareor VSS), the volume snapshots aresynchronized with the applicationas well. If application synchroniza-tion is disabled for all protectionschedules in the collection, thesnapshot is not taken and an erroroccurs.

volcoll_name--snap

Create the specified snapshot col-lection for the volume collection.The name is used for the snapshotas well as the snapshot collection.

--snapcoll_name name

Specify a plain-language descrip-tion of the snapshot collection. Ifthere are spaces in the description,enclose the text in quotation marks.


Specify whether to start the snap-shot collection in an online state. Ifyou do not specify this option, thesnapshot collection is started off-line.

[--start_online]

Specify whether to allow applica-tions to write to the snapshot collec-tion. If you do not specify this op-tion, the snapshot collection disal-lows writes.

[--allow_writes]

Specify whether to replicate thesnapshot collection and its mem-bers to a replication partner. If youdo not specify this option, thesnapshot collection is not replic-ated. If you do specify this option,create the replication partner usingpartner --create.

[--replicate]



Specify whether to use an extern-ally driven schedule to take thesnapshot instead of the Nimble-driven schedule.


Specify whether to run a verificationtool on this snapshot collection.





Specify whether to skip consistencychecks for database files on thissnapshot collection.


PowerUser

Take full ownership of the specifiedvolume collection. This option isused on a downstream replicationpartner. The volumes that are asso-ciated with the volume collectionare set to online, so they are avail-able for reading and writing. Replic-ation is disabled on the affectedschedules and must be recon-figured if needed. Snapshot reten-tion for the affected schedules isset to the greater of the currentlocal or replica retention values.

volcoll_name--promote

PowerUser

Release ownership of the specifiedvolume collection to the specifiedreplication partner. The volumesassociated with the volume collec-tion are set to offline and a snap-shot is created. Full control overthe volume collection is then trans-ferred to the new owner. You canuse this option following --promoteto revert the volume collection toits previously configured state. Thisoperation does not modify the con-figuration on the new owner array.The new owner array must be run-ning to obtain its identity informa-tion.

volcoll_name--demote

Specify the replication partner thatis given ownership of the volumecollection.

--partner partner_name




PowerUser

Gracefully transfer ownership ofthe specified volume collection tothe specified replication partner.Ownership and full control is givento the replication partner. Thevolumes that are associated withthe volume collection are takenoffline before the final snapshot istaken and replicated. Therefore,full data synchronization is ensuredas part of the transfer.

volcoll_name--handover

Specify the replication partner totransfer ownership to.

--partner name

Prevent automatically reversing thedirection of replication. If you donot specify this option, the newowner begins to replicate to theoriginal array when the handovercompletes.

[--no_reverse]

Cancel an in-progress handoverthat has not yet completed.

[--abort]

PowerUser

Discontinue replication for a protec-tion schedule of the specifiedvolume collection.

volcoll_name--stop_repl

Specify the protection schedule todiscontinue.

--schedule name

Examples

This example lists the volume collections on the array.

Nimble Storage $ volcoll --list--------------------+---------------+--------------------Volume Collection Application Owned ByName Synchronization--------------------+---------------+--------------------volcoll-DB1 VSS array1daily none array7

This example shows detailed information about a volume collection named daily.

# volcoll --info dailyName: dailyDescription:Owned by: array7Application synchronization: noneApplication server: N/AApplication ID: N/ACluster name: N/AService name: N/AVMware vCenter hostname: N/AVMware vCenter username: N/AVMware vCenter password: N/A



Associated volumes: na-Vol1, na-Vol5, na-Vol4, na-Vol3Associated pinned volumes: noneSnapshot collection count: 1Created: Feb 19 2014 15:30:50Last configuration change: Feb 19 2014 17:06:25Schedule Name: daily

Description:Type: Nimble ScheduleOwned by: array7Repeats: 1 day(s)At: 10:38:00 a.m.Until: N/ADays: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, SaturdayLast snapshot time: N/ANext snapshot time: Sep 4 2014 10:38:00Next replicable snapshot time: N/ANumber of snapshots to retain: 30Snapshot verification: N/ASkip database consistency check: N/ADisable appsync: NoNumber of snapshots to retain on replica: 10Replicate every: 1Latest collection replicated: noneReplicate from: array7Replication in-progress: noneCreated: Feb 19 2014 15:30:50Last configuration change: Aug 26 2014 13:28:33Last timing configuration change: Mar 5 2014 20:03:20

This example creates a new volume collection named forreplication. You must also add schedules to thevolume collection by using volcoll --addsched.

Nimble OS $ volcoll --create forreplication --description "use withreplication" --app_sync none

This example modifies the synchronization for a volume collection named vmwarevollcoll.

Nimble OS $ volcoll --edit vmwarevolcoll --app_sync vmware--vcenter_hostname 10.12.128.221 --vcenter_username admin--vcenter_password admin123

This example deletes a volume collection named forreplication.

Nimble OS $ volcoll --delete forreplication

This example validates a volume collection named volcollone, which is configured with app_sync set to vss.You must configure VSS application synchronization before you can validate synchronization using thiscommand.

Nimble OS $ volcoll --validate volcollone

This example adds a schedule to a volume collection named forreplication.

Nimble OS $ volcoll --addsched forreplication --schedule hourly--repeat 1 --repeat_unit hours --retain 25 --snap_verify no

This example edits a schedule for a volume collection named forreplication.



Nimble OS $ volcoll --editsched forreplication--schedule hourly --newname everyotherhour--repeat 2 --repeat_unit hours

This example deletes a schedule named everyotherhour from a volume collection named forreplication.

Nimble OS $ volcoll --deletesched forreplication--schedule everyotherhour

This example takes a snapshot collection of a volume collection named forreplication.

Nimble OS $ volcoll --snap forreplication--snapcoll_name snap4repl --allow_writes

This example promotes the volume collection named forreplication.

Nimble OS $ volcoll --promote forreplication

This example demotes a volume collection named forreplication.

Nimble OS $ volcoll --demote forreplication--partner array2

This example hands over a volume collection named forreplication to a replication partner named array2 andsets the configuration not to reverse replication direction.

Nimble OS $ volcoll --handover forreplication--partner array2 --no_reverse

This example stops replication for a schedule named everyotherhour on a volume collection namedforreplication.

Nimble OS $ volcoll --stop_repl forreplication --schedule everyotherhour



Regulatory Information

Regulatory Warnings

European Community, Australia, New Zealand

Warning

This is a Class A product. In a domestic environment this product may cause radio interference in which casethe user may be required to take adequate measures.

Israel

Warning


Korea

Warning


Taiwan

Warning


USA

This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant toPart 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful


Regulatory Information

interference when the equipment is operated in a commercial environment. This equipment generates, uses,and can radiate radio frequency energy and, if not installed and used in accordance with the instructionmanual, may cause harmful interference to radio communications. Operation of this equipment in a residentialarea is likely to cause harmful interference in which case the user is required to correct the interference athis own expense.


Regulatory Warnings


Regulatory Warnings

Index

? 6--all 6

A

alert 8, 9, 10--info 9--list 9--test 10

array 11, 14, 15--add 15--discover 14--edit 14--info 14--list 14--remove 15--resetup 14

auditlog 16, 17, 18--info 18--list 17, 18

C

cert 19--regen 19

chapuser 20, 21, 22--create 22--delete 22--edit 22--info 22--list 21

ctrlr 23, 24--info 24--list 23

D

date 25--edit 25--utc 25

disk 26, 27, 29, 30--add 30--info 29--list 27--remove 30

E

encryptkey 32, 33, 34--change_passphrase 34--create_master 33--delete_master 34--disable_master 34--enable_master 33--info 33

F

failover 35--array 35

fc 36, 37, 38, 39--edit 38--info 38--list 37--regenerate_wwn 39--update_config 38

G

group 40, 49, 50, 51--autosupport_initiate 51--autosupport_validate 50--create_throttle 50--delete_throttle 50--edit 50--edit_throttle 50--info 49--list 49--list_limits 51--merge 51--merge_validate 51--unset_http_proxy 51

H

halt 52, 53--array 53--group 53

help 6

I

initiatorgrp 54, 58, 59, 60--add_initiators 60--add_subnets 60--create 59--delete 59--edit 60--info 59--list 58--remove_initiator 60--remove_subnet 60

ip 61, 65, 66--add 65--delete 66--edit 66--info 65--list 65

M

migration 67, 68--info 68


migration (continued)--list 67

N

netconfig 69, 71, 72--activate 72--create_draft_from 72--delete 72--edit 72--info 71--list 71--validate 72

nic 73, 74, 75--info 75--list 74

P

partner 77, 82, 83, 84--create 83--create_throttle 83--delete 83--delete_throttle 84--edit 83--edit_throttle 83--info 83--list 82--pause 84--resume 84--test 84

perfpolicy 85, 89, 90--create 90--delete 90--edit 90--info 90--list 89

pool 91, 93, 94--assign 94--create 93--delete 94--edit 93--info 93--list 93--merge 94--unassign 94

prottmpl 95, 105, 106--addsched 106--create 106--delete 106--deletesched 106--edit 106--editsched 106--info 105--list 105

R

reboot 107, 108--array 108--group 108

regulatory warnings 183

route 109, 110--add 110--delete 110--edit 110--info 110--list 110

S

self-signed certificates 19setup 111shelf 115, 116, 117

--activate 117--add 117--info 116--list 116--show_topology 117

snap 118, 119, 120--cksum 120--delete 120--edit 120--info 120--list 119--offline 120--online 120

snapcoll 121, 122, 123--delete 123--edit 123--info 122--list 122

software 124, 126--cancel_download 126--download 126--download_status 126--info 126--list 126--precheck 126--update 126--update_status 126

sshkey 127, 128, 129--add 129--delete 129--edit 129--info 129--list 128

stats 130, 134--csv 134--fc 134--from 134--net 134

subnet 135, 138, 139--add 139--edit 139--info 138--list 138--remove 139

T

timezone 140--list 140--set 140


U

useradmin 141, 144--edit 144--info 144--list 144--passwd 144

usersession 146--info 146--kill 146--list 146

V

version 147vmwplugin 148, 150

--list 150--register 150--unregister 150

vol 151, 163, 165, 166, 167--abort_move 167--addacl 166--assoc 166--claim 167--clone 165--create 165--delete 165--dissoc 166--edit 165--info 163--list 163

vol (continued)--move 167--offline 165--online 165--removeacl 167--restore 165--snap 165

volcoll 168, 180, 181, 182--addsched 181--create 181--delete 181--deletesched 182--demote 182--edit 181--editsched 182--handover 182--info 180--list 180--promote 182--snap 182--stop_repl 182--validate 181

W

warnings 183

X

X.509 19


Command Reference 2 · 2017-10-31 · • To display a man page that introduces all the commands,...

Documents

Transcript of Command Reference 2 · 2017-10-31 · • To display a man page that introduces all the commands,...