Command Reference - infosight.hpe.com

Command Reference

Published February, 2021Version 5.3

Legal Notices

Copyright © 2020 by Hewlett Packard Enterprise Development LP

Notices

The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise productsand services are set forth in the express warranty statements accompanying such products and services. Nothing herein should beconstrued as constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors oromissions contained herein.

Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or copying. Consistentwith FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Com-mercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard Enterprise has no controlover and is not responsible for information outside the Hewlett Packard Enterprise website.

Acknowledgments

Intel®, Itanium®, Pentium®, Intel Inside®, and the Intel Inside logo are trademarks of Intel Corporation in the United States and othercountries.

Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/orother countries.

Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.

Java® and Oracle® are registered trademarks of Oracle and/or its affiliates.

UNIX® is a registered trademark of The Open Group.

All third-party marks are property of their respective owners.

Publication Date

Tuesday February 16, 2021 15:36:23

Document ID

ghf1602207026212

Support

All documentation and knowledge base articles are available on HPE InfoSight at https://infosight.hpe.com. To register forHPE InfoSight, click the Create Account link on the main page.

Email: [email protected]

For all other general support contact information, go to https://www.hpe.com/us/en/services/nimble-storage.html.

https://infosight.hpe.com

mailto:[email protected]

https://www.hpe.com/us/en/services/nimble-storage.html

Contents

The Nimble CLI..................................................................................................................................5CLI Help.............................................................................................................................................................................................................................................................5

Nimble Administrative Commands...............................................................................................7alarm....................................................................................................................................................................................................................................................................7

alert...................................................................................................................................................................................................................................................................10

array..................................................................................................................................................................................................................................................................13

auditlog...........................................................................................................................................................................................................................................................17

cert....................................................................................................................................................................................................................................................................20

chapuser.........................................................................................................................................................................................................................................................28

ctrlr....................................................................................................................................................................................................................................................................31

date...................................................................................................................................................................................................................................................................32

disk....................................................................................................................................................................................................................................................................33

encryptkey....................................................................................................................................................................................................................................................38

failover............................................................................................................................................................................................................................................................41

fc.........................................................................................................................................................................................................................................................................42

folder................................................................................................................................................................................................................................................................47

group................................................................................................................................................................................................................................................................51

halt.....................................................................................................................................................................................................................................................................79

initiatorgrp....................................................................................................................................................................................................................................................80

ip.........................................................................................................................................................................................................................................................................89

keymanager..................................................................................................................................................................................................................................................94

migration........................................................................................................................................................................................................................................................96

netconfig........................................................................................................................................................................................................................................................97

nic....................................................................................................................................................................................................................................................................101

partner..........................................................................................................................................................................................................................................................104

pe.....................................................................................................................................................................................................................................................................111

perfpolicy....................................................................................................................................................................................................................................................111

pool................................................................................................................................................................................................................................................................116

prottmpl......................................................................................................................................................................................................................................................120

reboot...........................................................................................................................................................................................................................................................134

route..............................................................................................................................................................................................................................................................135

setup..............................................................................................................................................................................................................................................................137

shelf...............................................................................................................................................................................................................................................................140

snap...............................................................................................................................................................................................................................................................143

snapcoll........................................................................................................................................................................................................................................................147

software.......................................................................................................................................................................................................................................................149

sshkey...........................................................................................................................................................................................................................................................152

Contents 3

Nimble Storage

stats...............................................................................................................................................................................................................................................................154

subnet...........................................................................................................................................................................................................................................................159

support.........................................................................................................................................................................................................................................................164

timezone......................................................................................................................................................................................................................................................165

useradmin...................................................................................................................................................................................................................................................166

userauth......................................................................................................................................................................................................................................................169

userpolicy...................................................................................................................................................................................................................................................173

usersession................................................................................................................................................................................................................................................174

vcenter.........................................................................................................................................................................................................................................................175

vm...................................................................................................................................................................................................................................................................177

version..........................................................................................................................................................................................................................................................178

vmwplugin..................................................................................................................................................................................................................................................179

vol...................................................................................................................................................................................................................................................................181

volcoll............................................................................................................................................................................................................................................................202

witness.........................................................................................................................................................................................................................................................218

Regulatory Information........................................................................................................................................................................................................................................219

Regulatory Warnings...........................................................................................................................................................................................................................219

The Nimble CLI

Use NimbleOS administrative commands from the command line interface (CLI) to configure and monitor an HPE NimbleStorage array.

Use a secure shell (SSH) utility to log in to the management IP of an HPE Nimble Storage array to run administrative commands.Your role determines your permission level, which in turn determines the command options you can run.

After you log in, you see a security message for array usage. You do not have to acknowledge the security message.

Enter ? to display a list of administrative commands. Then use any or all of the following options to get more informationabout the commands.

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

The output lists each option and suboption, and provides brief descriptions of each.

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

The output lists each command, and provides brief descriptions of each. Press the space bar to page through the list. Pressq to quit when you get to the end of the introduction.

• To display detailed information for a specific command, enter man command_name.

The output lists the command name and brief description, synopsis of each option and suboption, and detailed descriptionsof each option and suboption, including valid values. Press the space bar to page through the list. Press q to quit whenyou get to the end of the man page.

CLI Help

The ? command lists the NimbleOS 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 the com-mand.

N/A--help

GuestShow all available commands, not justthe Nimble-specific administrative com-mands.

N/A--all

The Nimble CLI 5

Examples

This example lists the administrative commands used 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

The Nimble CLI 6

Nimble Administrative Commands

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

Use either the NimbleOS graphical user interface (GUI) or the command line interface (CLI) to perform administrative operationson an HPE Nimble Storage array or group of arrays.

These interfaces provide comparable management capabilities. The GUI has tool tips, embedded user assistance, and help toguide you through administrative operations interactively. The CLI is useful to script frequently performed operations.

alarm

The alarm command lets you view and manage alarms and notifications. By default, all alarms are displayed when you use thealarm command with the --list option. However, you can filter for severity levels, categories, and time spans. For example, youmight want to generally limit alarms to only recent ones, but regularly view a longer-term list of alarms to look for patternsof error. Filtering lets you manage only the alarms you are interested in. You can also add and modify reminders or notificationsto alarms such as changing the frequency of alarm notifications.

Synopsis

alarm --help

alarm --list[--from [[yyyy-]mm-dd,]hh:mm[:ss]][--to [[yyyy-]mm-dd,]hh:mm[:ss]][--category name][--severity level]

alarm --info id

alarm --acknowledge id[--remind_every period][--remind_every_unit {minutes|hours|days}]

alarm --unacknowledge id

alarm --edit id[--remind_every_period][--remind_every_unit {minutes|hour|days}]

alarm --delete id

Options



N/A--help

Nimble Administrative Commands 7


OperatorList all alarms and their IDs. For examplealarm --list shows all info, while alarm --list --from 08-14,11:26:00 lists onlyalarms that appear after August 14th at11:26 am. You can specify time with nodate, but if you specify a date you mustinclude a time.

The --list option takes the following sub-options.

N/A--list

List alarms starting from a specified time.Often used with the --to option to framean alarm list. Use only the time, or thedate and time, for example, alarm --list --from 2015-08-25,12:10:00 or alarm --list --from 12:10:00.

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

List alarms until specified time. Oftenused with the --from option. If not speci-fied,--list continues with no end time. Useonly the time, or the date and time, forexample, alarm --list --to 2017-08-25,12:10:00 or alarm --list --from 05:15--to 12:10:00.

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

Restrict the list of alarms to only includethe specified category. Valid categoriesare hardware, service, replication, volume,update, config and security.

[--category name]

Restrict the list of alarms to only includethe specified severity. Valid severitiesare warning and critical. The option willonly return alarms of the severity speci-fied.

[--severity level]

GuestShow detailed information about a spec-ified alarm. For example, alarm --info 668displays information about a alarm 668.To determine an alarm ID, enter alarm --list.

id--info



GuestAcknowledge an alarm with the currentusername. For example, alarm --acknowl-edge 668 makes the current user the onethat acknowledges alarm 668, and setsthe acknowledged date as the currentdate. To determine the alarm ID, enteralarm --list.

The --acknowledge option takes the fol-lowing sub-options.

id--acknowledge

Frequency of alarm notification. The validrange is 0-60. If this option is unspeci-fied, it defaults to 1 and --remind_ev-ery_unit is set to day, so an alarm notifi-cation is sent every hour. If the --re-mind_every option is set to 0, a reminderemail will not be sent.

[--remind_every period]

Units for reminder frequency in minutes,hours or days. If this option is unspeci-fied, the default unit of day is used.

[--remind_every_unit {min-utes|hours|days}

OperatorWhen you unacknowledge an alarm, itclears the acknowledged user and datefields. To determine the alarm ID, enteralarm --list.

id--unacknowledge

OperatorEdit the notification frequency for aspecified alarm. To determine the alarmID, enter alarm --list. The --edit optiontakes the following sub-options.

id--edit

The frequency of alarm notifications. Thevalid range is 0-60. If this option is un-specified, it defaults to 1 and --remind_ev-ery_unit is set to day, so that an alarmnotification is sent every hour. If the--remind_every option is set to 0, a re-minder email will not be sent.

[--remind_every period]

Units for reminder frequency in minutes,hours or days. If this option is unspeci-fied, the default unit of day is used.

[--remind_every_unit {min-utes|hours|days}

Power userDelete a specified alarm. For example,alarm --delete 1 deletes the currentalarm 1 if it exists. Be careful using thiscommand because an alarm indicatessevere conditions on the system andshould not be ignored. To determine thealarm ID, use alarm --list.

id--delete


Example

The following example lists all alarms in the group where you run the command.

Nimble OS $ alarm --list-----+----------+---------------------+---------+--------+--------------------------------ID Severity Time Status Array Detail-----+----------+---------------------+---------+--------+--------------------------------5 CRITICAL Oct 20 2016 16:49:30 Open - Volume test stringfrom alertgen space usage is at 0% and approaching quota of 0%. It will be taken offlineif it exceedsthe quota

The following example lists all the alarms on the array (there is only one) and then acknowledges that alarm setting thenotifications of the alarm to remind the user every day.

Nimble OS $ alarm --list-----+----------+---------------------+---------+---------+--------------------------------ID Severity Time Status Array Detail-----+----------+---------------------+---------+---------+--------------------------------5 CRITICAL Oct 20 2016 16:49:30 Open - Volume test stringfrom alertgen space usage is at 0% and approaching quota of 0%. It will be taken offlineif it exceedsthe quota

Nimble OS $ alarm --acknowledge 5 --remind_every 1 --remind_every_unit days

The following example lists detailed information about the alarm with ID 5.

Nimble OS $ alarm --info 5ID: 5Severity: criticalCategory: volumeOnset time: Oct 20 2016 16:49:30Array: -Object type: volumeObject name: testDescription: Volume test string from alert gen space usage is at 0% andapproaching quota of 0%.It will be taken offline if it exceeds the quotaStatus: AcknowledgedAcknowledged by: adminAcknowledged time: Oct 26 2016 15:59:55Repeat period: Every 1 daysNext reminder time: Oct 27 2016 16:00:48

alertThe alert command options manage array alerts, which include certain events. You can also use the command options todisplay information about alerts and events. Alerts and events can use both email and SMTP notification methods.

Note: The terms event and alert are sometimes used interchangeably. While an event can have different severitylevels, the term event is often used to refer to a non-critical issue, such as a change to your environment. The termalert refers to real-time notifications about issues, such as warning events, that can adversely affect your system. Youcan use alerts and events as a diagnostic and preventative tool. For more information about alerts and events, seeeither the GUI Administration Guide or the CLI Administration Guide.


By default, all alerts and events are displayed when you use the alert --list command. You can filter the display based onseverity levels, categories, and time spans so that you display only the alerts that you are interested in. For example, you canfilter for the most recent alerts, and periodically list all of them to look for 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|notice|warning|critical}]

Options



N/A--help

GuestList alerts and events for the specifiedarray.

[--array array_name]--list

List alerts that start from the specifiedtime. Use only the time, or use the dateand time. For example, alert --list --from08-14,12:10:00 or alert --list --from12:10:00. Use this option with or withoutthe --to option. If used alone, --to is as-sumed to be now.

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

List alerts until the specified time. Useonly the time, or use the date and time.For example, alert --list --to 08-14,12:10:00 or alert --list --to 12:10:00.Use this option with or without the--from option.


List alerts and events of the specifiedseverity level. Alert levels are not cumu-lative. For example, selecting critical doesnot show the info or warning severitylevels.

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

List alerts and events of the specifiedcategory.

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



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

id--info

Power UserGenerate a test alert with the specifiedseverity level.

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

Examples

This example lists all alert messages on the array where you run the command. The output is truncated to save 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: 23Active: 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 Fibre Channelarray, there is no I/O between running array --resetup and setup. On an iSCSI array, existing connections may beunaffected, 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][--allow_lower_limits]

array --remove name[--force]

Options



N/A--help



GuestList all discovered and group memberarrays.

N/A--list

Power UserDiscover non-member arrays on thesame management subnet.

N/A--discover

GuestProvide detailed information about thespecified group-member array.

{name | serial_number}--info

Power UserModify the name of the array. The namemust conform to iSCSI naming conven-tions. It can be any combination of up to63 alphanumeric characters and hyphen,but cannot begin with a hyphen, or con-tain spaces or other punctuation.

[--name new_name]--edit

Administra-tor

Set a standalone array in a state whereyou can run the setup command again.This reenables the zeroconf process andlets you reset the array password, IP ad-dress, and most other configuration set-tings. No data will be lost. After runningthis command, any computer on thesame subnet as the array can be used toreset the array password and then con-trol the array. Use this command withcaution. Minimize the time between reset-ting the array with this command andrunning setup again to limit I/O disrup-tion. On a Fibre Channel array, there isno I/O between running array --resetupand setup. On an iSCSI array, existingconnections may be unaffected, but newconnections are refused.

N/A--resetup

Override the default behavior of havingto type "yes" to complete the command.Use this suboption with care to avoidunexpectedly setting up the array.

[--non_interactive]



Power UserSerial number of a discovered array toadd to a group.

serial_number--add

Name of a array to add to a group. Thegroup must exist.

[--name name]

Subnet label on the NIC. Repeat this op-tion to specify more than one subnet la-bel. The first subnet label is assigned tothe first NIC, such as eth1, the secondsubnet label is assigned to the secondNIC, such as eth2, and so on. To skip asubnet label, enter a blank argument.

[--subnet_label subnet_label]

The network IP address(es) that willmanage data traffic. Repeat this optionto set multiple IP addresses for multipleNICs. Then the first IP address is as-signed to the first NIC, such as eth1, andthe second to the second NIC, such aseth2, and so on. To skip a NIC, type ablank argument.

[--data_ipaddr ipaddr]

NIC and subnet setting.[--nic nic]

Specify tagged assignment. Repeat thisoption to specify more than one assign-ment. The first tag is assigned to the firstNIC, such as eth1, the second tag is as-signed to the second NIC, such as eth2,and so on. To skip an assignment, entera blank argument.

[--tagged tag]

Include this argument twice. Then thefirst IP address entered is assigned toController A and the second to ControllerB. You must assign static IP addressesto allow array access if the managementIP address is not accessible.

[--support_ipaddr ipaddr]

Pool to assign the array to. If you specifythis suboption, then the pool must exist.If you do not specify this suboption orthe --create_pool suboption, then thearray is assigned to the default pool.

[--pool pool_name]

Create a new storage pool and automat-ically assign the array to it. If you do notspecify this suboption along with the--pool suboption, then the array is as-signed to the default pool.

[--create_pool]

If you create a new pool for an array, typea description for the pool. If there arespaces in the description, enclose thetext in quotation marks.

[--pool_description pool_description]

[--allow_lower_limits]



If you add an array to an existing pooland the pool's limits are higher than thearray's limits, the resulting pool will havethe lower limits of the array being added,which could also change the group limitsto lower values.

Power UserName of the array to remove from agroup. Use the pool command to removethe array from any pools.

name--remove

Forcibly remove the specified array froma group even if it is unreachable. Thismay lead to loss of data if a volume iscurrently striped across disks on the ar-ray.

[--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,afuture 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 during this process.

Although only one set of name, subnet_label, data_ipaddr, and pool options is required, you can use multiple sets of theseoptions 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 the array froma pool before you run this command.

Nimble OS $ array --remove greydient

auditlogThe auditlog command options manage array audit log entries.

The NimbleOS audit log keeps records of all non-read operations performed on the array, and which user performed theoperation. You can search the audit log by activity and object type/name. You can also filter the audit log by time range,username, userid, activity category, and access type. Administrators can view the audit log in a summary table with facetedbrowsing 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

Administra-tor

List all audit log records.N/A--list

List audit logs that start from the speci-fied time. Use only the time, or use thedate and time. For example, auditlog --list --from 08-14,12:10:00 or auditlog --list --from 12:10:00. Use this option withor without the --to option. If used alone,--to is assumed to be now.


List audit logs until the specified time.Use only the time, or use the date andtime. For example, auditlog --list --to 08-14,12:10:00 or auditlog --list --to12:10:00. Use this option with or withoutthe --from option.


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

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

List audit logs of the specified category.[--category {provision|protection|dataac-cess| useraccess|sysconfig|swupdate}]

List audit logs using the specified accesstype.

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

Administra-tor

List detailed information about thespecified audit log ID. To determine validaudit 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 to save 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. The output is truncatedto 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: GUI


Application name: GUICategory: Data ProtectionActivity type: otherActivity: Associate volume vol2 with volume collection volcoll2

cert

The cert command is used to manage certificates used by a number of components that support SSL/TLS. These include theweb GUI interface, the VASA provider, the CIM server, and Group Management REST APIs. It is possible to select differentcertificate chains for each of these. In addition, a list of trusted certificates can be managed for use by internal clients, forexample to provide verification of an external key manager that presents its own self-signed certificate on connection.

To establish a secure connection with a website or other server, the array presents a certificate to authenticate its identity.Certificates are an important component of the Secure Sockets Layer (SSL), because they prevent others from impersonatinga secure website or other server.

The default values used for the subject, dnslist, and iplist are taken from the existing group certificate, if no correspondingoptions are provided.

There are three certificate chains that are managed using the cert command: array, group, and custom.

Array certificate chain:

The array certificate is generated automatically before group setup.

Group certificate chain:

The group certificate is generated after the group leader has been configured.

Custom certificate chain:

A custom certificate may also be installed and used. It can be either a self-signed (custom), or a Certificate Signing Request(custom-csr) that can be exported to be signed by a local Certificate Authority (CA). The CA certificate and the resultingsigned custom certificate may then be imported for use.

Synopsis

cert --help

cert --list

cert --info cert-name

cert --gen {array|group|custom|custom-csr}[--subject subject_name][--dnslist dns_list][--iplist ip_list][--num_days days][--check][--force]

cert --import cert-name[--pks12][--password unlock_password][--trusted][--from_host host:port][--force]

cert --delete {cert-name}


cert --use {array|group|custom}[--https][--apis]

cert --verify cert-name[--checkend days][--oscp]

Options

RoleDescriptionArguments andSuboptions

Option

Administra-tor

Shows usage informa-tion for the command.

N/A--help

Administra-tor

List each of the certifi-cates installed, andwhich are being usedfor HTTPS and APIaccess.

N/A--list

Administra-tor

Print output thatshows all of the de-tails, as well as thePEM encoding, of thegiven certificate orCSR.

{cert-name}--info



Option

Administra-tor

Initiates the creationof either a self-signedcertificate, or a Certifi-cate Signing Request(CSR). The argumentspecifies whether tocreate a certificate ofthe type specified orto create a CSR for acustom certificate.Thecustom option gener-ates a self-signed cer-tificate with the param-eters specified, whilethe custom-csr optiongenerates a CSR withthe parameters speci-fied. A custom certifi-cate and be eitherself-signed or signedby an external Certifi-cate Authority (CA).The array and groupcertificates are gener-ated automatically foruse by HTTPS andAPI services.

{array|group| custom|cus-tom-csr}

--gen

Subject or commonname for the certifi-cate. The default valuefor the subject namewill be the groupname. If the value is "-" or the option is notpresent, then an at-tempt is made to ex-tract the subject namefrom the existinggroup certificate, ifthere is one. The valueis treated as a fullsubject name if it be-gins with "/", in theformat that OpenSSLuses. Otherwise, it istaken as the CommonName value.

[--subject subject-name]

[--dnslist dens-list]



Option

A comma separatedlist of DNS names toadd to the subject al-ternate name field ofthe host certificate. Ifthe value is "-" or theoption is not specified,an attempt is made toextract the DNSnames from the exist-ing group certificate,if there is one.

A comma separatedlist of IP addressess toadd to the subject al-ternate name field ofthe host certificate. Ifthe value is "-" or theoption is not specified,an attempt is made toextract the DNSnames from the exist-ing group certificate,if there is one. Tospecify an empty IPlist, use "--ip-list ''"

[--iplist ip-list]

Number of days forwhich the certificatewill be valid. The de-fault value of thenumber of valid daysis 3650.

[--num_days days]

Check the currentsubject, DNS list, andIP list of the currentgroup certificateagainst the providedinputs. A new certifi-cate chain is only gen-erated if the checkedvalues do not matchthe group certificatevalues.

[--check]

Force overwriting ofan existing certificatechain. Otherwise, theexisting certificate isleft as is.

[--force]



Option

Administra-tor

Import a custom CA(custom-ca), signedcustom certificate(custom), or a trustedcertificate to be usedby internal clients. Thecustom-ca certificatemust be imported be-fore the signed cus-tom certificate. Afterthe custom certificateis imported and veri-fied, it will be installedfor use. The importedcertificate should bevalid for use as bothSSL server and client,since it may be usedas an outbound clientcertificate.

A combined bundle ofkey, CA certificate,and signed certificatemay also be importedusing the PKCS12 for-mat. This format ismost useful for in-stalling a wildcard cer-tificate.

cert-name--import

Administra-tor

Import a PKCS12 filethat contains a privatekey, CA certificate(s),and signed host certifi-cate. Use the customcommand argument.

[--pkcs12]

Administra-tor

The password to un-lock a PKCS12 inputfile.

[--password unlock-pass-word]

Administra-tor

Import a certificate toadd to the list of certifi-cates trusted by inter-nal SSL clients. Thecertificate can eitherbe read from standardinput, or retrievedfrom the specifiedhost. When this flag isset, the names cus-tom-ca, custom,group, and array arereserved.

[--trusted]



Option

[--from_host host:port] Administra-tor

When used with the--trusted option, at-tempt an SSL connec-tion to the specifiedhost and port, and im-port the presentedcertificate to thetrusted certificate list.

Force overwriting ofan existing certificate.Otherwise, the exist-ing certificate is left asis.

[--force]

Administra-tor

Delete a certificate,along with any associ-ated private key andoptional certificates.Deleting the array orarray-ca certificate isnot allowed.

{cert-name}--delete

Administra-tor

Select one of the ar-ray, group, or customcertificate chains touse for HTTPS accessor API use.

Use the named certifi-cate for HTTPS ser-vice.

Use the named certifi-cate chain for accessto Nimble APIs (RESTand internal NimbleAPIs).

{array|group|custom}

[--https]

[--apis]

--use



Option

Administra-tor

Verify the signature,expiration time, and(optionally) the OCSPstatus of the namedcertificate. When usedwith no suboptions,verify the signatureand whether the certifi-cate has expired.

cert-name--verify

Administra-tor

Check if the certificateexpires withing thespecified number ofdays. If not present,the default value is 0.

[--checkend days]

Administra-tor

If the certificate as anOSCP reference includ-ed, contact the OSCPservice and determinethe status of the cer-tificate.

[--oscp]

Examples

To create and install a custom certificate on an array, you must perform the following steps from an ssh session:

Nimble OS $ cert --gen custom-csr --subject '/C=US/ST=CA/L=San Jose/O=Nimble Storage/OU=Engineering/CN=AF106656'--dnslist group-kent-vma.nimblestorage.com,kent-vma.nimblestorage.com

-----BEGIN CERTIFICATE REQUEST----- MIICuTCCAaECAQAwWDELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMREwDwYDVQQH DAhTYW4gSm9zZTEXMBUGA1UECgwOTmltYmxlIFN0b3JhZ2UxEDAOBgNVBAMMB2xu LWtlbnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD1p+rdq/GvuALc qqam6AIoKfC8X4WFN+xOSmco7cQliZnmYNyX1Rzrw0RyIYwfBOeSff+47pw6Hv6S TY54lMMf7/5vMmEoR56DaolkI9RgmMnQM8Ay6YnRjWZtE7TFRiId+r7cYlPlREWd 0Mq25psKqEaNl8QzNVFhxOdPCe//cP6Z91R2GanR+cafAmSZ8ELfkFvdlWnU5Vdv cCHH73IkHtZbgWVy9yJJ2ZZT9Lv31rPjx2rP+h305VrWWa7xWyTI0FD86y5n41Zn Yx8ypE8E0dcSENlNX9evRzGyPfhIg11JaHTkad/REpAwXSDilEcl4/0jRfKBaq/M YD6U1Z8tAgMBAAGgHDAaBgkqhkiG9w0BCQ4xDTALMAkGA1UdEQQCMAAwDQYJKoZI hvcNAQEFBQADggEBABcwx0s4dvaBbVv2NYNs/tYq/pwynGcF19+MIVtrCxoYQ3h3 MObHTu0k0+LgWNZeJKDfD2AKHGnQMjP1lWqHqbZLwxbioFotxIYd/XwIMSlshBLS WegYzrCbfDTeQMLV7XozIfcGEUZzQF+hSY7SPJGLRZTHCAl/hD0LXthl6fUB2ynZ QsjA3q38+OV/H37vkXA0jY5oxFcPwPGGh6jLVMBspY2OHnxGiUIEganpxk3XtOAh bYdvo88B0WRV7chDfL2/VzythDL8vOPxSsY8leCdXOq8dnUb2t5Yo8cBqc2J58ON HiDL7gI4YR/EafXDuHJwGnqMqGGlddktAQkTWWI= -----END CERTIFICATE REQUEST-----

You must then cut-and-paste the certificate request output into a signing request to the CA.


Then cut-and-paste the CA certificate and the output from the signing into the command inputs below:

Nimble OS $ cert --import custom-caNimble OS $ cert --import custom

-----BEGIN CERTIFICATE----- MIIEADCCAuigAwIBAgIJALkB09sKkc1IMA0GCSqGSIb3DQEBBQUAMF0xCzAJBgNV BAYTAlVTMQswCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxFzAVBgNVBAoM Dk5pbWJsZSBTdG9yYWdlMRUwEwYDVQQDDAxrZW50YXJyYXktQ0EwHhcNMTUwNjIy MjIxNDMxWhcNMjUwNjE5MjIxNDMxWjBdMQswCQYDVQQGEwJVUzELMAkGA1UECAwC Q0ExETAPBgNVBAcMCFNhbiBKb3NlMRcwFQYDVQQKDA5OaW1ibGUgU3RvcmFnZTEV MBMGA1UEAwwMa2VudGFycmF5LUNBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAmLA18pIh44mkgGPll9jpey+IXso+mwJAckrfgxh8Z7+54L9K5/sGy4Fe nN8+DsPc7qtNl1lnQ0nptkDjmQph3sV34NB1nOg+cI+pSMRC1kZk2ZAfW0xWeJJI /JBTQFWOzbe2PgmJNMN0gMI8eeco9PmR3n9+WEGsos6SsUsW/WHSNo41ujuZV0wm LmLP/mv1WuoUWpDZwyzk0uovSihkcTbCihm7yHYpKMxvYMy88/Hea7rBbQaid9z/ xceEZ6cnEotZcEyJP+u0Z7FMiPfzcPY77XV1IsiVB1eVohOP1GURlD2J9v1XIi1U 1H98R4vGeynI7rjxo7dhsZu1K9xVIwIDAQABo4HCMIG/MB0GA1UdDgQWBBShBlOm mIP2S84mJ3wTMoWJgEYumzCBjwYDVR0jBIGHMIGEgBShBlOmmIP2S84mJ3wTMoWJ gEYum6FhpF8wXTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMREwDwYDVQQHDAhT YW4gSm9zZTEXMBUGA1UECgwOTmltYmxlIFN0b3JhZ2UxFTATBgNVBAMMDGtlbnRh cnJheS1DQYIJALkB09sKkc1IMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQAD ggEBAGTzXWDcMI/OnP/KerhpGPfns0VUMzvvYaKn5Db5ADEPL5vafawhsOyTMgnu 7hwiL11Zy6qJ+e0g85Zm0v0mg4wKyM3QKvbf86lu8YKvEoYoCWcOcsRDt2ijrbx7 IkRyXOypI0nIN76vNQpo1NtZ+e3XvzAShrFdZNtsi8ILZqEOepr/PBNJOv1hAszv CpcZ6uBMxodez2lHT7ceb5ZxYJZnOoNkLTMKp9MV7Qt0v8xDKWMy9ED9PuJ79f+v pzmJPTcv2pFHrMoPXqZFxXVTXk5GwjORGlbqvAdsGexZ3vqbmfgQvVuDdw9Zd60v qkg4gT6MJsnfdgsOgpRg5/4CRao=

-----END CERTIFICATE-----

-----BEGIN CERTIFICATE----- MIIDhTCCAm2gAwIBAgIJAId2ciTqy7mCMA0GCSqGSIb3DQEBBQUAMF0xCzAJBgNV BAYTAlVTMQswCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxFzAVBgNVBAoM Dk5pbWJsZSBTdG9yYWdlMRUwEwYDVQQDDAxrZW50YXJyYXktQ0EwHhcNMTUwNjIy MjIxNDMyWhcNMjUwNjE5MjIxNDMyWjBYMQswCQYDVQQGEwJVUzELMAkGA1UECAwC Q0ExETAPBgNVBAcMCFNhbiBKb3NlMRcwFQYDVQQKDA5OaW1ibGUgU3RvcmFnZTEQ MA4GA1UEAwwHbG4ta2VudDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB APWn6t2r8a+4AtyqpqboAigp8LxfhYU37E5KZyjtxCWJmeZg3JfVHOvDRHIhjB8E 55J9/7junDoe/pJNjniUwx/v/m8yYShHnoNqiWQj1GCYydAzwDLpidGNZm0TtMVG Ih36vtxiU+VERZ3QyrbmmwqoRo2XxDM1UWHE508J7/9w/pn3VHYZqdH5xp8CZJnw Qt+QW92VadTlV29wIcfvciQe1luBZXL3IknZllP0u/fWs+PHas/6HfTlWtZZrvFb JMjQUPzrLmfjVmdjHzKkTwTR1xIQ2U1f169HMbI9+EiDXUlodORp39ESkDBdIOKU RyXj/SNF8oFqr8xgPpTVny0CAwEAAaNNMEswCQYDVR0TBAIwADAdBgNVHQ4EFgQU dudH4pEro5KcsujvyGr728sKSyAwHwYDVR0jBBgwFoAUoQZTppiD9kvOJid8EzKF iYBGLpswDQYJKoZIhvcNAQEFBQADggEBAJcsLauYn1AmaApF4uag6kljGls2K2qm DNBQy2w2IWM9ffxSR+j0DhVgbgHQrMkTwCy9pgFAXS9MXCVF3BfLW1J9UdZXmegt AsITa9xDthJqMwvweT7s3Gzwlc8zRXZOCXe79+YF3sZhWlFV5E1ex1iHmIwA7x9T Twe4timzAsyjKQFOSm8ggQxbizoTDXpehiDgSDxzqL+8wggi13sC4ibAgGDzGAvC u4EwtNlluIKBGnDHaGyfxv8ZT0jkHEB/KTFZAq8a0TVRZHi9TpnGszNcA9aV8ZKC VHZPdBqjcDJBjFiLFZa9palRHIl3Q3laLVU+lEQZhD0M/x0TZwvPIUY= -----END CERTIFICATE-----

The following example is used to change APIs to use the group certificate.


Display the current status.

sjc-array289-A:/# cert --listName Subject===================array: /C=US/ST=CA/L=San Jose/O=Nimble Storage/CN=AF-106720group: /C=US/ST=CA/L=San Jose/O=NimbleStorage/CN=sjc-array289.WIN2K8R2AD.NETcustom: /C=US/ST=CA/L=San Jose/O=Nimble Storage/CN=sjc-array289-Acustom-csr: /C=US/ST=CA/L=San Jose/O=Nimble Storage/CN=sjc-array289-A

Use Name===================HTTPS: customAPIs: custom

Run the command to change APIs to use the group certificate.

sjc-array289-A:/# cert --use group --apisINFO: group certificate chain installed for API use

Run the command to display the updated status.

sjc-array289-A:/# cert --listName Subject===================array: /C=US/ST=CA/L=San Jose/O=Nimble Storage/CN=AF-106720group: /C=US/ST=CA/L=San Jose/O=NimbleStorage/CN=sjc-array289.WIN2K8R2AD.NETcustom: /C=US/ST=CA/L=San Jose/O=Nimble Storage/CN=sjc-array289-Acustom-csr: /C=US/ST=CA/L=San Jose/O=Nimble Storage/CN=sjc-array289-A

Use Name===================HTTPS: customAPIs: group

chapuser

Synopsis

The chapuser command options manage Challenge-Response Handshake Authentication Protocol (CHAP) user accounts.CHAP users are one method of access control for iSCSI initiators. Each CHAP user has a CHAP password, sometimes called aCHAP secret.

CHAP passwords must be the same on the array and the iSCSI initiator before the array can authenticate the iSCSI initiatorand permit access. 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 secret when connecting oreach iSCSI initiator can have its own. The CHAP user name cannot include certain special characters.

Arrays that use the Fibre Channel protocol do not require CHAP user accounts.

chapuser --help

chapuser --list

chapuser --info user_name

chapuser --create user_name


--password password[--description text]

chapuser --delete user_name[--force]

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

chapuser --add_initators user_name[--initiator_name iqn]

chapuser --remove_initator user_name[initiator_name iqn]

Options



N/A--help

OperatorList all configured CHAP users for thisarray.

N/A--list

OperatorShow information about a specific CHAPuser.

user_name--info

OperatorCreate a new CHAP user and sharedpassword for the CHAP user, who thengets assigned to an access control list(ACL)-associated volume. CHAP userauthentication requires a CHAP secretthat agrees as the challenge response.

user_name--create

The CHAP secret. The CHAP secret mustbe must be between 12 and 16 alphanu-meric characters, with no spaces or spe-cial characters, including ' " ` ~ ! @ # $ ^& ( ) + [ ] {} * ; : ' " . , | < > ? / \ = % .

--password password

Plain-text description of the CHAP user.If there are spaces in the description,enclose the text in quotation marks.

[--description text]

OperatorDelete the specified CHAP user. It deletesthe CHAP user connection from the iSCSIinitiator. If the CHAP user is assigned toany access control records, you must usethe --force to delete.

user_name--delete

Forcibly delete the specified CHAP usereven if that user has active connections.It disregards any ACL records that havebeen applied.

[--force]



OperatorModify the name of the CHAP user.Changing the CHAP user name requiresreconfiguring the iSCSI initiators to usethe new CHAP user name.

user_name [--name new_name]--edit

Modify the description of the CHAP user.If there are spaces in the description,enclose the text in quotation marks.

user_name [--description text]

Modify the CHAP secret (shared pass-word) used by the a CHAP user. Thisvalue must be between 12 and 16 al-phanumeric characters, with no spacesor special characters, including ' " ` ~ ! @# $ ^ & ( ) + [ ] {} * ; : ' " . , | < > ? / \ = %

user_name [--password password]

OperatorUse --add_initiators to associate thespecified CHAP user to specific iSCSIinitiators. iSCSI Group Target uses thisinformation to authenticate CHAP accessto iSCSI initiators.

user_name--add_initiators

Associate this CHAP user to the specifiediSCSI initiators. If any specified initiatoris already associated with another CHAPuser, that user will be replaced by thisCHAP user for future CHAP authentica-tion.

[--initiator_nameiqn]

Use --remove_initiator to disassociatethe CHAP user from a specific iSCSI ini-tiator. iSCSI Group Target will not doCHAP authentication to this iSCSI initia-tor.

user_name--remove_initiator

Disassociate the CHAP user from thespecified iSCSI initiator. iSCSI GroupTarget will not do CHAP authenticationto this iSCSI initiator.

[--initiator_nameiqn]

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: nimblechapuser


Created: 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 the change.

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 A and B controller(case-sensitive identifiers). One controller is always active and the other always takes the standby role. Controllers share IPaddresses except for the support IP address. Each controller is also configured with the same set of NICs to provide redundancyin case of a failure. This configuration ensures that there is never a conflict during a failover. The IP addresses that are assignedto each NIC and interface remain the same. If a failover is triggered, then the new active controller has the same number oflinks to the switch 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 the con-trollers in the array where you are loggedin.

--list

List basic information about all con-trollers on the specified array.

[--array array_name]



GuestList detailed information about thespecified controller. Valid controllernames are A and B, which are case sensi-tive.

controller_name--info

List detailed information about thespecified controller on the specified ar-ray.


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

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 a valid NTP serverIP address, then the time settings on the array synchronize with the time settings on the NTP server. In this case, do notmodify the date locally. However, if the array is connected to an invalid NTP server IP address, then the time settings on thearray do not synchronize with the time settings on the NTP server.


Synopsis

date --help

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

Options



N/A--help

GuestList the Coordinated Universal Time onan array.

N/A--utc

Power UserUse --edit with care. Modify the date andtime on an array and disable the connec-tion between the array and a previouslyspecified NTP server. If specified with--utc, modify Coordinated Universal Timeto the supplied argument.

{hh:mm[:ss]|'YYYY-MM-DD hh: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

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

When you remove a hard disk drive (HDD) from an array, it is either removed from the existing RAID or replaced as a spare,depending on the state of the RAID. If you remove a solid state disk (SSD), it is removed from 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 the disks onan array, showing the type, slot, serialnumber, size, disk state, RAID status,shelf serial number, and shelf location foreach.

--list

List basic information about the disks onthe specified array. Specify this option ina multi-array configuration. It is optionalin a single-array configuration.


List basic information about the disks onthe specified shelf. If this option is notspecified, then all disks on all shelves arelisted.


GuestList detailed information about the diskat a specified slot number in a single-ar-ray configuration.

slot--info

List detailed information about all disksfor a specified array in a multi- arrayconfiguration. Include this option in amulti-array configuration. It is optionalin a single-array configuration.


List detailed information about the diskat the specified shelf location. If this op-tion is not specified, then only disks forthe head shelf A (A.0) or B (B.0) are list-ed.




Power UserAdd a disk at the specified slot on a sin-gle-array configuration.

slot--add

Add a disk at the specified slot on amulti-array configuration. Include thisoption in a multi-array configuration. Itis optional in a single-array configuration.


Add a disk at the specified shelf locationon a specified array. This option ismandatory.

--shelf_location shelf_location

Forcibly add the specified disk. This op-tion is mandatory if the disk to add is ina foreign state.

[--force]

Power UserRemove a disk from the specified slot ina single-array configuration.

slot--remove

Remove a disk from the specified slot ona specified array in a multi-array config-uration. Include this option in a multi-ar-ray configuration. It is optional in a sin-gle-array configuration.


Remove a disk from the specified slot onthe specified shelf location. This optionis 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.1


5 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 output is truncated toavoid 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 in this example, onlythe disks that are located in slot 1 at the specified shelf location are listed. The output is truncated 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-array configuration.The disk resynchronizes with the rest of the array. The --shelf_location option is mandatory in this example.

Nimble OS $ disk --add 13 --shelf_location A.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.0


12 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 a single-arrayconfiguration. The --shelf_location option is mandatory in this example.

Nimble OS $ disk --remove 13 --shelf_location A.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.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

encryptkey

The 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 volume data. Thiscommand provides options to create, enable, disable, delete, and purge the master key, and to change the passphrase that isused to protect the master key.

Data encryption keys for volumes are encrypted by using a master key that must be initialized before encrypted volumes canbe created. The master key in turn is protected by a passphrase that is set when the master key is created. The passphrasemay have to be entered to enable the master key when it is not available, for example, after an array reboot.


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

Note: No characters appear on the screen as you enter the passphrase for any of the encryptkey command options,not even asterisks to indicate an obfuscated value.

Synopsis

encryptkey --help

encryptkey --info

encryptkey --create_master

encryptkey --enable_master

encryptkey --disable_master

encryptkey --delete_master

encryptkey --change_passphrase

encryptkey --purge_inactive

Options



N/A--help

OperatorDisplay the status of the master key. Ini-tialized is true only if the master key hasbeen created. Active is true only if themaster key has been unlocked using thepassphrase and is available for use.

N/A--info

Administra-tor

Create the passphrase-encrypted masterkey. You must interactively specify andconfirm the passphrase. The passphrasevalue can be any printable characters,and its length must be between 8 and64 characters, inclusive.

The group encryption_scope is set togroup and the group encryption_cipheris set to aes-256-xts.

N/A--create_master

OperatorActivate the master key. You must inter-actively specify the correct passphrase.

N/A--enable_master



Administra-tor

Deactivate the master key and disableencryption. You mus interactively specifythe correct passphrase.

Note: You can still take snap-shots of encrypted volumes af-ter disabling the master key.

N/A--disable_master

Administra-tor

Delete the master key. All encryptedvolumes must first be deleted. This al-lows the recovery of a group when thepassphrase has been lost. The encryptionscope and cipher are both reset to none.

N/A--delete_master

Administra-tor

Decrypt the master key and verify usingthe old passphrase, and re-encrypt usinga new passphrase.

N/A--change_passphrase

Administra-tor

Purge encryption keys that have beeninactive for the specified number ofhours or longer. If you do not specify anage in hours, inactive keys will be purgedimmediately. The age_in_hours is theminimum number of hours keys may beinactive before they are purged.

To purge inactive keys immediately, en-ter 0.

--age age_in_hours--purge_inactive

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 (initialized and 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 --infooutput.

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

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

This example re-enables 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 until you enable themaster key. If you have volumes that are not encrypted, then those volumes are still accessible. The --disable_master capabilityis 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 this operation 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 successful completion. If youtype an incorrect value for the current passphrase, or if you type and confirm values that do not match for the new passphrase,then an error identifies the issue.

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

This example configures the number of hours after which to purge inactive keys to two hours.

Nimble OS $ encryptkey --purge_inactive --age 2

failoverThe failover command options perform a controller failover on an array. The active controller restarts and assigns the activerole to the standby controller.

Synopsis

failover --help

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

Options



N/A--help



Power UserPerform a controller failover on thespecified array, which must be runningin redundant controller mode (ac-tive/standby). You must specify the--array array_name option in a multi-ar-ray configuration. Specifying this optionis not required in a single-array configu-ration.

array_name--array

Forcibly fail over the controllers on anarray even if the validation checks thatthe system runs before initiating thefailover fail.

N/A[--force]

Override the default behavior of havingto type "yes" to complete the command.Use this suboption with care to avoidunexpectedly taking 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.

fc

The fc command is used to manage Fibre Channel interfaces.

Synopsis

fc --help

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

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

fc --ping interface_name[--wwpn wwpn][--fcid fcid][--count count]


fc --edit interface_name[--array {name|serial}][--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 Channel inter-faces for arrays in the group.

--list

List all discovered Fibre Channel inter-faces for the specified array.

[--array {name|serial}]

GuestShow detailed information about thespecified Fibre Channel interface.

interface_name--info

Show detailed information about a FibreChannel interface on a specified array.Provide the array name or serial number.

[--array {name|serial}]

Show detailed information about a FibreChannel interface on a specified con-troller. Valid controller names are A andB, which are case sensitive.

[--ctrlr {A|B}]

Send ECHO ELS frame to specifiedWorldwide Port Number (WWPN) or portFC-ID from Fibre Channel interface onlocal controller.

interface_name--ping

Power UserSpecify the remote WWPN.[--wwpn wwpn]

Specify the remote port FC-ID in sixhexadecimal digits format.

[--fcid fcid]

Repeat ping for the specified number oftimes.

[--count count]



Power UserModify attributes of the specified FibreChannel interface.

interface_name--edit

Modify a Fibre Channel interface on thespecified array.

[--array {name|serial} ]

Modify a Fibre Channel interface on thespecified controller. Valid controllernames are A and B, which are case sensi-tive.

[--ctrlr {A|B}]

Set the desired administrative state forFibre Channel interface. Valid states areonline and offline. Setting a Fibre Chan-nel interface offline with connected initia-tors will fail, unless the command --forceoption is used.

[--admin_state {online|offline}]

Forcibly modify the administrative stateof the specified Fiber Channel interface.This option is required when setting aFibre Channel interface to the offlinestate with connected initiators.

[--force]

Power UserUse the fc --update_config commandonly if instructed to do so by NimbleStorage Support. Update the FibreChannel configuration after a hardwareupgrade or downgrade.

N/A--update_config

Power UserRegenerate the World Wide Node Name(WWNN) and all World Wide Port Names(WWPNs) of Fibre Channel interfaces inthe group to set the non-fixed bits of theWWNN to the specified wwnn_base. Thevalue is six hexadecimal digits between00:00:01 and FF:FF:FF, inclusive.

For example, if 12:34:56 is specified, theWWNN will be set to56:c9:ce:90:12:34:56:00 and the firstWWPN will be 56:c9:ce:90:12:34:56:01.The WWPNs will be numbered in orderfrom lowest interface to highest interface(e.g., fc1.1, fc2.1, fc5.1, etc.), starting firstwith controller A then controller B.

All Fibre Channel interfaces must be bothadministratively and operationally offlinebefore proceeding. After the regeneratecompletes, all interfaces will be broughtback online.

wwnn_base--regenerate_wwn

Do not prompt for confirmation.[--non_interactive]


Examples

This example lists the Fibre Channel Interfaces on a CS300 array named greyhound. The output is truncated to avoid linewraps.

Nimble OS $ fc --list --array greyhoundArray: 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: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

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

Nimble OS $ fc --info fc5.1 --ctrlr AName: fc5.1Array: rtp-array33Controller: AAdmin Status: onlineLink Status: upOperational Status: operationalFabric Logged In: yesLink Speed: 8GMax Link Speed: 16GWWNN: 56:c9:ce:90:ac:d1:04:00WWPN: 56:c9:ce:90:ac:d1:04:01FC-ID: 0xe007d0PCI bus ID: 0000:84:00.0HBA port: 0HBA slot: 2Firmware version: 11.2.156.27Fabric switch name: rtp-b10-nex-1Fabric switch port: fc2/9Fabric switch WWNN: 20:64:8c:60:4f:bb:cb:01Fabric switch WWPN: 20:49:8c:60:4f:bb:cb:00Fabric WWN: 20:64:00:de:fb:2c:50:c1SFP Rx Power: 577 uWSFP Tx Power: 606 uW

Connected 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 HPE Nimble Storage Support after performing ahardware upgrade or downgrade (adding or removing Fibre Channel HBAs) on both controllers of an array.

Nimble OS $ fc --update_config

This example allows Fibre Channel zoning to be configured before the HPE Nimble Storage array you purchased arrives onsite. 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 the wwnn_base value after

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

Installation Guide that applies to your array model. 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 an HPE Nimble Storage array named greyhound, where the interfacesare 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 --array greyhound......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:03


fc6.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 from 56:c9:ce:90:ad:d6:3a:00to 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 fromthe lowest interface to the highest interface, starting first with controller A and then controller B, as shown in the final fc --listoutput in the previous command examples. The command with the --regenerate_wwn option brings the Fibre Channel interfacesback online automatically.

folder

The folder command options allow you to manage folders. Folders are a way to group volumes, and can be used to provisionstorage for third party plugins such as VVOLs and SMI-S. In the case of VVOLs, folders appear as Storage Containers. In thecase of SMI-S, folders appear as Storage Pools.

All folder commands that accept a volume name as an argument will accept an optional --pool argument to differentiate thosefolders that have the same name but reside in different pools.

Synopsis

folder --help

folder --list[--pool pool_name][--access_protocol {iscsi|fc}]

folder --create folder_name[--pool pool_name][--description text][--usage_limit mebibytes][--provisioned_limit mebibytes][--overdraft_limit_pct percent][--iops_limit iops][--mbps_limit mbps][--agent_type {none|smis|vvol|openstack}][--appserver vcenter_name][--perfpolicy perfpolicy][--access_protocol {iscsi|fc}]

folder --edit folder_name[--pool pool_name][--name new_name][--pool pool_name][--description text][--usage_limit mebibytes][--provisioned_limit mebibytes][--overdraft_limit_pct percent][--iops_limit iops][--mbps_limit mbps][--agent_type {none|smis|vvol|openstack}][--appserver vcenter_name][--force][--perfpolicy perfpolicy]

folder --delete folder_name


[--pool pool_name][--force]

folder --info folder_name[--pool pool_name]

Options



N/A--help

OperatorList folders in a group.N/A--list

Limit the list of folders to the specifiedpool.

[--pool pool_name]

Limit the list of folders to the specifiedaccess protocol. This option only applieswhen folders have an agent type of"vvol".

[--access_protocol {iscsi|fc]



OperatorCreate a folder.folder_name--create

Name of the pool to contain the folder.If the pool option is not specified, thefolder will be created in the default pool.

[--pool pool_name]

Description of folder.[--description text]

Limit for the folder in mebibytes. To setthe folder size to unlimited (size limitedby parent pool), use "unlimited". Default:unlimited folder size is equal to the poolcapacity.

[--usage_limit mebibytes]

Provisioned limit for the folder inmebibytes. To set the folder provisionedlimit to unlimited, use "unlimited".

[--provisioned_limit mebibytes]

Overdraft percentage by which the foldercan exceed the usage limit. The defaultis 0 percent. Overdraft percent limit re-quires that the --usage_limit be specified.

[--overdraft_limit_pct percent]

External management agent type.Choices are "none", "smis", "vvol", or"openstack". Default: "none".

[agent_type {none|smis|vvol|openstack}]

Name of the vCenter associated with thisfolder. This option only applies to folderswith an agent_type of "vvol".

[--appserver vcenter_name]

Default performance policy for volumescreated in this folder. The default perfor-mance policy is "default". This optiononly applies to folders with agent_type"smis".

[--perfpolicy perfpolicy]

Access protocol for the folder. If this op-tion is not specified, the access protocolsupported by the group is used. If thegroup supports multiple protocols, thedefault will be Fibre Channel.

[--access_protocol {iscsi|fc}]

The IOPS limit for the folder. To set theIOPS limit to unlimited, use "unlimited".

[--iops_limit iops]

Throughput limit for the folder in MiBs.To set the throughput limit to unlimited,use "unlimited".

[--mbps_limit mbps]



OperatorModify attributes of the specified folder.folder_name--edit

Name of the pool that contains the fold-er. If the pool option is not specified, thedefault pool will be used.

[--pool pool_nam]

Modify the name of the specified folder.This will correspondingly change thename of the Storage Container or theStorage Pool, if applicable.

[--name new_name]

Modify the description of the specifiedfolder.


Modify the usage limit of the specifiedfolder. To set the folder size to unlimited(size limited by parent pool), use "unlim-ited".


Change the vCenter associated with thisfolder. This option only applies to folderswith an agent_type "vvol" with no vCen-ter association.

[--appserver vcenter_name]

Modify the usage limit of the specifiedfolder. To set the folder usage limit tounlimited (size limited by parent pool),use "unlimited".


Modify the provisioned limit of the spec-ified folder. To set the provisioned limitto unlimited (size limited by parent pool),use "unlimited".

[--provisioned_limit mebibytes]

Modify the overdraft limit percentage forthe specified folder. The overdraft limitis a percentage of the folder usage limit.

[--overdraft_limit_pct percent]

Forcibly associate the folder with thespecified application server. This optionis required when the folder already asso-ciates with an application server.

[--force ]

Modify the performance policy assignedby default to volumes created in thisfolder by the "create volume" API.

[--perfpolicy perfpolicy]

Modify the IOPS limit for the folder. Toset the IOPS limit to unlimited, use "un-limited".

[--iops_limit iops]

Modify the throughput limit for thespecified folder. To set the throughputlimit to unlimited, use "unlimited".

[--mbps_limit mbps]



OperatorDelete the specified folder. No volumesshould be present under this folder.

folder_name--delete

Name of the pool that contains the fold-er. If the pool option is not specified, thedefault pool is used.

[--pool pool_name]

Forcibly delete a folder managed byvCenter.

[--force ]

OperatorList detailed information about thespecified folder.

folder_name--info

Name of the pool that contains the fold-er. If the pool option is not specified, thedefault pool is used.

[--pool pool_name]

Examples

This example lists the folders.

Nimble OS $ folder --list----------------------+------------------------+---------+----------------------Path Description Agent Type Usage Limit(MiB)----------------------+------------------------+---------+----------------------default:/Folder-1 Test none Unlimited (3530971)default:/Folder-Mal smis 12

This example lists detailed information about the folder named Folder-Mal

Nimble OS $ folder --info Folder-MalPath/URI: default:/Folder-MalDescription:Agent Type: smisApplication UUID: 00000002000040028ecb759c52142abbVolume mapped usage (MiB): 0Uncompressed snapshot usage including pending deletes (MiB): 0Total volume and snapshot usage (MiB): 0Overdraft Limit (%): 10Usage Limit (MiB): 12Provisioned Size (MiB): 2048Provisioned Limit (MiB): UnlimitedVolume count: 1Volumes in the folder: Vol-mal3Snapshot count: deprecatedSnapshot collection count: deprecatedVolume compression: 1.00XUnused reserve (MiB): 0Snapshot compression: 1.00XPerformance policy: defaultApplication server: N/AIOPS Limit: 456Throughput Limit (MiB/s): 234

group

The group command options manage groups.


Synopsis

group --help

group --list

group --info

group --status

group --edit[--name new_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 user_name][--smtp_encrypt_type {none|starttls|ssl}][--smtp_from_addr email_addr][--smtp_to_addr email_addr][--send_event_data {yes|no}][--alert_level {info|notice|warning|critical}][--proxyserver server][--proxyport port][--proxyuser user_name][--proxypasswd password][--default_vol_limit percent][--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}][--encryption_mode {available|secure}][--inactivity_timeout inactivity timeout][--iscsi_target_name iscsi_target_name][--login_banner][--login_banner_after_auth {yes|no}][--force][--tlsvl_enabled {yes|no}][--cc_enabled {yes|no}][--alarms_enabled {yes|no}]


[--vss_validation_timeout vss_validation_timeout][--snap_ttl {ttl|unlimited}][--snap_ttl_unit {hours|days|weeks}][--iscsi_enabled {yes|no}][--fc_enabled {yes|no}][--tdz_enabled {yes|no}][--tdz_prefix tdz_prefix[--analytics_gui {yes|no}][--default_iscsi_target_scope {volume|group}]

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

group --delete_throttle id

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

group --autosupport_validate

group --autosupport_initiate

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

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

group --unset_http_proxy

group --list_limits

group --reset_login_banner

group --autoclean_unmanaged_snapshots {yes|no}[--snap_ttl {ttl|unlimited}][--snap_ttl_unit {hours|days|weeks}]

group --show_login_banner

group --check_migrate


group --migrate

group --check_takeover

group --takeover

Options


GuestShow usage in-formation forthe command.

N/A--help

GuestList groups thatshare the samesubnet with thecurrent group.

N/A--list

GuestProvide detailedinformationabout the cur-rent group.

N/A--info

GuestDisplay status ofthe group.

N/A--status



Power UserModify the nameof a group. Youmust includethis option in amulti-array con-figuration. If youinclude this op-tion in a single-array configura-tion, you modifythe group nameto the specifiedname value.

[--name name]--edit

Modify the IPaddress of theDNS serverused. Repeatthis option tospecify morethan one DNSserver IP ad-dress.

[--dnsserver server]

Modify the host-name or IP ad-dress for theNTP server thatis used by agroup.

[--ntpserver server]

Modify the DNSdomain namethat is used by agroup.

[--domainname domain_name]

Enable or dis-able automatical-ly sending Auto-Support data tothe Nimble Stor-age Supportteam.

[--autosupport {yes|no}]

Enable or dis-able NimbleStorage Supportto establish a se-cure connectionto the group togather diagnos-tic data.

[--support_tunnel {yes|no}]

[smtp_server smtp_server]



Modify the host-name or IP ad-dress of anSMTP serverthat the groupuses to sendemail alerts andevent data tospecified recipi-ents.

Modify theSMTP port num-ber to use. De-fault: 25. Youmust also in-clude the--smtp_serveroption when youmodify the portnumber.

[--smtp_port smtp_port]

Enable or dis-able SMTP au-thentication. De-fault: no (dis-abled). If you en-able SMPT en-cryption, thenyou must alsoenable SMTPauthentication.

[--smtp_auth {yes|no}]

[--smtp_username user_name]



Modify theSMTP authenti-cation usernameand password.The user_namevalue must startwith an alphabet-ic character andcan be up to 64alphanumericcharacters.When prompted,interactivelyspecify a pass-word for theSMTP account.The passwordvalue can beblank or it canbe up to 255printable charac-ters. You can re-peat the priorpassword value.

Modify the levelof encryption forSMTP. Default:none. Requiresusing SMTP au-thenticationwhen encryptionis enabled byspecifying a val-ue of starttls(start transportlayer security)or ssl (securesockets layer).The starttls typecan be an appro-priate choice ifyou implement-ed cloud-basedemail. The ssltype can be anappropriatechoice if youhave a secureSMTP server in-stalled on yournetwork.

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

[--smtp_from_addr email_addr]



Modify the emailaddress fromwhich the groupsends alerts andevent data. Itdoes not have tobe a valid emailaddress, but itmust have avalid email ad-dress format. In-clude the groupname for easyidentificationand filtering.

Modify one ormore email ad-dresses for alertand event recipi-ents. Repeat thisoption to specifyas many TOemail addressesas needed.

[--smtp_to_addr email_addr]

Enable or dis-able sendingevent data tothe Nimble Stor-age Supportteam. Default:yes (enabled).When enabled,you do not needto provide con-tact details forNimble StorageSupport.

[--send_event_data {yes|no}]

Specify the mini-mum level atwhich to sendalert email notifi-cations.

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

[--proxyserver server]



Modify the host-name or IP ad-dress of theHTTP proxyserver. If noproxy server isspecified, a di-rect HTTP con-nection is as-sumed. The ar-ray uses theHTTP protocolto downloadsoftware up-dates and postevent data.

Modify the portnumber that theHTTP server us-es.

[--proxyport port]

Modify the user-name of theHTTP proxyserver.

[--proxyuser user_name]

Modify the pass-word that theHTTP proxyserver uses.

[--proxypasswd password]

Modify the per-centage that isused as the de-fault value forspace limit whenyou create a vol-ume for a group.

[--default_vol_limit percent]

Enable or dis-able the InternetStorage NameService (iSNS)managementservices for thegroup. The iSNSsettings do notapply to FibreChannel arrays.

[--isns_enable {yes|no}]

Specify the iSNSserver that isused to publishiSCSI endpoints.

[--isns_server isns_server]

[--isns_port isns_port]



Modify the iSNSserver port num-ber.

Enable or dis-able SNMPtraps.

[--snmp_trap_enabled {yes|no}]

Modify the host-name of the SN-MP trap destina-tion. Only oneSNMP trap iscurrently avail-able.

[--snmp_trap_host snmp_trap_hostname]

Modify the portnumber of theSNMP trap desti-nation. The de-fault destinationport is 162.

[--snmp_trap_port snmp_trap_port]

Enable or dis-able SNMP Gets.

[--snmp_get_enabled {yes|no}]

Modify the nameof the SNMPcommunity. Thedefault communi-ty is public. Youcan use alphanu-meric charactersand the - (hy-phen), : (colon),and . (period)special charac-ters. The namemust start withan alphanumericcharacter andcan be up to 64characters.

[--snmp_community snmp_community]

Modify the SN-MP responderport number.The default getport number is161.

[--snmp_get_port snmp_get_port]

[--snmp_sys_location snmp_sys_location]



Modify the SN-MP system loca-tion that is usedto respond toSNMPv2-MIB::sysLoca-tion.

Modify the SN-MP system con-tact that is usedto respond toSNMPv2-MIB::sysContact.

[--snmp_sys_contact snmp_sys_contact]

Enable or dis-able sendingsyslog messagesfrom the Nimblegroup to a re-mote syslogserver. Default:no (syslog is dis-abled).

[--syslog_enabled {yes|no}]

Modify the nameof the server towhich syslogmessages will beforwarded.

[--syslog_server syslog_server]

Modify the re-mote syslogserver port num-ber. Default:514. Valid val-ues: 1 through65535, inclusive.

[--syslog_port syslog_port]

Specify the de-fault cipher touse during en-cryption. A valueof "none" indi-cates no encryp-tion. A value of"aes-256-xts" in-dicates the useof the AES-256-XTS cipher.

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

--encryption_scope {group|volume}]



Specify whetherthe default en-cryption_ciphersetting can beoverridden whencreating a newvolume, or isforced to beused. A value of"group" indicatesthat the value isapplied acrossthe entire groupand cannot bechanged. A val-ue of "volume"means that thesetting can beoverridden atvolume creationtime.

Specify whetherthe master keypassphrasemust be enteredon array startup("secure" mode)to access en-crypted vol-umes, orwhether the ar-ray remembersthe master keyacross a restart("available"mode).

[--encryption_mode {available|secure}]

Change theglobal user inac-tivity timeout (inminutes) thatmust pass with-out any user ac-tivity before atimeout occursand users arelogged out.

[--inactivity_timeout inactivity timeout]

[--iscsi_target_name iscsi_target_name]



Changes thegroup-wide iSC-SI target name.All Virtual Vol-umes and Open-stackV2 vol-umes are re-quired to be of-fline. This is adisruptive opera-tion.

Enable/Disablealarms.

[--alarms_enabled {yes|no}]

Changes the val-idation timeoutfor MicrosoftVSS applicationsynchronization(in minutes).

[--vss_validation_timeout {vss_validation_timeout}]

Time-to-live ofan unmanagedsnapshot fromthe time it is cre-ated. This op-tions should beused with the--snap_ttl_unitoption. The val-ue that can beconfiguredshould be in theappropriaterange, for exam-ple, 1 hour, 104weeks.

[--snap_ttl {ttl|unlimited}]

Unit of timeused for thesnapshot time tolive option. Thiscan be one ofhours, days, orweeks.

[-snap_ttl_unit {hours|days|weeks}]

[--iscsi_enabled {yes|no}]



Enable the iSCSIprotocol for thegroup. Valid val-ues are yes andno. This optioncannot be usedtogether withthe --fc_enabledoption. Thechange maycause some sys-tem processesto restart, whichwill impact I/O.

Enable the FCprotocol for thegroup. Valid val-ues are yes andno. This optioncannot be usedtogether withthe --iscsi_en-abled option.The change maycause some sys-tem processesto restart, whichwill impact I/O.

[--fc_enabled {yes|no}]

Enable or dis-able TargetDriven Zoning.

--tdz_enabled{yes|no}

Target DrivenZoning (TDZ)prefix for peerzones createdby TDZ.

--tdz_prefixtdz_prefix

Enable or dis-able usage ana-lytic on the ar-ray.

[--gui_analytics {yes|no}]

[--default_iscsi_target_scope {volume|group}]



Export newlycreated volumesunder iSCSIGroup Target oriSCSI VolumeTarget. Thevalid options arevolume andgroup. This set-ting is used onlywhen creating anew volumewithout specify-ing the iSCSI de-fault targetscope for thevolume.

AdministratorLogin bannermessage that isdisplayed duringthe user loginprocess.

[--login_banner]

Display loginbanner messagebefore or afteruser authentica-tion.

[--login_banner_after_auth {yes|no}]

The --force op-tion confirmsthat no loginbanner exists.This option ismandatory toset an empty lo-gin banner.

[--force]

Enable or dis-able TSLv1.0and TLSv1.1 inall SSL services.The change maycause some sys-tem processesto restart, butI/O will not beimpacted.

[--tlsvl_enabled {yes|no}]

[--cc_mode_enabled {yes|no}]



Enable or dis-able CommonCriteria mode tocontrol variousconfigurationvalues. Thechange maycase some sys-tem processesto restart, butI/O will not beimpacted.



Power UserCreate a group-wide bandwidththrottle for repli-cation. Throttlesat the group lev-el limit the totalreplicationbandwidthacross all down-stream partners.The system auto-matically assignsan ID to thethrottle sched-ule.

Specify at least one suboption.--create_throttle

Describe thebandwidththrottle. If thedescription in-cludes spaces,enclose the de-scription text inquotation marks.


Specify the daysof the week forwhich the band-width throttle iseffective. Sepa-rate the valueswith commas.For example:

Mon,Tue,Thu

Specify the val-ue all to indicateall days of theweek (the de-fault).

[--days {all |days}]

Specify the timeof day when thebandwidththrottle is acti-vated.

[--at time]

Specify the timeof day when thebandwidththrottle is deacti-vated.

[--until time]

[--bandwidth limit]



Specify the max-imum bandwidthto use for replica-tion, expressedin megabits persecond (Mbps)or kilobits persecond (Kbps).The default ismegabits persecond. Exam-ples of valid ar-guments are20Mbps or400Kbps. Use 0(zero) to com-pletely throttlereplication traf-fic. Use "unlimit-ed" to turn offthrottling.

Power UserDelete the speci-fied bandwidththrottle for repli-cation. The ID isassigned by thesystem. Usegroup--info toview all throttleswith their IDs.

id--delete_throttle



Power UserModify the spec-ified bandwidththrottle for repli-cation. Usegroup --info todetermine thethrottle ID.Specify at leastone suboption.

id--edit_throttle

Modify the de-scription of thebandwidththrottle. If thedescription in-cludes spaces,enclose the de-scription text inquotation marks.


Modify the daysof the week forwhich the band-width throttle iseffective. Sepa-rate the valueswith commas.For example:

Mon,Tue,Thu

Specify the val-ue all to indicateall days of theweek (the de-fault).

[--days {all |days}]

Modify the timeof day when thebandwidththrottle is acti-vated.

[--at time]

Modify the timeof day when thebandwidththrottle is deacti-vated.

[--until time]

[--bandwidth limit]



Modify the maxi-mum bandwidthto use for replica-tion, expressedin megabits(Mbps) or kilo-bits per second(Kbps). The de-fault is megabitsper second. Ex-amples of validarguments are20Mbps or400Kbps. Use 0(zero) to com-pletely throttlereplication traf-fic. Use "unlimit-ed" to turn offthrottling.

Power UserValidate the Au-toSupport con-figuration for agroup.

N/A--autosupport_validate

Power UserImmediatelysend event infor-mation from thegroup to theNimble StorageSupport team.You can use thisoption in addi-tion to configur-ing periodic Au-toSupport mes-sages by usingthe --edit --auto-support yes op-tion.

N/A--autosupport_initiate



AdministratorValidate theconfiguration ofthe specifiedgroup to mergeit with the cur-rent group. Thisoperationchecks groupobjects for con-flicts. If conflictsoccur, then theinformation islisted so thatyou can resolvethe conflicts be-fore merging thegroups.

group_name--merge_validate

Specify the ad-ministrativeusername associ-ated with thegroup to vali-date beforemerging withthis group. Thedefault value isadmin.

[--username user_name]

Specify the ad-ministrativepassword associ-ated with thegroup to vali-date beforemerging withthis group.

--password password

If encryption isenabled on thegroup that is thesource of themerge being val-idated, specifythe encryptionpassphrase forthe sourcegroup.

[--passphrase]

Use this optionto skip the checkwhether the sec-ondary manage-ment IP is miss-ing.

[--skip_secondary_mgmt_ip_validation]



AdministratorMerge the speci-fied group intothe currentgroup. Usegroup--merge_vali-date to check forconflicts beforemerging twogroups. Afterthe groups aremerged, all ar-rays from themerged groupare placed in anew pool in thecurrent group.Administrationof the arraysand volumes onthem must beperformed inthis group afterthe merge iscomplete.

group_name--merge

Specify the ad-ministrativeusername associ-ated with thegroup to mergewith this group.The default val-ue is admin.

[--username user_name]

Specify thegroup adminis-trative pass-word.

--password password

If encryption isenabled on thegroup that is thesource of themerge, specifythe encryptionpassphrase forthe sourcegroup.

[--passphrase]

Allow group tohave lower limitsafter the mergeoperation iscomplete.

[--allow_lower_limits]



Skip the valida-tion for the sec-ondary manage-ment IP address.

--skip_secondary_mgmt_ip_validation

Power UserClear the HTTPproxy serversettings fromthe currentgroup. Thegroup will nolonger use anHTTP proxy toconnect to theNimble StorageSupport team.

N/A--unset_http_proxy

GuestList the currentcount, maximumlimit, and warn-ing threshold forseveral groupcriteria, as wellas scope, whereapplicable.

N/A--list_limits

AdministratorResets the loginbanner to thefactory defaultmessage.

N/A--reset_login_banner



AdministratorEnabled or dis-able the auto-matic cleaningof unmanagedsnapshots.

{yes|no}--autoclean_unmanaged_snapshots

Time-to-live ofan unmanagedsnapshot fromthe time it is cre-ated. This op-tions should beused with the--snap_ttl_unitoption. The val-ue that can beconfiguredshould be in theappropriaterange, for exam-ple, 1 hour, 104weeks.

[--snap_ttl {ttl|unlimited}]

Unit of timeused for thesnapshot time tolive option. Thiscan be one ofhours, days, orweeks.

[--snap_ttl_limit {hours|days|weeks}]

AdministratorDisplays the lo-gin banner mes-sage.

N/A--show_login_banner

Power UserDeterminewhether it is OKto migrate thegroup leader ar-ray to the back-up group leaderarray. This com-mand must berun from the ar-ray currentlyhosting thegroup Manage-ment Service(the group lead-er).

N/A--check_migrate



Power UserMigrate datafrom the groupleader array tothe backupgroup leader ar-ray. This com-mand must berun from the ar-ray currentlyhosting thegroup Manage-ment Service(the group lead-er). When thiscommand com-pletes, the back-up group leaderarray will be thegroup leader ar-ray and will per-form the man-agement func-tions for thegroup.

N/A--migrate

Power UserDeterminewhether it is OKto execute atakeover of thegroup leader ar-ray and promotethe backupgroup leader ar-ray to groupleader array.This commandmust be execut-ed on the back-up group leader.You must belogged on to thebackup groupleader array us-ing at least apower user role.

N/A--check_takeover



Power UserTakeover therole of groupleader by thebackup groupleader. Thiscommand mustbe run from theGroup Manage-ment Servicebackup array(the backupgroup leader).You must belogged on to thebackup groupleader array us-ing at least apower user role.When this com-mand completes,the backupgroup leader ar-ray will be thegroup leader ar-ray and willmanage thegroup manage-ment servicesfor the group.

N/A--takeover

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 CLI is a member. Theoutput 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): array2


Unreachable 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 is truncated tosave 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 from 6:00 AM until 7:00AM.


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 replication time.

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 message mightsuggest 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 halt an array, it stopsboth controllers and turns off the array. To restart the array or controller, you have to press the Power button on the front ofthe array.

Synopsis

halt --help

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

Options



N/A--help

Power UserHalt the specified array. If you halt anarray, it stops both controllers and turnsoff the array. To restart the array, pressthe Power button on the front of the ar-ray.

array_name--array

Halt the specified controller on thespecified array. Valid controller namesare A or B, which are case sensitive.. Youcan omit the --controller option if thereis a single array in a group, an uninitial-ized array, or if entered on a member ar-ray in a group.

[--controller {A | B|]

Override the default behavior of havingto type "yes" to complete the command.Use this suboption with care to avoidunexpectedly taking the array or con-troller offline.

--non_interactive



Power UserHalt the entire group when you run thiscommand on the group leader. Bothcontrollers of all arrays in a group arethen halted and power is automaticallyturned off. If any array fails to respondto the halt request, then the group leaderarray remains operational. To restart thearrays in the group, press the Powerbutton on the front of each array.

--group

Override the default behavior of havingto type "yes" to complete the command.Use this suboption with care to avoidunexpectedly taking the group or con-troller offline.

--non_interactive

Halt the remaining arrays in a groupwhen one or more arrays cannot bereached. For example, an array can beunreachable if it is already 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 specify the group name.When you issue this command option on the group leader, it runs on the group that you are logged 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.

initiatorgrp

The initiatorgrp command options manage array access by grouping initiators that share a set of common characteristics thatcan be configured as part of your ACL to access specific volumes through group membership.


A given HPE Nimble Storage array supports access through the iSCSI or Fibre Channel (FC) protocol, and beginning withNimbleOS 5.1.x, both iSCSI and FC at the same time.

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

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

• A Fibre Channel (FC) initiator group is a set of initiators that are allowed to access specific volumes, or LUNs. The WorldWide Port Names (WWPNs) for the host bus adapters (HBAs) on a host machine are used to create an initiator group. Ifa 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][--access_protocol {iscsi|fc}[--host_type host_type]

initiatorgrp --delete initiatorgrp_name

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

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

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

initiatorgrp --add_tdz_port initiatorgrp_name[--interface_name interface_name][--array {name|serial}]

initiatorgrp --remove_tdz_port initiatorgrp_name[--interface_name interface_name][--array {name|serial}]

initiatorgrp --add_subnets initiatorgrp_name--label subnet_label

initiatorgrp --remove_subnet initiatorgrp_name


--label subnet_label[--force]

Options



N/A--help

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

OperatorShow detailed information about thespecified initiator group.

initiatorgrp_name--info

OperatorCreate a new iSCSI or Fibre Channel ini-tiator group with the specified name.

initiatorgrp_name--create

Add a description for the new initiatorgroup. If there are spaces in the descrip-tion, enclose the description text in quo-tation marks.


Access protocol of initiator group. If thisoption is not specified, the access proto-col of the supported group is used. If thearray group supports multiple protocols,the access is set to Fibre Channel be de-fault.

[--access_protocol {iscsi|fc}

Set the host type for an initiator group.Available options are autoand hpux. Thedefault is auto. This attribute will be ap-plied to all the initiators in the initiatorgroup.

CAUTION: Initiators with differ-ent host OSes can only be keptin a group with the default (au-to) host type attribute.

[--host_type host_type]

OperatorDelete the specified initiator group. If anyvolumes include this initiator group inaccess control records, run initiatorgrp--remove_initiators to remove the groupfrom those records first.

initiatorgrp_name--delete



OperatorModify attributes of the specified initia-tor group.

initiatorgrp_name--edit

Modify the name of the initiator group.[--name new_name]

Modify the description of the initiatorgroup. If there are spaces in the descrip-tion, enclose the text in quotation marks.


Modify the host type of an initiatorgroup. Available options are auto (thedefault) and hpux. This attribute will beapplied to all the initiators in the initiatorgroup.

CAUTION: Initiators with differ-ent host OSes can only be keptin a group with the default (au-to) host type attribute.

[--host_type host_type]



OperatorAdd one or more members to the speci-fied initiator group.

initiatorgrp_name--add_initiators

An identifier of a minimum of two charac-ters for an iSCSI initiator. The minimumallowed length is two characters. The la-bel describes a set of attributes made upof the initiator name, IP address, andsubnet combination (also called an ac-cess control list, or ACL).

[--label label]

Add an iSCSI initiator with this iSCSIQualified Name (IQN) to the specifiedinitiator group. Repeat this option tospecify more than one initiator name.Each initiator name must have an associ-ated IP address specified usingthe--ipaddr option. You can leave the IPaddress blank for the initiator if you pre-fer not to authenticate using both thename and IP address. The minimum al-lowed length of the IQN is two charac-ters.

[--initiator_name iqn]

Add an iSCSI initiator with this IP addressto the specified initiator group. Repeatthis option to specify more than one ini-tiator IP address, or specify "*" to matchall IP addresses. Each initiator IP addressmust have an associated name specifiedusing the --initiator_name option. Leavethe name blank if you prefer not to au-thenticate using both name and IP ad-dress.

[--ipaddr ipaddr]

Add a Fibre Channel initiator with thisalias of up to 32 characters to the speci-fied initiator group. Repeat this optionto specify more than one initiator alias.Each initiator alias must have an associ-ated World Wide Port Name (WWPN)specified using the --wwpn option. Youcan choose to leave the WWPN for aninitiator blank when using a previouslysaved initiator alias.

[--initiator_alias alias]

[--wwpn wwpn]



Add a Fibre Channel initiator with thisWWPN to the specified initiator group.Repeat this option to specify more thanone initiator WWPN. Each initiator WWPNcan have an associated alias specifiedusing the --initiator_alias option. Leavethe alias blank if you prefer not to assignan initiator alias. Even if the alias is blank,if the specified WWPN and alias pair areused in another initiator group, the sys-tem will apply the alias when searchingfor, and finding, the same mapped valuesused elsewhere. The alias and WWPNhave system-level scope.

Update or remove conflicting FibreChannel initiator aliases and forcibly addsthe Fibre Channel initiator to the speci-fied initiator group.

[--force]

OperatorRemove an initiator from the specifiedinitiator group. Specify an iSCSI or FibreChannel suboption as appropriate for theinitiator group.

initiatorgrp_name--remove_initiator

Remove an iSCSI initiator with thisunique label from the specified initiatorgroup. The label describes a set of at-tributes made up of the initiator name,IP address, and subnet combination (alsocalled an access control list, or ACL).

[--label label]

Remove a Fibre Channel initiator withthis alias from the specified initiatorgroup. If both initiator_alias and wwpnare provided, they must be synchronized.If they are not synchronized, the initiatorwill not be removed from the initiatorgroup.

[--initiator_alias alias]

Remove a Fibre Channel initiator withthis WWPN from the specified initiatorgroup. If both --initiator_alias and --wwpnare provided, they must be synchronized.If they are not synchronized, the initiatorwill not be removed from the initiatorgroup.

[--wwpn wwpn]

Add a Target Driven Zone port to thespecified initiator group.

initiatorgrp_name--add_tdz_ports

OperatorAdd a Target Driven Zone port to thespecified initiator group.

initiatorgrp_name--add_tdz_ports

Name of the Fibre Channel interface tobe added (mandatory).

--interface_nameinterface_name



Fibre Channel interface on the specifiedarray.

--array{name|serial}

Remove a Target Driven Zone port fromthe specified initiator group.

initiatorgrp_name--remove_tdz_ports

Name of the Fibre Channel interface tobe removed from this initiatorgrp(mandatory).

--interface_nameinterface_name

Fibre Channel interface on the specifiedarray.

--array{name|serial}

OperatorAdd target subnets for the specifiediSCSI initiator group to discover and ac-cess volumes.

initiatorgrp_name--add_subnets

Add an iSCSI target subnet with this labelto the specified initiator group. Use sub-net --list to get a list of subnets. Repeatthis option to specify more than onesubnet.

--label subnet_label

OperatorRemove a target subnet from the speci-fied iSCSI initiator group.

initiatorgrp_name--remove_subnets

Remove an iSCSI target subnet with thislabel from the specified initiator group.Use initiatorgrp --list to see which initia-tor groups have associated subnets.Then use initiatorgrp --info initiator-grp_name to get a list of potential sub-nets to remove.

--label subnet_label

Forcibly remove a target subnet from thespecified initiator group.

[--force]

Examples

This example shows a list of current initiator groups on an iSCSI HPE Nimble Storage array. A value of All in the Number ofSubnets 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 2


a12-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 2018 14:56:45Last configuration change: Apr 30 2018 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 2018 17:48:18Last configuration change: Jul 23 2018 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 2018 11:06:47


Last configuration change: Jul 10 2018 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 grouplevel2 and then deletesthe group.


Nimble OS $ initiatorgrp --delete grouplevel2

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


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 2018 11:06:47Last configuration change: Jul 10 2018 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_nameiqn.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. This IP address is usedto access the GUI and CLI on the array. The controller uses this IP address to have an active role. The discovery IP address isalso a floating address. It is assigned to a physical port by the system. SCSI initiators use this IP address to discover targets.This array discovery IP address and the management IP address can share the same IP address or have unique IP addresses.

Each controller on the HPE Nimble Storage array has multiple port pairs that are used as data ports. You can configure theseports as part of the network configuration. Data ports are paired to ensure high availability (HA). The number of port pairsdepends 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|secondary|support}[--nic nic_name][--ctrlr {A|B}]

ip --edit ipaddr[--netconfig netconfig_name][--array array_name][--type {data|discovery|management|secondary|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|secondary|support}][--ctrlr {A|B}][--force_ip_update]


Options



N/A--help

GuestList all configured data, management,and diagnostic (support) IP addresses.

--list

List the data, management, and diagnos-tic (support) IP addresses for the speci-fied network configuration. Use netconfig--list to get the names of network config-urations. Typical names are {active |secondary | draft}.

[--netconfig netconfig_name]

List the data, management, and diagnos-tic (support) IP addresses for the speci-fied array. Use array --list to get thenames of arrays.


GuestShow detailed information about thespecified IP address.

ipaddr--info

Show detailed information about thespecified IP address in the specified net-work configuration. Use netconfig --listto get the names of configurations.


Show detailed information about thespecified IP address on the specified ar-ray. Use array --list to get the names ofarrays.




Power UserAdd an IP address to the network config-uration for an array.

ipaddr--add

Add the specified data, management, orsupport (diagnostic) IP address to thespecified network configuration.


Add the specified data, management, orsupport (diagnostic) IP address to thespecified array. If you specify the nameof the backup group leader, this com-mand adds the IP address for that array.


Specify the type of IP address beingadded. If you specify secondary and thegroup already has a backup group leader,this command will fail.

--type {data|management|secondary|sup-port}

Add a data IP address to the specifiedNIC. Values depend on the hardwareconfiguration, and can include eth1through eth6 for the CS-Series or eth1,eth2, tg1, and tg2 for the CS-Series "G"configuration (for CS200 and CS400models).

[nic nic_name]

Add a support IP address to the specifiedcontroller.

[--ctrlr {A|B}]



Power UserModify the specified IP address on thenetwork configuration for an array.

ipaddr--edit

Modify the specified data, discovery,management, or support (diagnostic) IPaddress for the specified network config-uration.


Modify the specified data, discovery,management, or support (diagnostic) IPaddress for the specified array. If youspecify the name of the backup groupleader, this command allows you to editthe IP address for that array


Modify the type for the specified IP ad-dress. Valid values are data, discovery(although this type has no effect on aFibre Channel array), management, sup-port, or secondary. If you specify sec-ondary and the group already has abackup group leader, this command willfail.

[--type {data|discovery|management|sec-ondary|support}]

Modify a data IP address for this NIC.Values depend on the hardware configu-ration, and can include eth1 through eth6for the CS-Series or eth1, eth2, tg1, andtg2 for the CS-Series "G" configuration(for CS200 and CS400 models).

[--nic nic_name]

Modify a previously configured IP ad-dress.

[--newaddr ipaddr]

Modify a support IP address for thespecified controller.

[--ctrlr {A|B}]

Forcibly modify a data or discovery IPaddress in an active network configura-tion. The command fails unless this op-tion is used.

[--force_ip_update]



Power UserDelete the specified IP address from anetwork configuration on an array.

ipaddr--delete

Delete the specified data, discovery,management, or support (diagnostic) IPaddress from the specified network con-figuration.


Delete the specified data, discovery,management, or support (diagnostic) IPaddress from the specified array. If youspecify the name of the backup groupleader, this command deletes the IP ad-dress for that array.


Delete an IP address configuration. Validvalues are data, discovery, management,secondary, or support.

[--type {data|discovery|management|sec-ondary|support}]

Delete a support IP address from thespecified controller.

[--ctrlr {A|B}]

Forcibly delete a data or discovery IPaddress in an active network configura-tion. The command fails unless this op-tion 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 B182.18.16.142 eth1 up support A182.18.16.206 eth1 up backup 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 the deletion.

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

keymanager

The keymanager command is used to manage external key managers for encryption keys. Encrypted keys can be created andthen stored on a secure server with a third-party key management provider. Managing keys off the array makes it more secure,and less vulnerable to security breaches.

External key managers provide a mechanism to securely store and retrieve sensitive information. Encryption keys from volumesare stored in an internal database. Adding an external key manager allows this information to be stored separately from thearray.

Synopsis

keymanager --help

keymanager --list

keymanager --info keymgr_name

keymanager --edit keymgr_name[--hostname hostname][--port port]


[--protocol {KMIP1_0 | KMIP1_1 | KMIP1_2 | KMIP1_3}][--username user][--password pass]

keymanager --add keymgr_name--hostname hostname --port port--protocol {KMIP1_0 | KMIP1_1 | KMIP1_2 | KMIP1_3}[--username user][--password pass]

keymanager --migrate keymgr_name

keymanager --remove keymgr_name

Table


OperatorDisplay command options and subop-tions.

N/A--help

OperatorList external key managers configuredfor the group.

N/A--list

OperatorDisplay information about a specific ex-ternal keymanager.

keymgr_name--info

Administra-tor

Modify the settings for the specified ex-ternal key manager.

keymgr_name--edit

Modify the host name or IP address ofthe of the external key manager.

[--hostname hostname]

Modify the port number of the externalkey manager.

[--port port]

Modify the KMIP protocol to be used forcommunication with the external keymanager

[--protocol {KMIP1_0 | KMIP1_1 |KMIP1_2 | KMIP1_3}]

Modify the username for authenticationwith the external key manager.

[--username user]

Modify the password for authenticationwith the external key manager

[--password pass]



Administra-tor

Add an external key manager for thegroup.

keymgr_name--add

The host name or IP address of the exter-nal key manager server. This is amandatory argument for adding a key-manager.

--hostname hostname

Port number for the external key manag-er. This is a mandatory argument foradding a keymanager.

--port port

KMIP protocol to be used for communica-tion with the external key manager. Thisis a mandatory argument argument foradding a keymanager.

--protocol {KMIP1_0 | KMIP1_1 |KMIP1_2 | KMIP1_3}

Username for authentication with theexternal key manager

[--username user]

Password for authentication with exter-nal key manager.

[--password pass]

Migrate encryption keys from an activeexternal key manager to an inactive ex-ternal key manager.

--keymanager keymgr_name--migrate

Remove an external key manager keymanager configuration. Encryption keyswill be migrated to the internal keymanager on the array.

--keymanager keymgr_name--remove

migration

The 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 is relatedto unassigning arrays from pools, rebal-ancing array usage in pools, or relocatinga volume family to a different pool.Specify one of the suboptions each timeyou run migration --list.

{--array_unassign|--pool_rebal|--vf_reloc}--list

GuestShow information about data-migrationactivity that is related to the specifiedarray being unassigned from its pool, thespecified pool being rebalanced, or thespecified volume family being relocatedto a different pool. A volume family is acollection of volumes with a single rootvolume. A root volume is a volume thathas no parent. Specify one of the argu-ment/suboption pairs each time you runmigration --info.

{array_name --array_unassign|pool_name--pool_rebal|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.

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

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

netconfig

The 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 {draft|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 about thespecified network configuration.

{active|backup|draft }--info

Power UserCreate a draft network configurationfrom the specified active or backup net-work configuration.

{active|backup}--create_draft_from

Forcibly create a draft network configu-ration if a draft already exists.

[--force]

Power UserValidate the specified network configura-tion.

{active|backup|draft}--validate

Ignore inconsistent network configura-tions for replication partners when vali-dating the specified network configura-tion.

[--force_repl]

Ignore initiators assigned to subnetswhen validating the specified networkconfiguration.

[--force_initiator_groups]

Power UserActivate the specified network configura-tion and makes it the newly active net-work configuration.

{draft|backup}--activate

Ignore inconsistent network configura-tions for replication partners when acti-vating the specified network configura-tion.

[--force_repl]

Allow activating the specified networkconfiguration and updating the discoveryor data IP addresses for the active config-uration.

[--force_ip_update]

Ignore initiators assigned to subnetswhen activating the specified networkconfiguration.




Power UserModify the specified network configura-tion. Specify at least one suboption.

{active|backup|draft}--edit

Redirect connections from a specifiediSCSI target IP to the best data IP that isbased on connection counts. This optionhas no effect on a Fibre Channel array.

[--iscsi_automatic_connection_method{yes|no}]

Rebalance iSCSI connections by periodi-cally breaking existing connections thatare out of balance to allow the host toreconnect to another data IP address.This option has no effect on a FibreChannel array.

[--iscsi_connection_rebalancing{ yes|no}]

Allow updating the discovery or data IPaddresses for the active network config-uration.

[--force_ip_update]

Power UserDelete the specified network configura-tion. You cannot delete the active net-work 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 1500


Subnet-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 Yeseth4.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 activate themodified 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 as frame 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 name][--array {name|serial}]

nic --info name[--netconfig name][--array {name|serial}]

nic --assign name[--netconfig name][--array {name|serial}][--subnet subnet-label][--tagged {yes|no}][--data_ip addr]

nic --unassign name[--netconfig name][--array {name|serial}][--subnet subnet-label]


Options



N/A--help

GuestList all NICs, or the NICs associated withthe specified network configuration orthe NICs on the specified array.

--list

List the NICs for a specified networkconfiguration.

[--netconfig name]

List the NICs on the specified array.[--array {name | number}]

GuestShow detailed information about thespecified NIC.

name--info

Show detailed information about thespecified NIC on the specified networkconfiguration.

[--netconfig name]

Show detailed information about thespecified NIC on the specified array.

[--array {name | number}]

Power UserAssign a subnet on the specified NIC.name--assign

Assign a subnet on the specified NIC onthe specified network configuration.

[--netconfig name]

Assign a subnet on the specified NIC onthe specified array.

[--array {name | number}]

Specify the subnet to assign. Run subnet--list to get currently unassigned valuesfor subnet-label.

[--subnet subnet-label]

Specify whether the NIC uses a taggedassignment on the specified subnet. Atagged assignment means that traffic forthe subnet on this NIC will carry the802.1Q frame with the VLAN ID for thesubnet. A NIC can have at most one un-tagged assignment and zero or manytagged assignments.

[--tagged {yes|no}]

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

Power UserUnassign a subnet from the specifiedNIC.

name--unassign

Unassign a subnet from the specified NICon the specified network configuration.

[--netconfig name]

Unassign a subnet from the specified NICon the specified array.

[--subnet subnet-label]

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-dataeth3 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 to save 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: YesLink 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

partner

The 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 two arrays must beable to communicate over a network by using ports 4213 and 4214. Replication partners have the same name as the remotearray.

Replication partners can be reciprocal, upstream (the source of replicas), or downstream (the receiver of replicas) 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][--folder folder_name--match_folder {yes|no}][][--subnet label]

partner --edit partner_name[--hostname {ipaddr|hostname}][--control_port port]][--data_port port][--description text][--secret shared_secret]


[--pool pool_name][--folder folder_name][--match_folder {yes|no}][--name new_name][--subnet label]

partner --delete partner_name

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

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

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 partnersfor the array.

N/A--list

GuestProvide detailed information about thespecified replication partner.

partner_name--info



Power UserCreate a replication partner. The partnername must be the array name. Aftercreating a replication partner on one ar-ray, create a reciprocal, upstream, ordownstream partner on the array config-ured as the replication partner.

Note: With synchronous repli-cation, a user cannot manuallycreate pool partners. Pool part-ners are created based on thenumber of pools in the group.

partner_name--create

Specify the IP address or hostname ofthe management IP address for thereplication partner.

--hostname {ipaddr|hostname}

Specify the port number of the controlinterface. If you do not specify this op-tion, the default port 4213 is used.

[--control_port port]

Specify the port number of the data inter-face. If you do not specify this option, thedefault port 4214 is used.

[--data_port port]

Specify a description of the replicationpartner. If there are spaces in the descrip-tion, enclose the text in quotation marks.


Specify the shared secret that ensuressecure communication between thereplication partners. Both replicationpartners must use the same shared se-cret.

--secret shared_secret

Specify the storage pool in which to cre-ate volumes. Any volumes replicatedfrom this partner are created in thespecified pool. Replica volumes createdas clones ignore this parameter and arealways created in the same pool as theirparent volume. If you do not specify thisoption, the default storage pool is used.

[--pool pool_name]

Specify the name of the folder to containthe replica volumes. If the folder optionis not specified, the replica volumes willbe contained directly by the pool.

[--folder folder_name]

Specify whether to match the upstreamvolume's folder on the downstream.

[--match_folder {yes|no}

Specify the local subnet to use for com-munication with this partner. For exam-ple, 10.17.0.0/255.255.0.0.

--subnet label



Power UserModify the configuration of the specifiedreplication partner. Specify at least onesuboption.

Note: For synchronous replica-tion, the only attributes of thepartner command that you canedit are the description and thesecret.

partner_name--edit

Modify the IP address or hostname ofthe management IP address for thereplication partner.

[--hostname {ipaddr|hostname}]

Modify the port number of the controlinterface. The default port number is4213.

[--control_port port]

Modify the port number of the data inter-face. The default port number is 4214.

[--data_port port]

Modify the description of the replicationpartner.


Modify the shared secret that ensuressecure communication between thereplication partners. Both replicationpartners must use the same shared se-cret.

[--secret shared_secret]

Modify the storage pool in which to cre-ate volumes. Any volumes replicatedfrom this partner are created in thespecified pool. Replica volumes createdas clones ignore this parameter and arealways created in the same pool as theirparent volume. Modifying the pool_namedoes not affect existing replica volumes.

[--pool pool_name]

Specify the name of the folder to containthe replica volumes. If the folder optionis not specified, the replica volumes willbe contained directly by the pool.


Specify whether to match the upstreamvolume's folder on the downstream.

[--match_folder {yes|no}

Modify the name of the replication part-ner. The name must match the groupname of the replication partner

[--new_name partner_name]

Modify the local subnet to use for com-munication with this partner. For exam-ple, 10.17.0.0/255.255.0.0.

[--subnet label]



Power UserDelete the specified replication partner.If a volume collection is being replicatedto a replication partner, then subsequentreplication based on that collection fails.

Note: With synchronous repli-cation, a user cannot manuallydelete pool partners. Pool part-ners are deleted based on thenumber of pools in the group.

partner_name--delete

OperatorCreate a per-partner bandwidth throttle.You can create per-partner replicationthrottles only if there is no array-widebandwidth throttle. You can create mul-tiple per-partner throttles, but the throt-tles cannot overlap.

partner_name--create_throttle

Describes the throttle. The system auto-matically assigns an ID to the throttleschedule. If the description includesspaces, enclose the description text inquotation marks.


Specifies the days of the week on whichthe throttle is effective, separated bycommas. For example,

Tue,Thur

You can specify the value all to indicateall days of the week, which is the defaultif you do not specify this 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 value mustbe later than the --at time value.

--until time

Specify the maximum bandwidth to usefor replication in megabits per second.Use 0 (zero) to stop replication traffic,or unlimited to turn off throttling.

--bandwidth limit



OperatorModify the specified per-partner band-width throttle.

partner_name--edit_throttle

Modify the description of the throttle.[--description text]

Specify the ID of the throttle to modify.Use the --info option to determine thethrottle ID.

--id number

Modify the days of the week on whichthe throttle is effective, separated bycommas.

[--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 to usefor replication, specified in megabits persecond. Use 0 (zero) to stop replicationtraffic, or unlimited to turn off throttling.

--bandwidth limit

OperatorDelete the specified per-partner band-width throttle.

partner_name--delete_throttle

Specify the ID of the bandwidth throttleto delete. The ID is assigned by the sys-tem. Use partner --info to view all throt-tles and get the number you need.

--id number

OperatorPause replication to or from the specifiedreplication partner. In-progress replica-tions are stopped until resumed. Thisstate is stored persistently and remainsin force across system restarts.

partner_name--pause

OperatorResume the paused replication to or fromthe specified replication partner.

partner_name--resume

OperatorTest the network connection to thespecified replication partner. Both part-ners must be configured for the test tosucceed.

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 synchronous replication partner named array1.

Nimble OS $ partner --info array1Name: array1Description: pool partnerPartner type: poolHostname: N/AControl port: N/AData port: N/APool: defaultFolder:Match FolderPaused: NoConnected: YesConnection error: N/AConfiguration synchronized: N/ASynchronization error:N/AThrottled bandwidth: N/AThrottles: N/ASubnet type: N/ASubnet: N/AArray serial: N/AReplication version: N/ACreated: Aug 4 2018 23:41:26Last configuration change: April 5 2018 11:53:31

This example creates a replication partner with a secret of nimblereplica and a description of San Jose array. Because valuesfor 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 be changed on thereplication 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 replication traffic Mondaythrough 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 modificationallows replication traffic Monday through Wednesday from 3 PM until 5 PM and changes the 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.

pe

The pe command options allow you to view protocol endpoints, which are administrative logical units (LU) in LU conglomeratesto be used with VMware virtual volumes (VVOLs).

Synopsis

pe --help

pe --list

pe --info name [--verbose]

Options



N/A--help

List all protocol endpoints in the group.N/A--list

Display detailed information about thespecified protocol endpoint.

name--info

Display additional information about theprotocol endpoint, such as the compositeLUN for each VVOL binding.

--verbose

perfpolicyThe perfpolicy command options manage performance policies.

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

On creation, volumes inherit the dedupe default value of their associated Performance Policy unless explicitly overriden viathe dedupe option. The dedupe attribute determines if new writes will be deduped. Upon cloning, the volume inherits themost recent dedupe settings of its parent.

Create and edit a performance policy assigning block size, Application Category, and default dedupe configuration. If anincorrect Application Category is specified, the error message will include a list of the valid Application Categories.

Block size should be set to match the application block size. If the application block size is not known, it should be set to thelargest common denominator of the majority of I/O requests. If in doubt, set low (minimum 4KB), because setting it too highcan reduce performance severely, while setting it too low reduces performance by a small amount.


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

Compression can, and should, be left on unless the volume is known to hold mostly incompressible data. In this case, turningoff 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}][--app_category category][--dedupe_enabled {yes|no}]

perfpolicy --edit policy_name

[--name new_name][--description text][--compress {yes|no}][--cache {yes|no}][--cache_policy {normal|aggressive][--space_policy {offline|non_writable}][--app_category category][--dedupe_enabled {yes|no}]

perfpolicy --delete policy_name[--force]

Options



N/A--help

GuestList all configured performance policies.Several predefined performance policiesare provided, which are based on com-mon application best practices.

N/A--list

GuestProvide detailed information about thespecified performance policy.

policy_name--info



OperatorCreate the specified performance policy.The block size of a performance policycannot be changed once it has been cre-ated.

policy_name--create

Specify a description of the performancepolicy. If there are spaces in the descrip-tion, enclose the text in quotation marks.


Specify a block size to be used for vol-umes created with the specified perfor-mance policy. Supported block sizes are4096 bytes (4 KB), 8192 bytes (8 KB),16384 bytes (16 KB), and 32768 bytes(32 KB). If you do not specify this option,the default block size of 4096 bytes (4KB) is used. You cannot change the afteryou create the performance policy.

[--blocksize bytes]

Specify whether data in associated vol-umes should be compressed. If you donot specify this option, the default of yesis used, and data is compressed.

[--compress {yes|no}]

Specify whether data in associated vol-umes should be cached. If you do notspecify this option, the default of yes isused, and data is cached.

[--cache {yes|no}]

Specify how data of an associated vol-ume must be cached if data caching isenabled. The normal policy caches databut skips under certain conditions, suchas sequential I/O. The aggressive policyaccelerates caching of all data that is as-sociated with this volume, regardless ofsequentiality. You want to use the aggres-sive policy during the initial copy of adataset for a new volume. However, itmay cause the data that is associatedwith other volumes to be evicted fromcache sooner. It may also cause greaterwear on the flash-based cache over anextended period of time. Therefore, youmay want to revert to normal cachingafter the data load has been completed.If you do not specify this option, the de-fault of normal is used.

[--cache_policy {normal|aggressive}]

[--space_policy {offline|non_writable}]



Specify the state of the volume upon aspace-constraint violation such as vol-ume quota violation, snapshot quota vio-lation, volumes above their volume re-serve or snapshot reserve if the pool freespace is exhausted. The "offline" spacepolicy takes the volume offline. The"non_writable" space policy disallowswrite operations on the volume, but al-lows unmap and read operations. If youdo not specify this option, the default ofoffline is used.

Specify the application category settingfor volumes created with the specifiedperformance policy. The application cat-egory is case sensitive. Valid applicationcategories are:

• Backup• DB2• Exchange• File Server• Oracle• SharePoint• SQL Server• Virtual Desktop• Virtual Server• Other

[--app_category category]

Specify the dedupe enabled setting forvolumes created with the specified per-formance policy. This default value canbe overridden for each volume duringcreation or edit.

[--dedupe_enabled {yes | no}]



OperatorModify the specified performance policy.If there are spaces in the policy_name,enclose the value in quotation marks.Specify at least one suboption.

policy_name--edit

Modify the name of the performancepolicy

[--name new_name]

Modify the description of the perfor-mance policy.


Modify whether data in associated vol-umes should be compressed.

[--compress {yes|no}]

Modify whether data in associated vol-umes should be cached.

[--cache {yes|no}]

Modify the cache policy used when datain associated volumes is cached.

[--cache_policy {normal|aggressive}]

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

Modify the application category settingfor volumes created with the specifiedperformance policy. The application cat-egory is case sensitive. Valid applicationcategories are:

• Backup• DB2• Exchange• File Server• Oracle• SharePoint• SQL Server• Virtual Desktop• Virtual Server• Other

[--app_category category]

Modify the dedupe enabled setting forvolumes created with the specified per-formance policy. This default value canbe overridden for each volume duringcreation or edit.

[--dedupe_enabled {yes | no}]

Power UserDelete the specified performance policy.You cannot delete a performance policythat is associated with a volume. Removethe association before you delete theperformance policy.

policy_name--delete

Forcibly delete the specified performancepolicy even if there are volumes associat-ed 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)---------------------------+----------+--------+-----------------------------backup repository 4096 Yes Yes normaldefault 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 normalVMware 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 notuse 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 --force option is not needed.

Nimble OS $ perfpolicy --delete bigblock

pool

Synopsis

The pool command options manage storage pools.


Pools can consist of either All-Flash Arrays or Adaptive Flash Arrays, but cannot have a mixture of array types.

pool --help

pool --list

pool --info pool_name

pool --create pool_name--array array[--description description][--dedupe_all_volumes {yes|no}]

pool --delete pool_name[--force]

pool --edit pool_name[--description description][--name new_name][--dedupe_all_volumes {yes|no}][--set_default_pool]

pool --assign pool_name--array array_name--allow_lower_limits

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

pool --merge pool_name--target target--allow_lower_limits

Options



N/A--help

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

GuestShow detailed information about thespecified storage pool. The default poolis assumed.

pool_name--info



Power UserCreate a storage pool.pool_name--create

Specify which array to add to the storagepool. To add multiple arrays, repeat thisoption as many times as needed.

--array array_name

Specify a plain-text description of thestorage pool. If there are spaces in thedescription, enclose the text in quotationmarks.

[--description description]

Enables deduplication, by default, for allnew volumes created. It does not affectthe deduplication setting of existing vol-umes. Deduplication settings for existingvolumes can be changed by editing thevolume attributes.

[--dedupe_all_volumes {yes|no}]

Power UserDelete the specified storage pool. Youcannot delete the default pool. Beforeyou delete a pool, make sure that thereare no volumes assigned to the pool. Usevol --list --pool pool_name to see if thepool you plan to delete has any volumesassigned to it. If any volumes are as-signed, use vol --move to move thosevolumes to another storage pool. Thedefault pool cannot be deleted.

pool_name--delete

Forcibly delete the specified storagepool, even if it contains volumes thatwere deleted but whose space is still be-ing reclaimed.

[--force]

Power UserModify the storage pool settings. Specifyat least one suboption.

pool_name--edit

Modify the plain-text description of thestorage pool.


Modify the name of the storage pool.[--name new_name]

Enable or disable deduplication for allnew volumes created. This does not af-fect the deduplication setting of existingvolumes. Deduplication settings for exist-ing volumes can be changed by editingthe volume attributes.

[--dedupe_all_volumes {yes|no}]

Make this pool the default. Once this isset, future operations that do not explic-itly specify a pool will use this pool

[--set_default_pool]



Power UserAssign arrays to the storage pool.pool_name--assign

Specify an array to add to the pool. Toassign multiple arrays to the pool, repeatthis option as many times as needed.

--array array

Allow pool to have lower limits after theoperation. When an array is assigned toan existing pool, and the pool limits arehigher than the array limits, the resultingpool will have the lower limits of the ar-ray, which could also lower the grouplimits.

--allow_lower_limits

Power UserUnassign, or remove, arrays from thespecified storage pool.

pool_name--unassign

Specify an array to remove from the pool.To unassign multiple arrays from thepool, repeat this option as many timesas needed.

--array array

Forcibly unassign the array or arraysfrom the pool even if the arrays are un-reachable. For this operation to succeed,there should be no volumes associatedwith the array pool.

[--force]

Power UserMerge the specified storage pool into thespecified target pool. All volumes on thespecified pool are moved to the targetpool and the specified pool is thendeleted. Likewise, all arrays in the poolare assigned to the target pool. Thename of the newly merged pool is auto-matically truncated to a maximum of 255characters.

pool_name--merge

Specify the target, or destination, poolinto which the storage pool is merged.

--target target

When merging two pools with differentlimits, the resulting pool will have thelimits of the smallest pool prior to themerge.

--allow_lower_limits

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 and retention 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, and apply them asvolumes and collections are created. Protection templates consist of sets of snapshot schedules, replication schedules, andretention limits that can be used to prefill the protection information when creating volume collections. A volume collection,once created, us nit affected by edits to the protection template that was used to create it, all the volumes assigned to avolume collection use the same settings.


You cannot edit or delete the predefined protection templates provided with the NimbleOS software, but you can createcustom protection templates as needed.

Synopsis

prottmpl --help

prottmpl --list

prottmpl --info name

prottmpl --create name[--description text]--app_sync {none|vss|vmware|generic}[--app_server server][--app_id {exchange|sql2005|sql2008|sql2012|exchange_dag|sql2014|sql2016|hyperv}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username server][--vcenter_password server][--agent_hostname server][--agent_username user_name][--agent_password password]--schedule name--repeat period--repeat_unit {minutes|hours|days|weeks}[--at time][--until time][--days days][--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 --delete name

prottmpl --edit name[--newname name][--description text][--app_sync {none|vss|vmware|generic}][--app_server server][--app_id {exchange|sql2005|sql2008|sql2012|exchange_dag|sql2014|sql2016|hyperv}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username server][--vcenter_password server][--agent_hostname server][--agent_username user_name][--agent_password password]


prottmpl --addsched name--schedule name--repeat period--repeat_unit {minutes|hours|days|weeks}[--at time][--until time][--days days][--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 name--schedule name[--name new_name][--repeat period][--repeat_unit {minutes|hours|days|weeks}][--at time][--until time][--days days][--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


GuestShow usage information for thecommand.

N/A--help

GuestList protection templates.N/A--list

GuestProvide detailed informationabout the specified protectiontemplate and its schedules.

name--info



OperatorCreate a protection template withthe given schedule.

name--create

Specify a plain-language descrip-tion of the protection template.This is useful to specify what theprotection template was designedto optimize. If there are spaces inthe name, enclose the text in quo-tation marks,


Define the application synchroniza-tion to apply. If you specify vsssynchronization, provide the--app_* credentials. If you specifyvmware synchronization, providethe --vcenter_* credentials. If youhave created a custom agent,specify the generic app type whencreating a protection template.

--app_sync {none|vss|vmware|generic}

Specify the application serverhostname when vss synchroniza-tion is enabled.

[--app_server server]

Define the application running onthe server when vss synchroniza-tion is enabled, including MS Hy-per-V.

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

Specify the cluster name if theapplication that uses vss synchro-nization is running within a Win-dows clustering environment.

[--app_cluster_name cluster_name]

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

[--app_service_name service_name]

Specify the host hostname of thevCenter server with which theNimble array will communicatewhen vmware synchronization isenabled. A customer port numbercan be specified using ":".

[--vcenter_hostname server]

Specify the Windows user nameto use to create a Nimble accounton the vCenter server whenvmware synchronization is en-abled.

[--vcenter_username server]

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

[--vcenter_password server]



[--agent_hostname server] Backup hostname. A custom portnumber can be specified using ":".

Backup agent user name.[--agent_username user_name]

Backup agent user's password.[--agent_password password]

Name of the snapshot schedule toassociate with this protectiontemplate. Use --addsched to addmore schedules to the protectiontemplate after creating it.

[--schedule name]

Specify the frequency of snap-shots every --repeat_unit. If youdo not specify this option, the de-fault value of 1 is used.

--repeat period

Specify the unit of time for --re-peat to define the frequency ofsnapshots. If you do not specifythis option, the default value of todays is used.

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

Specify the time of day to starttaking snapshots. If you do notspecify this option, the defaultvalue of 12:00 (midnight) is used.

[--at time]

Specify the time of day to stoptaking snapshots. If you do notspecify this option, the defaultvalue of 11:59 (PM) is used if astop time is appropriate for therepeat unit. For example, if youtake snapshots once daily, you donot need this option.

[--until time]

Specify on which days to takesnapshots unless the repeat unitis weeks. 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 days]

Specify the maximum number ofsnapshots to keep. After thisnumber is reached, older snap-shots can be deleted to makeroom for new ones if the space isneeded. If replication is enabledon this schedule, the array alwaysretains the latest replicated snap-shot, which may exceed the speci-fied retention value. This is neces-sary to ensure efficient replicationperformance.

[--retain number]



[--replicate_to partner] Specify the replication partner forreplicated snapshots. Use partner--create on both arrays to config-ure replication partners.

Specify that a certain number ofsnapshots assigned to the sched-ule should be replicated. For exam-ple, setting this to 5 replicates ev-ery fifth snapshot. If snapshots arereplicated and you do not specifythis option, all snapshots arereplicated.

[--replicate_every number]

Specify the number of snapshotsto retain on the replication part-ner.

[--num_retain_replica number]

If replicating a snapshot takesmore than this amount of time tocomplete, an alert will be generat-ed. If you do not specify this op-tion, the default of 24 hours isused. Enter 00:00 to disable thisalert.

[--alert_threshold hh:mm]

Specify whether to run a verifica-tion tool on snapshots created bythis schedule. Use this option withsnapshot schedules of a volumecollection that has applicationsynchronization. The tool used toverify snapshots depends on thetype of application. For example,if the application synchronizationis vss and the application ID is ex-change, the eseutil tool is run onthe snapshots. If verification fails,the logs are not truncated.

[--snap_verify {yes|no}]

Specify whether to skip consisten-cy checks for database files onsnapshots created by this sched-ule. Use this option with snapshotschedules of a volume collectionthat has application synchroniza-tion of vss, the application ID isexchange_dag. (MS Exchange2010 or later using DatabaseAvailable Group), --snap_verify isset to yes, and --disable_appsyncis set to no. Skipping consistencychecks is only recommended ifeach database in a DAG has multi-ple copies.

[--skip_db_consistency_check {yes|no}]

[--disable_appsync {yes|no}]



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

Specify whether this schedule ismanaged by externally drivenmanual snapshots.

Normal protection schedules haveinternal timers which drive snap-shot creation. An externally driveschedule has no internal timers,and all snapshot activity is drivenby an external trigger.

[--external_trigger {yes|no}]



OperatorModify attributes of the specifiedprotection template. New volumecollections based on the templateare affected by the modifications,but existing volume collections arenot. Specify at least one subop-tion.

name--edit

Modify the name of the protectiontemplate.

[--name new_name]

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


Modify the application synchro-nization to apply. If you have cre-ated a custom agent, specify thegeneric app type when editing aprotection template.


Modify the application server forvss synchronization.


Modify the application running onthe server for vss synchronization,including MS Hyper-V.


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


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


Modify the host name of thevCenter server with which theNimble array communicates forvmware synchronization.


Modify the Windows user namefor vmware synchronization.

[--vcenter_username server]

Modify the password associatedwith the user name for vmwaresynchronization.

[--vcenter_password server]

[--agent_hostname server]

[--agent_username user_name]

[--agent_password password]

OperatorDelete the specified protectiontemplate.

name--delete



OperatorAdd a schedule to the specifiedprotection 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 thisoption, the default value of 1 isused.

--repeat period

Specify the unit of time for to de-fine the frequency of snapshots.If you do not specify this option,the default value of days is used.

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

Specify the time of day to starttaking snapshots. If you do notspecify this option, the defaultvalue of 12:00 (midnight) is used.

[--at time]

Specify the time of day to stoptaking snapshots. If you do notspecify this option, the defaultvalue of 11:59 (PM) is used if astop time is appropriate for therepeat unit. For example, if youtake snapshots once daily, you donot need this option.

[--until time]

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

[--days days]

Specify the maximum number ofsnapshots to keep. After thisnumber is reached, older snap-shots can be deleted to makeroom for new ones if the space isneeded. If replication is enabledon this schedule, the array alwaysretains the latest replicated snap-shot, which may exceed the speci-fied retention value. This is neces-sary to ensure efficient replicationperformance.

[--retain number]

Specify the replication partner forreplicated snapshots. Use partner--create on both arrays to config-ure replication partners.

[--replicate_to partner]




Specify that a certain number ofsnapshots assigned to the sched-ule should be replicated. For exam-ple, setting this to 5 replicates ev-ery fifth snapshot. If snapshots arereplicated and you do not specifythis option, all snapshots arereplicated.

Specify the number of snapshotsto retain on the replication part-ner.


If replicating a snapshot takesmore than this amount of time tocomplete, an alert will be generat-ed. If you do not specify this op-tion, the default of 24 hours isused. Enter 00:00 to disable thisalert.


Specify whether to run a verifica-tion tool on snapshots created bythis schedule. Use this option withsnapshot schedules of a volumecollection that has applicationsynchronization. The tool used toverify snapshots depends on thetype of application. For example,if the application synchronizationis vss and the application ID is ex-change, the eseutil tool is run onthe snapshots. If verification fails,the logs are not truncated.


Specify whether to skip consisten-cy checks for database files onsnapshots created by this sched-ule. Use this option with snapshotschedules of a volume collectionthat has application synchroniza-tion of vss, the application ID isexchange_dag. (MS Exchange2010 or later using DatabaseAvailable Group), --snap_verify isset to yes, and --disable_appsyncis set to no. Skipping consistencychecks is only recommended ifeach database in a DAG has multi-ple copies.


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


[--external_trigger {yes|no}]]



Specify whether this schedule ismanaged by externally drivenmanual snapshots.




OperatorModify a schedule for the specifiedprotection template. Specify atleast one suboption in addition to--schedule name.

name--editsched

Specify the name of the snapshotschedule to modify.

--schedule name

Modify the name of the snapshotschedule.

[--newname name]

Modify the frequency of snapshotsfor each --repeat_unit.

[--repeat period]

Modify the unit of time for --re-peat to define the frequency ofsnapshots.

[--repeat_unit {min-utes|hours|days|weeks}]

Modify the time of day to starttaking snapshots.

[--at time]

Modify the time of day to stoptaking snapshots.

[--until time]

Modify the days on which to takesnapshots unless the repeat unitis weeks.

[--days 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 snapshotsto retain on the replication part-ner.


Modify whether to generate analert if replicating a snapshottakes more than this amount oftime to complete.


Modify whether to run a verifica-tion tool on snapshots created bythis schedule.


Modify whether to skip consisten-cy checks for database files onsnapshots created by this sched-ule.


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




Modify whether this schedule ismanaged by externally drivenmanual snapshots.



OperatorDelete the specified schedule fromthe specified protection template.

name--deletesched

Specify the snapshot schedule todelete.

--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: No


Number 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 31 snapshots and 52replicas.

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

This example shows creating a protection template with app sync type generic.

Nimble OS $ prottmpl --create gen-sync-test-prottmpl --app_sync generic--agent_hostname 10.18.237.121 --agent_username Administrator --agent_passwordNim123# --schedule sched1 --retain 30

This example shows editing a protection template with app sync type generic.

prottmpl --edit gen-sync-test-prottmpl --agent_hostname 10.xx.xx.xxx


rebootThis command reboots an entire group of arrays, an array, or a controller. If you want to stop I/O traffic without rebooting,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

Power UserReboot the specified array.array_name--array

Reboot the specified controller on an ar-ray. Valid controller names are A and B,which are case sensitive. If you do notspecify this option, both controllers onthe specified array are rebooted.

[--controller (A|B}]

Override the default behavior of havingto type "yes" to complete the command.Use this suboption with care to avoidunexpectedly taking the array or con-troller offline for a short time and disrupt-ing client connections.

--non_interactive

Power UserReboot the entire group when you runthis command on the group leader. If anyarray fails to respond to the reboot re-quest, then the group leader array re-mains operational.

N/A--group

Override the default behavior of havingto type "yes" to complete the command.Use this suboption with care to avoidunexpectedly taking the group offline fora short time and disrupting client connec-tions.

--non_interactive

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 group leader array.

Nimble OS $ reboot --group --non_interactive

route

The 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 (for example, 10.12.0.100/16). Whenthe system must connect to a remote array or host, it checks the routing table to determine if a known path exists. If theremote 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[--netconfig {active|backup|draft}][--gateway gateway

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

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

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

Options



N/A--help

GuestList all configured routes.--list

List all configured routes on the specifiednetwork configuration.

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



GuestProvide detailed information about thespecified network route. The route isDestination/Netmask from the --list out-put.

network--info

Provide detailed information about thespecified network route on the specifiednetwork configuration.


Provide detailed information about thenetwork route for the specified gateway.

[--gatewaygateway]

Power UserAdd the specified network route.network--add

Add the specified network route on thespecified network configuration.

--netconfig {active|backup|draft}

Add the specified network route for thespecified gateway.

--gateway gateway

Power UserModify the specified network route.Specify at least one suboption.

network--edit

Modify the specified network route onthe specified network configuration.


Modify the specified network route for anew destination network.

[--network network]

Modify the specified network route forthe specified gateway.

[--gateway gateway]

Power UserDelete the specified network route.network--delete

Specify the network configuration fromwhich to delete the specified networkroute.


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 value is Destination/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

setup

The setup command and its options configure an array.

You can set up an array with the interactive setup wizard in the command line interface. To learn more about using theinteractive setup wizard, see the Hardware Guide. Alternatively, you can specify the options in the CLI as described here. Ifyou use the non-interactive command line, then you must specify all mandatory settings as command line options.

Synopsis

setup --help

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

Options



N/A--help



Administra-tor

Specify the name of a group. A single-array group is by default named the de-fault group.

[--group_name group_name]

Specify the name of the array.--name array_name

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

Specify the IP address of the DNS serverto use. Repeat this option to specify IPaddresses for multiple DNS servers.

[--dnsserver server]

Specify a host name or an IP address forthe NTP server to use.

[--ntpserver server]

Specify the time zone the array is in.[--timezone zone]

Specify a management IP address.--mgmt_ipaddr ipaddr

Specify a backup management IP ad-dress.

--backup_mgmt_ipaddr ipaddr

Specify a subnet on a NIC. This optioncan be repeated to specify more thanone subnet label. The first subnet labelcorresponds to the first NIC, vizz, or eth1,and the second subnet label is assignedto the second NIC, viz, or eth2, and soon.A blank argument can be used to skipone NIC.

--subnet_label label

Specify the subnet IP address. This op-tion can be repeated to specify morethan one subnet. The first subnet is as-signed to the first NIC, viz., eth1, and thesecond subnet is assigned to the secondNIC, viz1, or eth2, and so on. A blank ar-gument can be used to skip one NIC.

--subnet_addrnetwork/netmask

Specify the subnet type. Valid subnettypes are management and data. A sub-net can be both management and data.Multiple subnet types can be specifiedby using a comma separated list. Thisoption can be repeated to specify morethat one subnet type. The first subnettype is assigned to the first NIC via eth1,and the second subnet is assigned to thesecond NIC via eth2, and so on. A blankargument can be used to skip one NIC.

In a single-array Fibre Channel group, adata subnet is optional. Use the manage-ment subnet for replication.

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

Specify the subnet maximum transmis-sion unit (MTU). If you do not specify thisoption, the default of 1500 is used.

[--subnet_mtu mtu]



--default_gateway ipaddr Specify the default gateway IP address.

Specify the data IP address. This optioncan be repeated to specify more thanone NIC IP address. The first IP addressis assigned to the first NIC via eth1, andthe second IP address is assigned to thesecond NIC via eth2, and so on. Blankargument can be used for skipping oneNIC. Configure at least on data IP oniSCSI arrays. On Fibre Channel arrays,you can specify an IP address, or leavethe value empty (--data_ipaddr '') to by-pass this option. If IP addresses arespecified on Fibre Channel arrays, thedata IPs are used to handle replicationtraffic and entrap-group communication.

[--data_ipaddr ipaddr]

Specify the discovery IP address. If youdo not specify this option, the manage-ment IP address is used.

[--discovery_ipaddr ipaddr]

Specify the support IP address. Includethis argument twice. Then the first IPaddress entered is assigned to ControllerA and the second to Controller B. Youmust assign static IP addresses to allowarray access if the management IP ad-dress is not accessible.

[--support_ipaddr ipaddr]

Redirect connections to the best data IPaddress based on connection counts. Ifyou do not specify this option on an iSCSIarray, the default of yes is used. Thisoption has no effect in a Fibre Channelarray.

[--iscsi_automatic_connection_method{yes|no}]

Rebalance the iSCSI connection by peri-odically breaking existing connectionsthat are out of balance, which allows thehost to reconnect to a more appropriatedata IP. If you do not specify this optionon an iSCSI array, the default of yes isused. This option has no effect in a FibreChannel array.

[--iscsi_connection_rebalancing {yes|no}]

Accept the terms and conditions of use,the end user license agreement (EULA),and third-party software notices.

--accept_license

List the terms and conditions of use, theEULA, and third-party software notices.

[--view_license]


Examples

This example non-interactively sets up an iSCSI array.

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

shelf

The shelf command options manage expansion shelves on an array. An array can be a standalone head shelf, or a head shelfwith one to seven shelves connected to it, depending on the array and shelf models.

Synopsis

shelf --help

shelf --list--array name[--ctrlr {A|B}]

shelf --info shelf_serial--array name[--verbose]

shelf --show_topology--array name[--ctrlr {A|B}]

shelf --activate shelf_serial--array name

[--driveset index][--accept_foreign][--accept_dedupe_impact]


Options



N/A--help

GuestList all shelves connected to an array orto a specified controller, A or B. Informa-tion for each shelf includes its serialnumber, model number, state, locationand sensor status.

--array name--list

List expansion shelves on the specifiedcontroller on the specified array.

[--ctrlr {A|B}]

GuestShow information about a specific expan-sion shelf by serial number. Get theshelf_serial from --list output. Use the--array option to display informationabout all shelves on the array.

shelf_serial --array name--info

Show detailed information about a spe-cific expansion shelf.

[--verbose]

GuestList the shelves on an array and showhow they are connected to the array orto a specific controller, A or B.

--array name--show_topology

Show the topology for all shelves connect-ed to the specified controller.

[--ctrlr {A|B}]

Power UserActivate the specified expansion shelfon the specified array. Activating an ex-pansion shelf prepares and formats it tostore user data. Before activating a shelf,be sure that all shelf cables are properlyconnected and the shelf is powered on.

shelf_serial --array name--activate

Activate a specific drive set, 0 (first driveset) or 1 (second drive set).

[--driveset index]

Accept the removal of data on the for-eign shelf and activate it.

[--accept_foreign]

Accept the reduction or elimination ofdeduplication capabilities on the arrayas the result of activating a shelf thatdoes not meet the necessary deduplica-tion requirements.

[--accept_dedupe_impact]

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 output is truncated tosave 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 rpmfan4-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 and activates an expansion shelf on an array named array7.

Nimble OS $ shelf --activate AA-102081 --array array7

snap

The snap command options manage snapshots.

Snapshots are point-in-time copies of volumes that can be brought online and used immediately, cloned, and replicated. Likevolumes, snapshots can be accessed by initiators, are subject to the same controls, can be modified, and have the samerestrictions.

The initial snapshot shares its original data with the volume from which it was created. Each successive snapshot consumessome space when it captures the changes that occurred on the volume. The changed blocks remain compressed, so snapshotcapacity consumption is efficient.

Stagger snapshot schedules to ensure that application synchronization, I/O quiescing, database verification, and similar actionshave time to complete before the next schedule starts.

All snap command options that accept a volume name as an argument will accept an optional --pool argument to differentiatethose volumes that have the same name, but reside in different pools.

Synopsis

snap --help

snap --list[--vol vol_name][--pool pool_name][--all][--unmanaged][--manually_managed]

snap --info snap_name--vol vol_name[--pool pool_name][--verbose]

snap --delete snap_name--vol vol_name[--pool pool_name][--force][--force_last_repl]

snap --edit snap_name--vol vol_name[--pool pool_name][--name new_name][--description text]

snap --online snap_name--vol vol_name[--pool pool_name]

snap --offline snap_name--vol vol_name[--pool pool_name]


[--force]

snap --cksum snap_name--vol vol_name[--pool pool_name]

Options



N/A--help

GuestList snapshots for the specified volume.Specify this suboption or --all, not both.

[--vol vol_name]--list

List snapshots for the specified volumein the specified pool. The --pool is re-quired if the volume name is not uniquewithin the group.

[--pool pool_name]

List snapshots for all volumes. Specifythis suboption or --vol vol_name, notboth.

[--all]

Limit list to unmanaged snapshots thatwill not be automatically deleted. Actionsthat lead to unmanaged snapshots in-clude deletion of a protection scheduleand dissociation of volume from volumecollection. Manual snapshots are alsoconsidered unmanaged since they willnot be deleted automatically.

[--unmanaged]

Limit list to manually managed snap-shots. These snapshots will not be auto-matically deleted. Manually managedsnapshots are either manually created,created by third party software, or creat-ed by the NimbleOS during restore andresize operations on a volume. You mustuse either the --all or --vol suboption tolist manually managed snapshots.

[--manually_managed]

GuestProvide detailed information about thespecified snapshot in the specified vol-ume.

snap_name --vol vol_name--info

List a specific snapshot from a set ofsnapshots for a specific volume. The--pool option is required if the volumename is not unique within the group.

[--pool pool_name]

Give extra information about the speci-fied snapshot, including metadata.

--verbose



OperatorModify the specified snapshot. Specifyat least one suboption.

snap_name --vol vol_name--edit

Modify the specified snapshot for thespecified volume. The --pool is requiredif the volume name is not unique withinthe group.

[--pool pool_name]

Modify the name of the specified snap-shot.

[--name new_name]

Modify the description of the specifiedsnapshot or add a description to it. Ifthere are spaces in the description, en-close the text in quotation marks.


OperatorBring the specified snapshot online.snap_name --vol vol_name--online

Bring the specified snapshot online. The--pool is required if the volume name isnot unique within the group.

[--pool pool_name]

OperatorTake the specified snapshot offline. Initia-tors cannot connect to a snapshot thatis offline. Taking a snapshot offline failsif there are open connections from initia-tors unless --force is used.

snap_name --vol vol_name--offline

Take the specified snapshot offline. The--pool is required if the volume name isnot unique within the group.

[--pool pool_name]

Forcibly take the specified snapshot of-fline even if it has open connections.

[--force]

OperatorCompute the checksum of the specifiedsnapshot to verify data integrity.

snap_name --vol vol_name--cksum

Compute the checksum of the specifiedsnapshot. The --pool is required if thevolume name is not unique within thegroup.

[--pool pool_name]

Power UserDelete the specified snapshot. Snapshotsmust be offline to be deleted.

snap_name --vol vol_name--delete

Delete the specified snapshot. The --poolis required if the volume name is notunique within the group.

[--pool pool_name]

Forcibly delete a snapshot managed byan external agent.

[--force]

Forcibly delete the last replicated snap-shot.

[--force_last_repl]

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 (MiB) (MiB)---------+--------------------+----------+------+-------+------------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: 9livesPool: Pool2Serial 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: 0iSCSI: 0FC: 0Schedule: 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--name 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

snapcoll

The snapcoll command options manage snapshot collections. Snapshot collections are associated with volume collections.

Snapshot collections are replicated in the order that the collections were taken. If a snapshot cannot be replicated, the systemindefinitely attempts to complete the replication. These pending snapshot collections are not deleted by the system, but theycan be manually deleted after pausing the replication partner.

Except when initiated manually, snapshot collections are not created by the admin user; the system creates them after successfulsnapshot schedules complete. These snapshot collections are named with the volume collection name, schedule, and timestamp.

Downstream snapshot collections from synchronous replication can be identified by the .R appended to the end of the snapshotcollection name.

Synopsis

snapcoll --help

snapcoll --list[--volcoll volcoll_name][--unmanaged]

snapcoll --info snapcoll_name[--volcoll volcoll_name]

snapcoll --delete snapcoll_name[--volcoll volcoll_name]

snapcoll --edit snapcoll_name[--volcoll volcoll_name][--name new_name][--description text][--replicate {yes|no}]

Options



N/A--help



GuestList all snapshot collections.N/A--list

List all snapshot collections associatedwith the specified volume collection. Usevolcoll --list to get values for vol-coll_name.

[--volcoll volcoll_name]

Limit list to unmanaged snapshot collec-tions that will not be automaticallydeleted. Deletion of a protection scheduleleads to unmanaged snapshot collections.Manual snapshot collections are alsoconsidered unmanaged since they willnot be deleted automatically.

[--unmanaged]

GuestProvide detailed information about thespecified snapshot collection.

snapcoll_name--info

Provide detailed information about thespecified snapshot collection associatedwith the specified volume collection.


Power UserDelete the specified snapshot collection.snapcoll_name--delete

Delete the specified snapshot collectionassociated with the specified volumecollection.


OperatorModify the specified snapshot collection.snapcoll_name--edit

Modify the specified snapshot collectionassociated with the specified volumecollection..


Modify the name of the specified snap-shot collection.

[--name new_name]

Modify the plain-language description ofthe specified snapshot collection. This isuseful to identify what the snapshot col-lection was designed to optimize. If thereare spaces in the description, enclose thetext in quotation marks.


Enable or disable replication for thespecified snapshot collection.

Note: This command appliesto snapshot replication only.

[--replicate {yes|no}]

Examples

This example lists the snapshot collections for the volume collection named TestRep.

Nimble OS $ snapcoll --list --volcoll TestRep-----------------+-----------------------------------+-------+-----------Volume Collection Snapshot Collection Num Replication


Name Name Snaps Status-----------------+-----------------------------------+----------+-----------TestRep TestRep-FiveMinutes-2010-12-28::11:50:00.000 1 PendingTestRep TestRep-FiveMinutes-2010-12-28::11:50:00.000.R 1 PendingTestRep TestRep-FiveMinutes-2010-12-28::11:40:00.000 1 In-progressTestRep TestRep-FiveMinutes-2010-12-28::11:40:00.000.R 1 Complete

This example shows information about a collection of daily snapshots on a volume collection named volume1--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/ACreated: Jul 16 2014 00:00:00Snapshots:

Volume: volume1Snapshot: volume1--1754979654-daily-2014-07-16::00:00:00.000

Key/value pairs: NoneSynchronous Replication Owner: default

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

software

The software command options manage the Nimble software that is installed on an array. You can download, upload, cancelan 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 newerversion can be stored at a time.

If your array does not have Internet access, you must download the software from the Nimble Storage Support site.

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

GuestProvide detailed information about thespecified software version.

version--info

Show the terms and conditions of use,the end user license agreement (EULA),and third-party software notices for thespecified software version.

[--view_license]

Power UserStart to download the specified softwareversion.

version--download

Forcibly download the currently runningsoftware version.

[--force]

Power UserShow the status of a software download.--download_status

Specify the number of seconds afterwhich to refresh the status. Set this to 0(zero) to disable the status refresh mes-sages.

[--interval seconds]

Power UserCancel a software download.N/A--cancel_download



Power UserPerform verification checks on the arrayto verify that a software update cansucceed.

--precheck

Perform most verification checks, butskip the checks that can be overriddenduring the update by using the --forceoption then.

[--force]

Power UserStart to update the array to the down-loaded software version.

--update

Forcibly start the software update, evenif it might cause I/O errors on active vol-umes by restarting the active controller.

[--force]

Accept the terms and conditions of use,the EULA, and third-party software no-tices.

[--accept_license]

Power UserShow the status of a software update.--update_status

Show the status of a software update oneach array being updated.

[--verbose]

Power UserResume a software update that timedout or failed before all member arrayswere updated.

--resume_update

Accept the terms and conditions of use,the EULA, and third-party software no-tices.

[--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 version 2.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

sshkey

The sshkey command options manage secure shell (SSH) authorized keys. SSH uses public keys and cryptography toauthenticate users.

When there is a public key on one end of a network connection and the matching private key on another, a user does not haveto manually type the password. SSH keys make it possible to create scripts that perform certain tasks without having tomanually log in to the array. You can use RSA and DSA algorithms. RSA is used both for encryption and signing. DSA is usedonly 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

Administra-tor

List all currently stored SSH keys or theSSH key for the specified user. For eachkey, you will see the key name and type,but not the key string. To see the keystring, use the --info option.

[--user user_name]--list

Administra-tor

Show detailed information about thespecified SSH key.

key_name--info

Show detailed information about thespecified user's SSH key.

[user_name]

Administra-tor

Specify the name of the SSH key. Thekey must exist before you add it.

key_name--add

Specify the type of SSH key authentica-tion used.

--type {dsa|rsa}

Specify the DSA or RSA string that con-stitutes the SSH key. When you add thekey, specify only the encrypted portionof the key. Do not include the ssh_dss orssh_rsa at the start of the string or theusername@hostname at the end.

Important: Do not includespaces at the start or end of thekey. Include only the key stringitself.

--key keystring

Add the SSH key for the specified user.[--user user_name]

Administra-tor

Modify the specified SSH key. You canchange the type (DSA or RSA) and thekey string, but you cannot change thekey name.

key_name--edit

Modify the type of SSH key authentica-tion used.

[--type {dsa|rsa}]

Modify the DSA or RSA string that con-stitutes the SSH key.

[--key keystring]

Modify the SSH key for the specified us-er.

[--user user_name]

Administra-tor

Delete the specified SSH key.key_name--delete

Delete the SSH key for the specified 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 key string for the RSA SSH key named power. The output is truncated to avoid line wrapping.

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

stats

The stats command options let you view array statistics. You can specify the period of interest, items of interest, and displayoptions. The default output includes a set of system utilization statistics.

All stats command options that accept a volume or folder name as an argument also accept an optional --pool argument todifferentiate those volumes or folders that have the same name, but reside in different pools.


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 shelf_location][--net {all | nic1,nic2,...}][--fc {all | fc1,fc2,...}][--perf {composite | vol}][--latency][--iosize][--pool pool][--replication][--partner {all | composite | partner1,partner2...}][--vol {all | composite | vol1,vol2,...}][--pool pool][--folder {all | composite | folder1,folder2,...}][--pool pool][--interval seconds][--range][--show_time][--diff][--mb][--gb][--hdr intervals][--csv]

Options



N/A--help



GuestSpecify the beginning time for whichstatistics are to be displayed. When usedalone, the value defaults to the currenttime.


Specify the ending time for which statis-tics are to be displayed. When usedalone, the value defaults to the currenttime, creating a live statistics stream.


Specify the length of time for whichstatistics are to be displayed. When usedwith --from, it specifies the durationstarting at the --from time. When usedwith --to, it specifies the duration endingat the --to time. When used alone, it isequivalent to specifying --from "now mi-nus duration", or if the specified durationbegins with a '+', it is equivalent to speci-fying --to "now plus duration".

[--duration [+]hh:mm[:ss]]

Display statistics from the specified ar-ray. For disk and net work statistics, thisoption is required when multiple arraysexist in the group. For volume statistics,this option is not required, and if notspecified, group-wide aggregate valuesare displayed.


Display statistics for disk utilization fromthe disk in the specified slot.

[--disk {all | 1,2,...}]

In the case of multiple disk shelves, use--shelf_location to see statistics for aparticular disk in the specified shelf. If--shelf_location is not specified, diskstatistics for all disks in the head shelfare displayed. For example, to seestatistics for the disk in slot 7 of shelf 0connected to controller A, you wouldenter stats --disk 7 --shelf_location A.0.


Display statistics for network utilizationof all NICs or the specified NICs.

[--net {all | nic1,nic2,...}]

Display statistics for all Fibre Channelports or the specified ports.

[--fc {all | fc1,fc2,...}]

Display statistics for system or volumeperformance.

[--perf {composite | vol}]

Display additional latency details withthe --perf output.

[--latency]

Display additional I/O details with the--perf output.

[--iosize]

[--pool pool]



The --pool suboption is required if thevolume name is not unique within thegroup. For example, to see statistics forvol1 in pool pool1, you would enter stats--perf vol1 --pool pool1.

Display statistics for replications. Specifyeither the --partner suboption to specifyone, all, or some replication partners, orthe --vol suboption to specify one, all, orsome volumes.

[--replication]

Display statistics for one, all (as a com-posite or individually), or some replica-tion partners. Use partner --list to getpartner1,partner2,... values.

[--partner {all | composite | partner1,part-ner2,...}]

Display statistics for one, all (as a com-posite or individually), or some volumes.Use vol --list to get vol1,vol2,... values.

[--vol {all | composite | vol1,vol2,...}]

Name of the pool where the volume orvolumes reside.

[--pool pool]

Display statistics related to folders in aspecific pool. For a single folder, specifythe folder name. For a composite of allfolders in a pool, specify the variablecomposite. For all folders, specify thevariable all. Use folder --list to get fold-er1,folder2,... values.

[--folder {all | composite | folder1,fold-er2,...}]

The pool suboption is required touniquely identify a folder within a group.For example, to see statistics for folderfolder1 in pool pool1, you would enterstats --folder folder1 --pool pool1.

[--pool pool]

Display statistics in the specified inter-vals in seconds. If not specified, the latestvalues for the period are displayed.

[--interval seconds]

Display the minimum, maximum, and av-erage values for the statistics.

[--range]

Display a timestamp for each interval.[--show_time]

Display statistics as differences from theprevious interval.

[--diff]

Display disk and network byte transfersin mebibytes. The default is kibibytes.

[--mb]

Display disk and network byte transfersin gigabytes. The default is kibibytes.

[--gb]

Header lines are normally displayed ev-ery 20 intervals. Us this option to specifya different interval, or 0 to omit headersaltogether.

[--hdr { intervals | 0}]



Display statistics as a comma-separatedlist of values instead of as a space-sepa-rated list.

[--csv]

Examples

Note: To stop the scrolling display of statistics output when running the command interactively, press the Ctrl+Ckeys at any time.

These examples show stats command output, first without any parameters and then with defined parameters. The output istruncated to save space and prevent line wrapping.

Nimble OS $ statsStats from 2018-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 2018-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 2018-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 2018-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 prevent line wrapping.

Nimble OS $ stats --from 01:10 --to 01:20Stats from 2018-09-02,01:10:00 to 2018-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 2018-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 and prevent line wrapping.

Nimble OS $ stats --fc fc5Stats from 2018-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) format showing gigabytesinstead of the default of kilobytes. The output is truncated to save space and prevent line wrapping.

Nimble OS $ stats --fc fc5 --gb --hdr 30 --csvStats from 2018-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......

subnet

The 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][--failover {enable | disable}]

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][--failover {enable | disable}]

subnet --remove subnet_label[--netconfig {active | backup | man subnetdraft}][--force_repl][--force_ip_update][--force_unassign_nics][--force_initiator_groups]

Options



N/A--help

GuestList all configured subnets.N/A--list

List all configured subnets in the speci-fied network configuration.

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

GuestProvide detailed information about thespecified subnet.

subnet_label--info

Provide detailed information about thespecified subnet in the specified networkconfiguration.




Power UserAdd the specified subnet. The subnet_la-bel can be up to 64 characters.

subnet_label--add

Specify the subnet address, expressedin Classless Inter-Domain Routing (CIDR)format.

--subnet_addr network / netmask

Specify the subnet discovery IP address.[--discovery_ipaddr ipaddr]

Specify whether the subnet is used fordata, management, or data+managementtraffic. You can specify multiple types byusing a comma-separated list.

[--type {mgmt | data | mgmt,data}]

Specify the subnet subtype for a subneton an iSCSI array. You can specify multi-ple subtypes by using a comma-separat-ed list.

[--subtype {iscsi | group}]

Specify the Network Affinity Zone typefor a subnet on an iSCSI array.

[--netzone_type {evenodd | bisect | sin-gle}]

Specify the network configuration towhich to add the subnet.

[--netconfig name]

Specify the VLAN ID for the subnet. Validvalues are in the 1-4094 range, inclusive.

[--vlanid id]

Specify the maximum transmission unit(MTU) for the subnet. Valid values arein the 512-16000 range, inclusive.

[--mtu mtu]

Specify whether to enable or disablecontroller failover on the subnet. By de-fault, failover is enabled and the con-troller will failover when the standbycontroller has better connectivity to thesubnet. Can be performed on a datasubnet using the FC protocol.

[--failover {enable | disable}]



Power UserModify the specified subnet. Specify atleast one suboption.

subnet_label--edit

Modify the label for the specified subnet.[--new_label new_label]

Modify the subnet address, expressed inCIDR format.

[--subnet_addr network / netmask]

Modify the subnet discovery IP address.[--discovery_ipaddr ipaddr]

Modify the subnet type. You can specifymultiple types by using a comma-sepa-rated list.

[--type {mgmt | data | mgmt,data}]

Modify the subnet subtype for a subneton an iSCSI array. You can specify multi-ple subtypes by using a comma-separat-ed list.

[--subtype {iscsi | group}]

Modify the Network Affinity Zone typefor a subnet on an iSCSI array.

[--netzone_type {evenodd | bisect | sin-gle}]

Modify the network configuration withwhich the subnet is associated.

[--netconfig name]

Modify the VLAN ID for the subnet. Validvalues are in the 1-4094 range, inclusive.

[--vlanid id]

Modify the MTU for the subnet. Validvalues are in the 512-16000 range, inclu-sive.

[--mtu mtu]

Update the discovery IP address for theactive network configuration.

[--force_ip_update]

Ignore inconsistent network configura-tions for replication partners when edit-ing the specified subnet.

[--force_repl]

Ignore initiator groups assigned to sub-nets in the active network configurationwhen editing the specified subnet.


Specify whether to enable or disablecontroller failover on the subnet. By de-fault, failover is enabled and the con-troller will failover when the standbycontroller has better connectivity to thesubnet. Can be performed on a datasubnet using the FC protocol.

[--failover {enable | disable}]



Power UserRemove the specified subnet.subnet_label--remove

Specify the network configuration fromwhich to remove the subnet.


Ignore inconsistent network configura-tions for replication partners when remov-ing the specified subnet.

[--force_repl]

Remove the specified subnet and updatethe discovery IP address for the activenetwork configuration.

[--force_ip_update]

Ignore the NIC assigned to the specifiedsubnet in the active network configura-tion.

[--force_unassign_nics]

Ignore initiator groups assigned to sub-nets in the active network configurationwhen removing the specified subnet.


Examples

This example lists configured subnets on a iSCSI 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.102.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

support

The support command allows you to manage temporary passwords for support access.

Synopsis

support --help

support[--info][--show_ciphertext {array_name | SN}][--cycle]

Options

Table


AdminShow usage information forthe command.

N/A[--help]

AdminShow enabled parameters.N/A[--info]

AdminShow array information andciphertext blobs for all secureaccounts on the defined array.

{array_name | SN}[--show_ciphertext]

AdminCycle the support passwordsfor all support accounts on allarrays in the group.

[--cycle]

Examples

These examples show the support command output. The output may be truncated to save space and prevent line wrapping.

This example show the read secure password mode:

Nimble OS $ support --infoPassword mode: ciphertext


This example shows the ciphertext successfully displayed:

Nimble OS $ support --show_ciphertext sbillimor-vma-2Name: c20-array1Serial: AC-100159Model: CS210User: rootBlob:--- Begin tpd blob ---0500898410055e2c5c33b584b1a80e082f333d2de6e2cb...--- End tpd blob ---User: nsupportBlob:--- Begin tpd blob ---05003132141f9033951a903513b153156bef9351df8351...--- End tpd blob ---

timezone

The timezone command options manage time zone settings.

Synopsis

timezone --help

timezone --list

timezone --set zone_name

Options



N/A--help

GuestList all valid time zones for the Nimblearray.

N/A--list

Power UserSet the specified time zone on an array.Use timezone --list to get a list of validzone_name values.

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/Calcutta


Asia/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

useradmin

The 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 text ][--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

Administra-tor

List either all user accounts or user ac-counts that are assigned to the specifiedrole.

[--role {administrator | poweruser | oper-ator | guest}]

--list

GuestShow either detailed information aboutthe logged-in user if you specify yourown user_name or any specified user ifyou are logged in as a user who is as-signed to the Administrator role.

user_name--info

Administra-tor

Add an account for the specified user.The user_name must be alphanumericand start with a letter, be 1 to 32 charac-ters, and contain no spaces.

user_nameadd

Specify a plain-text description of theuser account. The text can be blank orcan contain up to 255 characters. If thereare spaces in the description, enclose thetext in quotation marks.


Specify the full name of the user account.The text can be blank or start with a let-ter, contain up to 64 alphanumeric char-acters, dashes, underscores, or apostro-phes, no spaces, no periods.

[--full_name text]

Specify an email address for the user.[--email_addr email_address]

Specify the role the user has.[--role {administrator|poweruser|opera-tor|guest}]

Set the number of minutes that mustpass without any user activity before atimeout occurs and this user is loggedout. If you do not specify this option, thedefault of 30 minutes is used. The min-utes cannot exceed the inactivity timeoutset for the group.

[--inactivity_timeout minutes]



GuestModify information about the logged-inuser if you specify your own user_nameor any specified user if you are logged inas a user who is assigned to the Adminis-trator role. Specify at least one subop-tion.

user_name--edit

Modify the description of the specifieduser account. If there are spaces in thedescription, enclose the text in quotationmarks.


Modify the full name of the user account.[--full_name text]

Modify the email address of the user ac-count.

[--email_addr email_address]

Modify the number of minutes that mustpass without any user activity before atimeout occurs and this user is loggedout.


Administra-tor

Modify the role the user has. Logged-inusers cannot change their own role. Youmust be assigned to the Administratorrole to modify a user's role.

[--role {administrator | poweruser | oper-ator | guest}]

Administra-tor

Disable the specified user account.user_name--disable

Administra-tor

Enable the specified user account. Thisoption succeeds even if the account iscurrently enabled.

user_name--enable

Administra-tor

Remove the specified user account.user_name--remove

GuestModify either your own password if youdo not specify the optional --user optionor the password of the specified user ifyou are logged in as a user who is as-signed to the Administrator role and youdo specify --user. The new passwordvalue is case sensitive, must be at leasteight characters, must be different fromthe current password, and cannot includeleft or right square brackets ([ ]), amper-sands (&), semicolons (;), or back singlequotation mark (`).

[--user user_name]--passwd

Examples

This example lists the user accounts on anuseradmin 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_timeout90

This example modifies the password of the logged in user.

Nimble OS $ useradmin --passwdEnter current password:Enter new password:Retype new password:Nimble OS $

userauth

The userauth command manages Active Directory groups, users and domains.

Synopsis

userauth --help

userauth --list

userauth --info domain_name

userauth --join domain_name--domain_user domain_user_name[--ou ou_name][--computer_name computer_name][--netbios_name netbios_name


userauth --leave domain_name--domain_user domain_user_name[--force]

userauth --enable domain_name

userauth --disable domain_name

userauth --add_group group_name--domain domain_name[--role role][--description description][--inactivity_timeout minutes]

userauth --remove_group group_name--domain domain_name

userauth --edit_group group_name--domain domain_name[--role role][--description description][--inactivity_timeout minutes]

userauth --enable_group group_name--domain domain_name

userauth --disable_group group_name--domain domain_name

userauth --list_group--domain domain_name

userauth --info_group group_name--domain domain_name

userauth --test_group group_name--domain domain_name

userauth --test_user user_name--domain domain_name

Options


Administra-tor

Show usage information for the com-mand.

N/A--help

Administra-tor

List the Active Directory domains.--list

Administra-tor

Show detailed information about the do-main_name specified.

domain_name--info



Administra-tor

Join the specified Active Directory do-main.

domain_name--join

Name of the Active Directory user withprivileges to join the Active Directorydomain. This is a mandatory argument.

[ --domain_user domain_user_name]

Organization Unit, the location for thecomputer account on the Active Directo-ry server. If not specified, the default lo-cation is Computers.

[--ou ou_name]

The name of the computer account inthe domain controller on the Active Direc-tory server. If not specified, the defaultvalue is the last 15 characters of thegroup name of the array.

[--computer_name computer_name]

The netbios name for the Active Directo-ry domain. The default is the short nameof the domain name.

[--netbios_name netbios_name]

Administra-tor

Leave the specified Active Directory do-main.

domain_name--leave

The name of the Active Directory userwith privileges to join the Active Directo-ry domain. This is a mandatory argument.

[ --domain_user domain_user_name]

Forcibly leave an Active Directory do-main.

[--force]

Administra-tor

Enable the specified Active Directorydomain.

domain_name--enable

Administra-tor

Disable the specified Active Directorydomain.

domain_name--disable

Administra-tor

Add a group to the specified Active Direc-tory domain.

--domaindomain_name--add_group

The array role to assign to the users thatbelong to the Active Directory group. Ifnot specified, the default role is guest.The options are: {administrator|powerus-er|operator|guest}.

[--role role]

The description of the Active Directorygroup.

[--description description]

The amount of time that the user sessionis inactive before timing out in minutes.The inactivity timeout for Active Directo-ry groups cannot be more than the groupuser inactivity time-out for the array.


Administra-tor

Remove a group from the specified Ac-tive Directory domain.

--domaindomain_name--remove_group



Administra-tor

Edit a group on the specified Active Di-rectory domain.

--domaindomain_name--edit_group

Modify the role of the Active Directorygroup.

[--rolerole]

Modify the description of the Active Di-rectory group.

[--descriptiondescription]

Modify the user inactivity timeout for theActive Directory group.

[--inactivity_timeoutminutes]

Administra-tor

Enable a group on the specified ActiveDirectory domain. This is a mandatoryargument.

--domaindomain_name--enable_group

Administra-tor

Disable a group on the specified ActiveDirectory domain. This is a mandatoryargument.

--domaindomain_name--disable_group

Administra-tor

List the groups on the specified ActiveDirectory domain. This is a mandatoryargument.

--domaindomain_name--list_group

Administra-tor

List detailed information about a speci-fied Active Directory domain. This is amandatory argument.

--domaindomain_name--info_group

Administra-tor

The Active Directory domain that thegroup belongs to. This is a mandatoryargument.

--domaindomain_name--test_group

Administra-tor

The Active Directory domain that theuser belongs to. This is a mandatory ar-gument.

--domaindomain_name--test_user

Examples

This example lists the user accounts on an array.

Nimble OS $ userauth --list-------------------+------------------+---------+-Name Connection Status Enabled-------------------+------------------+---------+-win2k8r2ad.net Connected Yes

This example shows the current settings for the configured Active Directory Domains.

Nimble OS $ userauth --info win2k8r2ad.netActive Directory Domain Name: win2k8r2ad.netOrganizational Unit: AD default locationComputer Name: esc-sjc-array343Netbios Name: win2k8r2adStatus: Successfully connected to Domain Controller.

This example lists the groups on the specified Active Directory domain.

Nimble OS $ userauth --list_group --domain win2k8r2ad.net---------------------------+---------------+---------+----------------------


Name Role Enabled Description---------------------------+---------------+---------+----------------------eng-qa-security-admin administrator Yes

userpolicy

The userpolicy command enables administrators to set global security policies for a group.

Synopsis

userpolicy --help

userpolicy --edit --allowed_attemptsnum_allowed_attempts[--min_length minimum_length][--upper num_uppercase_chars][--lower num_lowercase_chars][--digit num_digits][--special num_special_chars][--previous_diff num_chars_change][--no_reuse num_no_reuse_last][--max_sessions num_max_group_sessions]

userpolicy --info

Options


GuestProvides program help.N/A--help

Administra-tor

Number of failed authentication attemptsallowed before your account is locked.

--allowed_attempts num_allowed_at-tempts

--edit

Minimum number of characters requiredfor a valid password.

[--min_length minimum_length]

Minimum number of uppercase charac-ters required for a valid password.

[--upper num_uppercase_chars]

Minimum number of lowercase charac-ters required for a valid password.

[--lower num_lowercase_char]

Minimum number of numerical charactersrequired for a valid password.

[--digit num_digits]

Minimum number of special charactersrequired for a valid password.

[--special num_special_chars]

Minimum number of characters that mustbe different from the previous password.

[--previous_diff num_chars_change]

The number of times that a passwordmust change before you can reuse an oldpassword.

[--no_reuse num_no_reuse_last]

Maximum number of user sessions for agroup.

[--max_sessions num_max_group_ses-sions]



Administra-tor

Displays information about the config-ured security policy.

N/A--info

usersession

The 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 session if youare logged in as a user with any roleother than Administrator or all user ses-sions if you are logged in as a user whois assigned to the Administrator role.

N/A--list

GuestShow either detailed information aboutthe current session for the logged-in userif you do not specify the optional --idoption or the specified user session if youdo specify --id. If you are logged in as auser who is assigned to the Administratorrole, you can specify something otherthan the current session by including the--id session_id option.

[--id session_id]--info

Administra-tor

End the specified user session. The useris not logged out, but cannot take anymore actions in that session. You cannotend the current user session. If you tryto, you see a message saying that theSession cannot commit suicide.

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 adminuser is also logged in from multiple separate sessions. The session ID (SID) is a hash (digest) rather than the real SID. TheSource IP Addr is the IP address of the computer from which the user logged in to the command line interface (CLI), the


graphical user interface (GUI), or both. A single user can have multiple user sessions. The Expiry Time (secs) is the numberof seconds until this session ends if no user action is taken. Any user action resets the clock.

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 thisexample is somewhat contrived, an administrator user can kill another admin session that is not the command-line interfacefrom which the kill action is initiated.

Nimble OS $ usersession--kill 9ukXV/OjUA0T/0mIcOxiZ6J53WM=

vcenter

Synopsis

The vcenter command options allow you to manage VMware extensions, and to add, edit, and delete the vCenter appserver.

vcenter --help

vcenter --list

vcenter --info vcenter_name

vcenter --register vcenter_name[--extension {web | vasa}]

vcenter --unregister vcenter_name[--extension {web | vasa}]

vcenter--status vcenter_name[--extension {web | vasa}]


vcenter --add name[--hostname {hostname | ipaddr}][--port_number port_number][--username user_name][--password password][--description description][--subnet_labelsubnet_label]

vcenter--edit vcenter_name[--namevCenter_name][--usernameuser_name][--passwordpassword][--descriptiondescription]

vcenter--removevcenter_name

Options



N/A--help

GuestList detailed information about a speci-fied VMware vCenter, and the status ofNimble Storage vCenter extensions in thevCenter.

N/A--list

GuestVMware vCenter and Nimble Storage'svCenter extensions status informationbased on vCenter name.

vcenter_name--info

Administra-tor

Register the extension with vCenter.vcenter_name--register

Extension to register the vCenter.[--extension {web | vasa}]

Administra-tor

Unregister the extension with vCenter.vcenter_name--unregister

Extension to unregister the vCenter.[--extension {web | vasa}]

OperatorStatus of an extension from the vCenter.vcenter_name--status

Extension to get the status.[--extension {web | vasa}]

Administra-tor

Add VMware vCenter for this group.--add

VMware vCenter name.--name

VMware vCenter server hostname or IPaddress.

[--hostname {hostname | ipaddr}]

VMware vCenter port number.[--port_number port_number]

VMware vCenter username.[--username user_name]

VMware vCenter user password.[--password password]

VMware vCenter description.[--description description]

Subnet label used for registration.[--subnet_label subnet_label]



Administra-tor

Edit vCenter attributes.vcenter_name--edit

VMware vCenter name to be edited.[--name vcenter_name]

Modify the VMware vCenter username.[--username user_name]

Modify the VMware vCenter user pass-word.

[--password password]

Modify the VMware vCenter description.[--description description]

Administra-tor

Remove specified vCenter server fromthis group.

vcenter_name--remove

Examples

This example changes the vcenter server password.

Nimble OS $ vcenter --edit vserver1 --username testuser --password testpass

This example lists all the vcenters on the array.

Nimble OS $ vcenter --list------------------+----------------+-------+---------------------------+-------------+----------------------------+------------Name Host Name Port UserName DescriptionRegistered Extensions Subnet Label------------------+----------------+-------+---------------------------+-------------+----------------------------+------------10.18.238.201 10.18.238.201 443 [email protected] [web, vasa]

mgmt-data10.18.238.248 10.18.238.248 443 [email protected] [web]

mgmt-data10.18.238.225 10.18.238.225 443 [email protected] [web, vasa]

mgmt-data

This example lists all the information about the specified vcenter, 10.18.238.201.

Nimble OS $ vcenter --info 10.18.238.201------------------+----------------+-------+---------------------------+-------------+---------------+--------------+-------------+-----------------Name Host Name Port UserName DescriptionSubnet Label Web Client Vasa Provider------------------+----------------+-------+---------------------------+-------------+---------------+--------------+-------------+-----------------10.18.238.201 10.18.238.201 443 [email protected]

mgmt-data Registered Registered

vm

The vm command options allow you to manage VMware VVOL-based virtual machines.

Synopsis

VM objects are added using VMware's New Virtual Machine wizard, but can be managed using NimbleOS.

vm--helpvm--list [--deleted] [--clone_parents]vm--info {name | id}vm--restore {name | id}vm--destroy {name | id}


Options



N/A--help

List VMware virtual machines.--list

Show only deleted virtual machines.--deleted

Include VMs that are clone parents.--clone_parents

{name | id}--info

Restore a deleted virtual machine.{name | id}--restore

Destroy a deleted virtual machine. Thiswill also delete the volumes that comprisethis VM.

{name | id}--destroy

This example lists all of the VMs on the array.

Nimble OS $ vm --list---------------------------------------+------+-----------+--------------------Name Type Deleted Time UntilCleanup---------------------------------------+------+-----------+--------------------RajVvolTest VVol No N/AproVm1 VVol No N/AtestVm3 VVol No N/Avm1 VVol No N/A

This example returns information about the specified VM, vm1.

Nimble OS $ vm --info vm1VM ID: 502570ce-7e48-d602-b1ee-37f1ab66c428VM name: vm1Volumes:

vm1vm1.vmdk

version

The version command options display the version of the NimbleOS (NOS) software that is installed on an array or a group ofarrays.

Synopsis

version --help

version[--array name]


Options



N/A--help

GuestSpecify the array for which to show ver-sion information. Use array--list to getvalid name values. If you do not specifythis option, then the version informationis for the 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 greyhound3.1.4.0-100755-opt

vmwplugin

The vmwplugin command options manage the NimbleOS plugin for the VMware vCenter.

Use the plugin to manage datacenter and datastore array-specific functions, such as cloning, creating, and managing datastoresthat reside on HPE Nimble Storage arrays. To install and use the VMware plugin, provide vCenter host and authenticationinformation.

Note: The plugin is not supported for multiple datastores that are located on one LUN, for one datastore that spansmultiple LUNs, or if the LUN is located on a non-HPE Nimble Storage array. For these conditions, use the vcentercommand.

Synopsis

vmwplugin --help

vmwplugin --list--username user_name--password password--server server[--port_number port_number]

vmwplugin --register--username user_name--password password--server server[--subnet_label subnet_label][--port_number port_number][--client {web|thick}]


vmwplugin --unregister--username user_name--password password--server server[--port_number port_number][--client {web|thick}]

Options



N/A--help

GuestList the VMware vCenter plugins.The --username, --password, and --serversuboptions are mandatory.

--list

Specify the username of an account thatcan access the plugin.

--username user_name

Specify the VMware vCenter passwordfor the specified username.

--password password

Specify the VMware vCenter fully quali-fied vCenter server name or IP address.

--server server

Specify the VMware vCenter port num-ber. If you do not specify this option, thedefault port number 443 is used.

[--port_number port_number]

Power UserRegister a VMware vCenter plugin.The --username, --password, and --serversuboptions are mandatory.

--register




--password password


--server server

Specify a subnet label to use for registra-tion. Example: mgmt-data. If you do notspecify this option, no subnet label isused.

[--subnetlabel subnet_label]



Specify whether to allow access to theVMware vCenter plugin through the web-based or thick (vSphere) client.

[--client {web|thick}]



Power UserUnregister a VMware vCenter plugin.The --username, --password, and --serversuboptions are required.

--unregister




--password password


--server server



Specify whether to remove access to theVMware vCenter plugin through the web-based or thick (vSphere) client.

[--client {web|thick}]

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 of 443 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

vol

The vol command options manage volumes.

Volumes are the basic storage units from which the total capacity of an array is apportioned. The array is sectioned intovolumes. The number of volumes per array depends on storage allocation. In the context of the HPE Nimble Storage array,the term volume and LU (logical unit) are synonymous and interchangeable. A number identifies each LU, so you might seethe term LUN used, too.

All vol commands that accept a volume name as an argument will accept an optional --pool argument to differentiate thosevolumes that have the same name but reside in different pools.

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 whether thevolume 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 change that initialencryption 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 can be slow when accessing encrypted volumes.

Synopsis

vol --help

vol --list[--pool pool_name][--folderfolder_name][--initiatorgrp igrp_name][--open_access][--agent_type {none|smis|vvol|openstack|openstackv2}][--moving][--cache_pinned {yes|no}][--deduped{yes|no}]

vol --info name[--pool pool_name][--verbose]

vol --create name--size mebibytes[--description text][--perfpolicy name][--cache_pinned {yes|no}][--thinly_provisioned {yes|no}][--limit percent][--start_offline][--apply_acl_to {volume|snapshot|both}][--chapuser user_name][--initiatorgrp group_name][--lun lun][--multi_initiator {yes|no}][--pool pool_name][--folder folder_name][--agent_type {none|smis}][--encryption_cipher {aes-256-xts|none}][--dedupe_enabled {yes|no}][--iscsi_target_scope {volume|group}][--iops_limit iops][--mbps_limit mbps]

vol --delete vol_name[--pool pool_name][--force]

vol --edit vol_name[--name new_name][--description text][--size mebibytes][--perfpolicy name][--cache_pinned {yes|no}][--readonly {yes|no}][--force]


[--thinly_provisioned {yes|no}][--limit percent][--multi_initiator {yes|no}][--agent_type { none|smis}][--dedupe_enabled {yes|no}][--iscsi_target_scope {volume|group}][--iops_limit iops][--mbps_limit mbps][--pool pool_name]

vol --online vol_name[--pool pool_name]

vol --offline vol_name[--pool pool_name][--force]

vol --snap vol_name--snapname name[--description text][--start_online][--allow_writes][--pool pool_name]

vol --restore vol_name--snapname snap_name[--pool pool_name]

vol --clone vol_name--snapname snap_name--clonename clone_name[--folder folder_name][--description text][--readonly {yes|no}][--thinly_provisioned {yes|no}][--limit percent][--start_offline][--apply_acl_to {volume|snapshot|both}][--chapuser user_name][--initiatorgrp group_name][--lun lun][--multi_initiator {yes|no}][--cache_pinned {yes|no}][--dedupe_enabled {yes|no}][--iops_limit iops][--mbps_limit mbps][--pool pool_name]

vol --assoc vol_name--volcoll name[--pool pool_name]

vol --dissoc vol_name[--pool pool_name][--force]


vol --addacl vol_name--apply_acl_to {volume|snapshot|both}[--chapuser user_name][--initiatorgrp group_name][--lun lun][--pool pool_name]

vol --removeacl vol_name[--apply_acl_to {volume|snapshot|both}][--chapuser user_name][--initiatorgrp group_name][--pool pool_name]

vol --claim vol_name[--partner partner_name][--pool pool_name]

vol --move vollist--dest_pool pool_name[--dest_folder folder_name][--pool pool_list]

vol --abort_move vol_name[--pool pool_name]

vol --assign_folder vol_name--folder folder_name[--pool pool_name]

Options



N/A--help



GuestList the volumes on the array where yourun the command.

--list

Limit the list of volumes to a specificstorage pool.

[--pool pool_name]

Limit the list of volumes to folders withthe specified name. If a pool is not speci-fied, the folder name can refer to multiplefolders (one in each pool). If a pool isspecified, the pool and folder names to-gether refer to a single folder.

[--folder folder_name

Limit the list of volumes to the specifiedinitiator group.

[--initiatorgrp igrp_name]

Limit the list of volumes to those thathave open access.

[--open_access]

Limit the list of volumes to the specifiedexternal management agent type. Thesmis agent type lists volumes on StorageManagement Initiative Specification(SMI-S) enabled hosts. The vvol agenttype lists virtual volumes. The openstackagent type lists volumes on Openstackenabled hosts. The openstackv2 agenttype lists volumes on Openstack V2 en-abled hosts. The none agent type is thedefault.

[--agent_type {none|smis|vvol|open-stack|openstackv2}]

Limit the list of volumes to volumes thatare moving to a different pool.

--moving

Limit the list of volumes that either are(yes) or are not (no) pinned in cache.

[--cache_pinned {yes|no}]

Limit the list of volumes to those thathave (yes) deduplicated data blocks, orvolumes that do not (no) have dedupli-cated blocks. Volumes with deduplicatedblocks include those that currently havededuplication enabled, or have haddeduplication enabled in the past.

[--deduped {yes|no}

GuestList detailed information about thespecified volume.

name--info

Display details of the volume in thespecified pool. The [--verbose] option isrequired if the volume name is notunique within the group.

[--pool pool_name]

Provide additional information about thespecified volume, including metadata andthe use of digests in iSCSI session.

[--verbose]



OperatorCreate a volume with the specified name.name--create

The size of the volume in mebibytes.--size mebibytes

Provide a description of the volume. Ifthere are spaces in the description, en-close the text in quotation marks.


Associate a performance policy with thevolume. If no performance policy isspecified, the performance policy named"default" is used. The only exception tothis is when a volume is created in afolder that has an --agent_type of smis.After the volume is created, the perfor-mance policy can be changed only toanother performance policy that has thesame block size as the volume.

[--perfpolicy name]

If set to yes, all the contents of the vol-ume are kept in flash cache. Pinning avolume in cache provides consistentperformance guarantees for all types ofworkloads. The amount of flash neededto pin the volume in cache is equal to thevolume quota.


Set the provisioning type of the volumeto thin. The space for a new volume isprovisioned immediately, and advertisedto initiators that support thin provision-ing. For thinly-provisioned volumes, asoft limit notification is set to initiatorswhen the volume space usage exceedsthe volume limits. The default is "yes".

[--thinly_provisioned {yes|no}]

Set a limit for the volume as a percentageof the volume size. If this option is notspecified, the default array volume limitis used to determine the limit for thisvolume.

[--limit percent]

Start with the volume set to offline. If thisoption is not specified, the default is tostart with the volume online.

[--start_offline]

Apply the specified access control list(ACL) to the volume, its snapshots, orboth. If this option is not specified, thedefault is to apply the ACL to both thevolume and its snapshots.

[--apply_acl_to {volume|snapshot|both}]

[--chapuser user_name]



Specify the name of a CHAP user whocan access a volume on an iSCSI array.CHAP users can be created with thechapuser command. If this option is notspecified, the default is to allow accessto any CHAP user. This option is not ap-plicable for Fibre Channel access.

Specify the name of the initiator groupto which to restrict access. If this optionis not specified, the default is no access.

[--initiatorgrp group_name]

Specify the logical unit number (LUN) toassociate with the volume for access byFibre Channel initiator groups. The validrange for LUNs is 0-2047. If the LUN isnot specified, the system generates one.This option is not applicable for iSCSIaccess.

[--lun lun]

For iSCSI Volume Target (VST), this op-tion specifies whether the volume andits snapshots can be accessed from mul-tiple initiators at the same time. The de-fault is "no".

For iSCSI Group Target (GST) or FibreChannel access, the attribute cannot beset, and vol --info always reports no.

[--multi_initiator {yes|no}]

Specify a storage pool to which to assignthe volume. Volume data is distributedacross arrays over which a specified poolis defined. If this option is not specified,the volume is assigned to the defaultpool.

[--pool pool_name]

Specify the name of the folder where thevolume will be created. If the --pool op-tion is specified, the folder must bepresent in that pool. Otherwise the foldermust be present in the default pool. Ifthe --folder is not specified, the volumeis created directly in the applicable pool.


Specify the external management agenttype. The default agent type is "none".

[--agent_type {smis|none}]

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



Specify the default cipher to use duringencryption for this volume. Overridingthe default value is allowed only whenthe --encryption_scope suboption of thegroup --edit command is set to "volume".If the overriding the default value is al-lowed, a value of "none" indicates no en-cryption. A value of "aes-256-xts" indi-cates the use of the AES-256-XTS cipher.

After the volume is created and encryp-tion is enabled, encryption on the volumecannot be changed.

Specifies whether the volume is to bededuplicated. The choice made mayoverride the setting of the performancepolicy chosen for the volume.

[--dedupe_enabled {yes|no}]

Specify whether the volume is to be ex-ported under iSCSI Group Target or iSCSIVolume Target, overriding the defaultsetting for the group.

[--iscsi_target_scope {volume|group}]

The limit for IOPS (input/output requestsper second) for the Quality of Service(QoS) policy or Storage Policy-BasedManagement for Virtual Volumes. To setthe IOPS limit to unlimited, enter "unlim-ited". This is the default. The minimumis 256.

If both --iops_limit and --mbps_limit arespecified, the --mbps_limit must not bereached before the --iops_limit.

[--iops_limit iops]

The limit for MiB/sec (mebibytes persecond) for the Quality of Service (QoS)policy or Storage Policy-Based Manage-ment for Virtual Volumes. The lowerbound is calculated as greater than orequal to the IOPS limit multiplied by thevolume block size. To set the throughputlimit to unlimited, enter "unlimited".

The minimum throughput that can bespecified is 1 MiB/sec. If this option is notspecified, the throughput limit is set tothe default of unlimited.

[--mbps_limit mbps]



Power UserDelete an existing volume. Before youcan delete any volume, you must set thevolume as well as its associated snap-shots offline, and disassociate any activeconnections. Deleting a volume that ismanaged by an external agent fails un-less the --force option is used.

vol_name--delete

Select the pool from which to delete thevolume. The pool option is required ofthe volume is not unique within thegroup.

[--pool pool_name]

Forcibly delete a volume that is managedby an external agent.

[--force]



OperatorModify the attributes of the volume.Specify at least one suboption.

vol_name--edit

Modify the volume name. This corre-spondingly changes the target name as-sociated with the volume.

[--name new_name]

Modify the description of the volume.[--description text]

Modify the volume size.[--size mebibytes]

Modify the performance policy that isassociated with the volume. The newperformance policy must have a blocksize that matches the block size of theperformance policy already associatedwith the volume.

[--perfpolicy name]

Modify whether to keep all the contentsof this volume in flash cache. This allowsfor consistent performance guaranteesfor all types of workloads. The amountof flash needed to pin the volume isequal to the quota for the volume.


Enter yes to enable read-only access tothe volume, or no to enable read andwrite access to the volume.

[--readonly {yes|no}]

Forcibly set the volume to read-onlywhen there are connected initiators, orwhen reducing the size of the volume.

[--force]

Modify the provisioning type of the vol-ume. The space for the volume is provi-sioned immediately, but for advertisingstatus, the change takes effect only fornew connections to the volume. Existinginitiators must disconnect and reconnectfor the new setting to take effect. A softlimit notification is set to initiators whenthe volume space usage exceeds thevolume limits.


Modify the volume limit.[--limit percent]

For the iSCSI access protocol, this optionspecifies whether the volume and itssnapshots can be accessed from multipleinitiators at the same time. For the FibreChannel access protocol, this attributecannot be set, and vol --info always re-ports "yes".


Modify the external management agenttype.

[--agent_type {smis|none}]




Modify whether the volume is to bededuplicated. The setting overrides thesettings of the performance policy asso-ciated with the volume.

Modify whether the volume is to be ex-ported under iSCSI Group Target or iSCSIVolume Target.

[--iscsi_target_scope {volume|group}]

The limit for IOPS (input/output requestsper second) for the Quality of Service(QoS) policy or Storage Policy-BasedManagement for Virtual Volumes. To setthe IOPS limit to unlimited, enter "unlim-ited". This is the default. The minimumis 256 requests.


[--iops_limit iops]

The limit for MiB/sec (mebibytes persecond) for the Quality of Service (QoS)policy or Storage Policy-Based Manage-ment for Virtual Volumes. The lowerbound is calculated as greater than orequal to the IOPS limit multiplied by thevolume block size. To set the limit to un-limited, enter "unlimited". The minimumthroughput that can be specified is 1MiB/sec. If this option is not specified,then the throughput limit is set to thedefault of unlimited.

[--mbps_limit mbps]

Edit the volume in the specified pool. The--pool option is required if the volumename is not unique within the group.

[--pool pool_name]

OperatorSet the volume online. Setting a volumeonline allows initiators to connect to itand allows writes.

volume_name--online

Online the volume in the specified pool.The --pool option is required if the vol-ume is not unique within the group.

[--pool pool_name]



OperatorSet the volume offline. Setting a volumeoffline prevents initiators from connect-ing to it. Setting the volume offline failsif there are open connections from initia-tors or a virtual volume is bound to aprotocol endpoint, unless the --force isused.

volume_name--offline

Forcibly set the specified volume offline,even if there are open connections frominitiators. This action effectively disablesthe volume.

--force

Offline the volume in the specified pool.The --pool option is required if the vol-ume is not unique within the group.

[--pool pool_name]

OperatorSnapshot the specified volume.vol_name--snap

Specify the name of the snapshot tocreate.

--snapname name

Provide a description of the snapshot. Ifthere are spaces in the description, en-close the text in quotation marks.


Start the snapshot online. By default,snapshots are set offline when they arecreated.

[--start_online]

Allow applications to write to the snap-shot. By default, writes are disallowed.

[--allow_writes]

Pool in which the volume resides. The--pool option is required if the volumeis not unique within the group.

[--pool pool_name]

Power UserRestore a volume from one of its snap-shots. The volume must be taken offlinebefore it can be restored. A snapshot ofthe volume is taken before restoring thevolume to facilitate restoring to an earlierpoint in time, if needed.

vol_name--restore

Specify the snapshot from which to re-store the volume.

--snapname snap_name

Select thee volume in the specified poolto be restored. the --pool option is re-quired if the volume name is not uniquewithin the group.

[--pool pool_name]



OperatorClone a volume from one of its snapshotsto create a new volume. You can useclones to restore corrupt volumes or tocreate an environment for testingchanges.

vol_name--clone

Name of the snapshot to use to createthe clone.

--snapname snap_name

The name for the new, cloned volume.--clonename clone_name

The name of the folder in which thecloned volume will reside. The foldermust be in the same pool as the originalvolume. If this option is not specified, thecloned volume is placed in the samefolder as the original volume.


Provide a description of the cloned vol-ume. If there are spaces in the descrip-tion, enclose the text in quotation marks.


Set the clone to be a read-only orread/write volume.

[--readonly {yes|no}]

Set the provisioning type of the clone tothin. The space for the clone is provi-sioned immediately and advertised toinitiators that support thin provisioning.The default is "yes".


Specify the limit for the cloned volumeas a percentage of the volume size.

[--limit percent]

Set the cloned volume offline. By default,clones are set online when you createthem.

[--start_offline]

Apply a specified access control list tothe cloned volume, its snapshots, or both.If this option is not specified, the defaultis to apply the ACL to both.

[--apply_acl_to {volume|snapshot|both}]

Specify the name of a CHAP user whocan access this cloned volume on aniSCSI array. If this option is not specified,the default is to allow access to anyCHAP user. This option does not applyto volumes with Fibre Channel access.


Specify the name of the initiator groupto which to restrict access. If this optionis not specified, access is allowed to anyinitiator group.


[--lun lun]



Specify the logical unit number (LUN) toassociate with the cloned volume for ac-cess by Fibre Channel initiator groups.The valid range of values for LUN is 0-2047. If this option is not specified, thesystem generates one. This option is notapplicable to volumes with iSCSI access.

For iSCSI access, this option specifieswhether the volume clone and its snap-shots can be accessed from multiple ini-tiators at the same time. The default isto match the setting to that of the parentvolume. For Fibre Channel access, thisattribute cannot be set, and vol --info al-ways reports "no".


If set to yes, all contents of the clonedvolume are kept in flash cache. This al-lows for consistent performance guaran-tees for all types of workloads. Theamount of flash needed to pin the clonedvolume is equal to the limit for the vol-ume plus the size of the snapshot it iscloned from.


If set to yes, the cloned volume uses thededuplication setting specified, insteadof inheriting the deduplication settingfrom its parent volume.


The limit for IOPS for the QoS policy orStorage Policy-Based Management forVirtual Volumes for the cloned volume.The default value is the IOPS limit of theparent volume. To set the IOPS limit tounlimited, enter "unlimited". The mini-mum is 256.


[--iops_limit iops]

The throughput limit for the cloned vol-ume in mebibytes (MiB/sec). To set thethroughput limit to unlimited, use "unlim-ited". The default is the throughput limitof the parent volume. The minimumthroughput value is 1.

[--mbps_limit mbps]

Select the volume to be cloned from thespecified pool. The --pool option is re-quired if the volume name is not uniquewithin the group.

[--pool pool_name]



OperatorAssociate a volume with a volume collec-tion.

vol_name--assoc

The volume collection with which to as-sociate the volume.

--volcoll name

Associate a volume in the specified poolwith the volume collection. The --pooloption is required if the volume name isnot unique within the group.

[--pool pool_name]

OperatorDisassociate a volume from a volumecollection. When a volume is disassociat-ed from a volume collection, any snap-shots of the volume are not deleted whenthe corresponding snapshot collection isdeleted, either manually or per-retention-policy for the protection schedule bywhich they are managed.

vol_name--dissoc

Disassociate a volume in the specifiedpool from a volume collection. The --pooloption is required if the volume name isnot unique within the group.

[--pool pool_name]

Forcibly disassociate a volume managedin the context of a vCenter volume collec-tion.

--force

OperatorAdd an access control list (ACL) recordto the volume.

volume_name--addacl

Apply the access control list to the vol-ume, its snapshots, or both. If this optionis not specified, the default action is toapply the ACL to both the volume andits snapshots.

--apply_acl_to {volume|snapshot|both}

Specify the CHAP user to restrict accessto. This option does not apply to volumeswith Fibre Channel access.


Name of the initiator group to which torestrict access.


Specify the logical unit number (LUN) toassociate with this volume for access bya Fibre Channel initiator group. ValidLUNs are in the 0-2047 range. If notspecified, the system generates a num-ber. This option does not apply to vol-umes with iSCSI access.

[--lun lun]

Add an access control record to the vol-ume in the specified pool. The --pooloption is required if the volume name isnot unique within the group.

[--pool pool_name]



OperatorRemove an access control list recordfrom the specified volume.

vol_name--removeacl

Remove the access control list recordfrom the volume, its snapshots, or both.If this option is not specified, the defaultis to remove it from both.

--apply_acl_to {volume|snapshot|both}

Remove the access control record for thespecified CHAP user. This option doesnot apply to volumes with Fibre Channelaccess.


Remove the access control record for thespecified initiator group.


Remove access control record from thevolume in the specified pool. The --pooloption is required if the volume name isnot unique within the group.

[--pool pool_name]

Power UserClaim ownership of the specified volume.Claiming ownership of a volume allowsthe new owner to modify volume at-tributes. For example, when a replicavolume is disassociated on an upstreamarray, the volume ownership for thereplica stays with the upstream array. Tomodify the volume on the local system,claim ownership. Note that --claim workson volumes that are not in a volume col-lection. For volumes in a collection, usevolcoll --promote.

Note: The claim commanddoes not apply to synchronousreplication, because both thesource and destination volumesare in the same group.

vol_name--claim

Claim the volume in the specified pool.The --pool option is required if the vol-ume name is not unique within the group.

[--pool pool_name]



Power UserMove the specified list of volumes, anyrelated volumes and their snapshots, tothe specified destination pool. Relatedvolumes are those that share data blocks,and therefore include any volume whichhas a clone or parent relationship withthe specified volumes, either directly orindirectly. Multiple volumes may bespecified using a comma-delimited list.

Volume moves can take a long time, de-pending on the number of volumes andsnapshots being moved, and the overalldata use across the volumes and snap-shots. Use vol --info to monitor the move.

Use the --assign_folder option to assigna volume to a folder in the same pool.

vollist--move

The name of the destination pool for thevolumes. The destination pool must havesufficient space to accommodate thecurrent usage and reserves of all thevolumes being moved. The destinationpool also must be under the limit for thenumber of volumes in a pool.

--dest_pool pool_name

The name of the destination folder forthe volumes. If not specified, the volumeswill be contained directly by the destina-tion pool.

[--dest_folder folder_name]

List of source pools corresponding to thevolumes in the volume list. This optionis required if one or more volumes in thevolume list are not unique within thegroup. If the pool list is specified, thecount of entries in the pool list mustequal the count of entries in the volumelist. Multiple pools can be specified usinga comma-separated list.

[--pool pool_list]

Power UserStop an in-progress move of the speci-fied volume to another pool. Any datawhich has already been moved to thedestination pool would need to be movedback to the source pool. Once this opera-tion is initiated, it can take a long time,depending on the amount of data trans-ferred to the destination pool before themove was stopped.

vol_name--abort_move

Source pool of the volume that was inthe process of moving. The --pool optionis required if the volume name is notunique within the group.

[--pool pool_name]



Assign a volume to a folder in the samepool. If the volume is already in thespecified folder, no action is taken. If nofolder is specified, the folder assignmentof the volume is removed. Use the--move option to move a volume and anyrelated volumes to another pool.

vol_name--assign_folder

Name of the folder. The folder must bein the same pool as the volume.

--folder folder_name

Pool in which the volume resides. The--pool option is required if the volumename is not unique within the group.

[--pool pool_name]

Examples

This example lists all volumes on an array.

Nimble OS $ vol --list--------------------+----------+------+-----------+----------+---------+-------+---------Name Size Online Offline Usage Reserve % Limit% Path

(MB) Reason (MiB)--------------------+----------+------+-----------+----------+---------+-------+---------AppAD01 87041 No Replica 11179 0.00 100.00default:/AppE2K7Node2 153600 No Replica 63550 0.00 100.00default:/EX03-Exchange 512000 Yes N/A 63325 0.00 100.00default:/EX03-ExchangeLog 102400 Yes N/A 23049 0.00 100.00default:/itbackup 1048576 Yes N/A 301628 0.00 100.00default:/share 2097152 Yes N/A 781912 0.00 100.00default:/vcenterbackup 102400 Yes N/A 41024 0.00 100.00default:/

This example shows detailed information about a volume named public that is configured on an iSCSI array. The output istruncated 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 Server


Block 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 Fibre Channel array. Theoutput 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 case the volume mustbe 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 read only.

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 snapshot writable.

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 therestored 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, and then verifies thesuccess of the operation.

Nimble OS $ vol --list--------------------+----------+------+-----------+----------+---------+-------Name Size Online Offline Usage Reserve % Quota%

(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"

Nimble OS $ vol --list--------------------+----------+------+-----------+----------+---------+-------Name Size Online Offline Usage Reserve % Quota%

(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 volume named 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 volume named publicvol, andthen shows the ACL definitions. The vol --info output is truncated to save space and prevent 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 publicvol on an iSCSIarray.

Nimble OS $ vol --removeacl publicvol --apply_acl_to volume --chapuser nimblechap

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

Use the --moving option to view the status of volumes in the process of moving.

This example stops the in-process move of a volume named publicvol.

Nimble OS $vol --abort_move publicvol

volcoll

The volcoll command and its options manage volume collections. Volume collections are logical groups of volumes that shareprotection characteristics, such as snapshot and replication schedules. Volume collection names are case-sensitive.

You can create volume collections or base them on predefined protection templates. Snapshots for all volumes in a collectionare captured synchronously to ensure that the data across these volumes is mutually consistent. Volumes in a collection sharesnapshot and replication schedules as well as the retention policies for those snapshots. Similarly, during disaster recovery,all volumes in a volume collection simultaneously fail over to the replica array as a group. You need to create a volume collectionfor each application.

Volume collections may include multiple schedules. When schedules overlap, snapshots, or replicas, are created for everyschedule. Schedules affect all volumes that are assigned to the volume collection. Volume collections can have up to twodownstream replication partners.

Synopsis

volcoll --help

volcoll --list[--replication_type {periodic_snapshot | synchronous}]

volcoll --info name

volcoll --create name--prottmpl name[--description text]--app_sync {none | vss | vmware | generic} [--app_server server][--app_id {exchange | sql2005 | sql2008 | sql2012 | exchange_dag | sql2014 | sql2016 | hyperv}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username user_name][--vcenter_password password][--replication_type {periodic_snapshot | synchronous}][--agent_hostname server][--agent_username user_name]


[--agent_password password]

volcoll --delete name

volcoll --edit volcoll_name[--name new_name][--description text][--app_sync {none | vss | vmware | generic}][--app_server server][--app_id {exchange | sql2005 | sql2008 | sql2012 | exchange_dag | sql2014 | sql2016 | hyperv}][--app_cluster_name cluster_name][--app_service_name service_name][--vcenter_hostname server][--vcenter_username user_name][--vcenter_password password][--agent_hostname server][--agent_username user_name][--agent_password password]

volcoll --delete name

volcoll --validate name

volcoll --addsched 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}]

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


[--disable_appsync {yes | no}][--external_trigger {yes | no}][--non-interactive][--force]

volcoll --deletesched name--schedule name[--force]

volcoll --snap name--snapcoll_name name[--description text][--start_online][--allow_writes][--replicate][--replicate_to partner]][--disable_appsync {yes | no}][--external_trigger {yes | no}][--snap_verify {yes | no}][--skip_db_consistency_check {yes | no}]

volcoll --promote name

volcoll --demote volcoll--partner name[--non_interactive]

volcoll --handover name--partner name[--no_reverse][--abort][--override_upstream_down][--non_interactive]

volcoll--stop_repl name--schedule name

Options



N/A--help

GuestList volume collections.[--replication_type {periodic_snapshot |synchronous}]

--list

GuestProvide detailed information about thespecified volume collection, type ofreplication, and its schedules. Volumecollection names are case-sensitive.

name--info



OperatorCreate a volume collection.name--create

Use a specific protection template as abasis for defining protection-related at-tributes of the volume collection. If otheroptions are specified, those options thenoverride attributes that have been de-rived from a protection template. Anychanges to the protection template thatoccur after the volume collection is creat-ed do not affect any protection attributesof this collection.

--prottmpl name

Enter a plain-language description of thevolume collection. If there are spaces inthe description, enclose the text in quo-tation marks.


Define the application synchronizationto apply. If you specify VSS synchroniza-tion, supply the --app_* credentials. If youspecify VMware synchronization, supplythe --vcenter_* credentials. If you havecreated a custom agent, specify thegeneric app type when creating a volumecollection.


Specify the application server when VSSsynchronization is enabled.


Define the application running on theserver when VSS synchronization is en-abled, including MS-Hyper-V. ExchangeDAG specifies that it is a Microsoft Ex-change Server 2010 or later supportingDatabase Available Group.


Specify the cluster name if the applica-tion that uses VSS synchronization isrunning within a Windows clustering en-vironment.


Specify the instance name of the[--app_service_name service_name]

Specify the host name of the vCenterserver with which the Nimble array willcommunicate when VMware synchroniza-tion is enabled. A custom port numbercan be specified with vCenter using ":".


Specify the Windows user name to useto create a Nimble account on the vCen-ter server when VMware synchronizationis enabled.

[--vcenter_username user_name]

Specify the password associated with theuser name when VMware synchroniza-tion is enabled.

[--vcenter_password password]



[--replication_type {periodic_snapshot |synchronous}]

Specify the replication type. The defaultis periodic snapshot.

Specify a backup agent host name. Acustomer port number can be specifiedwith vCenter using ":".

--agent_hostname server

Specify a backup agent user name.--agent_username user_name

Specify the password associated with thebackup agent user name.

--agent_password password



OperatorModify the specified volume collection.New volume collections based on thetemplate are affected by the modifica-tions, but existing volume collections arenot. Specify at least one suboption.

Note: For synchronous replica-tion, you cannot convert a vol-ume collection that was config-ured from one form of replica-tion to another form of replica-tion.

volcoll_name--edit

Modify the name of the volume collec-tion.

[--name new_name]

Modify the plain-language description ofthe volume collection.


Modify the replication priority level.--repl_priority {normal|high}

Modify the application synchronizationto apply.

--app_sync {none|vss|vmware}

Modify the application server for VSSsynchronization.


Modify the application running on theserver for VSS synchronization, includingMS-Hyper-V.


Modify the cluster name if the applicationthat uses VSS synchronization is runningwithin a Windows clustering environ-ment.


Modify the instance name of the serviceif the application that uses VSS synchro-nization is running within a Windowsclustering environment.


Modify the host name of the vCenterserver with which the Nimble array com-municates for VMware synchronization.


Modify the Windows user name forVMware synchronization.

[--vcenter_username user_name]

Modify the password associated with theuser name for VMware synchronization.

[--vcenter_password password]

Modify the backup agent host name.[--agent_hostname server]

Modify the backup agent user name.[--agent_username user_name]

Modify the password associated with thebackup agent user.

[--agent_password ]



Power UserDelete the specified volume collection.Disassociate all volumes from the volumecollection using the vol --dissoc beforedeleting the volume collection.

name--delete

Validate a volume collection with eitherMicrosoft VSS, VMware, or generic appli-cation synchronization.

name--validate



OperatorCreate a protection schedule and add itto the specified volume collection.

name--addsched

Specify the name of the snapshotschedule to associate with this volumecollection.

--schedule name

Specify the frequency of snapshots. Ifyou do not specify this option, the de-fault of 1 is used.

--repeat period

Specify the unit of time for --repeat todefine the frequency of snapshots. If youdo not specify this option, the defaultunit of days is used.

--repeat_unit {min-utes|hours|days|weeks}

Specify the time of day to start takingsnapshots. If you do not specify this op-tion, the default value of 12:00 (mid-night) is used.

[--at time]

Specify the time of day to stop takingsnapshots. This option is applicable onlywhen the repeat frequency is more thanone snapshot per day. If you do notspecify this option, the default value of11:59 (for snapshots taken every minute)is used.

[--until time]

Specify the days on which to take snap-shots unless the repeat unit is weeks.You can enter a comma-separated list ofdays, for example, Mon,Wed,Fri. If you donot specify this option, the default valueof all is used.

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

Specify the maximum number of snap-shots to keep. If the schedule includesreplication, the array retains the latestreplicated snapshot, which may exceedthe specified retention value. This isnecessary to ensure efficient replicationperformance.

[--retain number]

Specify the replication partner for repli-cated snapshots. Use the partner --createcommand on both arrays to configurereplication partners.

[--replicate_to pool_partner]

Specify which snapshots assigned to theschedule should be replicated. For exam-ple, setting this to 5 replicates every fifthsnapshot. If snapshots are replicated andyou do not specify this option, all snap-shots are replicated.


Specify the number of snapshots to re-tain on the replication partner.




[--alert_threshold hh:mm] If replicating a snapshot takes more thanthis amount of time to complete, an alertwill be generated. If you do not specifythis option, the default of 24 hours isused. Enter 00:00 to disable this alert.

Specify whether to run a verification toolon snapshots created by this schedule.Use this option with snapshot schedulesof a volume collection that has applica-tion synchronization. The tool used toverify snapshots depends on the type ofapplication. For example, if the applica-tion synchronization is VSS and the appli-cation ID is exchange, the eseutil tool isrun on the snapshots. If verification fails,the logs are not truncated.


Specify whether to skip consistencychecks for database files on snapshotscreated by this schedule. Use this optionwith snapshot schedules of a volumecollection that has application synchro-nization of VSS, the application ID is ex-change_dag, --snap_verify is set to yes,and --disable_appsync is set to no. Skip-ping consistency checks is only recom-mended if each database in a DAG hasmultiple copies.


Specify whether to disable application-synchronized snapshots and createcrash-consistent snapshots instead.


Specify whether to use an externallydriven schedule with no internal timersto create manual snapshots.




OperatorModify the specified schedule in thespecified volume collection. Specify atleast one suboption in addition to--schedule name.

volcoll_name--editsched

Specify the name of the snapshotschedule to modify.

--schedule name

Modify the name of the snapshot sched-ule.

[--name new_name]

Modify the frequency of snapshots.[--repeat period]

Modify the unit of time for --repeat todefine the frequency of snapshots.

[--repeat_unit {min-utes|hours|days|weeks}]

Modify the time of day to start takingsnapshots.

[--at time]

Modify the time of day to stop takingsnapshots.

[--until time]

Modify the days on which to take snap-shots unless the repeat unit is weeks.

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

Modify the maximum number of snap-shots to keep.

[--retain number]

Modify the replication partner for repli-cated snapshots.


Modify the number of snapshots as-signed to the schedule should be replicat-ed.


Modify the number of snapshots to retainon the replication partner.


Break synchronous replication for thespecified volume collection and presentdownstream volumes to the host orhosts. Use only if necessary during disas-ter recovery.

[use_downstream_for_DR]

Modify the replication alert threshold. Ifa snapshot takes more than this amountof time to complete, and alert is generat-ed. Enter 00:00 to disable the alert.


Modify whether to run a verification toolon snapshots created by this schedule.


Modify whether to skip consistencychecks for database files on snapshotscreated by this schedule.


Modify whether to disable application-synchronized snapshots and createcrash-consistent snapshots instead.





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

Do not prompt for confirmation.[--non_interactive]

Forcibly edit a protection schedule in avolume collection managed by vCenter.

[--force]

OperatorDelete a protection schedule of specifiedvolume collection. Existing snapshotscreated by this schedule are unaffectedand will no longer be subject to retentionor replication scheduling.

name--deletesched

Specify the snapshot schedule to delete.--schedule name

Forcibly delete a protection schedule ofa volume collection managed by vCenter.

[--force]



OperatorCreate a snapshot of volumes that areassociated with the specified volumecollection. All created snapshots areconsistent with each other. If the volumecollection is application synchronized(VMware or VSS), the volume snapshotsare synchronized with the application aswell. If application synchronization isdisabled for all protection schedules inthe collection, the snapshot is not takenand an error occurs.

name--snap

Specify the name of the snapshot collec-tion that is being created. The name isused for the snapshot as well as thesnapshot collection.

--snapcoll_name name

Supply a plain-language description ofthe snapshot collection. If there arespaces in the description, enclose thetext in quotation marks.


Specify whether to start the snapshotcollection in an online state. If you do notspecify this option, the snapshot collec-tion is started offline.

[--start_online]

Specify whether to allow applications towrite to the new snapshot collection. Ifyou do not specify this option, the snap-shot collection disallows writes.

[--allow_writes]

Specify whether to replicate the snapshotcollection and its members to a replica-tion partner. If you do not specify thisoption, the snapshot collection is notreplicated. If you do specify this option,create the replication partner using thepartner --create command.

[--replicate]

Enter the name of the partner to whichyou want to replicate the newly createdsnapshot collection. This must be one ofthe partners associated with the volumecollection. If the schedule for the volumecollection has multiple partners, you mustinclude this option.

[--replicate_to partner ]

Specify whether to disable application-synchronized snapshots and createcrash-consistent snapshots instead.


Specify whether to use an externallydriven schedule to take the snapshot in-stead of the Nimble-driven schedule.


Specify whether to run a verification toolon this snapshot collection.




Specify whether to skip consistencychecks for database files in this snapshotcollection.


Power UserTake ownership of the specified volumecollection. This option is used on adownstream replication partner. Thevolumes that are associated with thevolume collection are set to online, sothey are available for reading and writing.Replication is disabled on the affectedschedules and must be reconfigured ifneeded. Snapshot retention for the affect-ed schedules is set to the greater of thecurrent local or replica retention values.

Note: You cannot use thiscommand with synchronousreplication.

name--promote

Power UserRelease ownership of the specified vol-ume collection to the specified replicationpartner. The volumes associated with thevolume collection are set to offline anda snapshot is created. Full control overthe volume collection is then transferredto the new owner. You can use this op-tion following --promote to revert thevolume collection to its previously config-ured state. This operation does notmodify the configuration on the newowner array. The new owner array mustbe running to obtain its identity informa-tion.

Note: You cannot use thiscommand with synchronousreplication.

name--demote

Specify the replication partner that isgiven ownership of the volume collection.

--partner name

Do not prompt for confirmation of thisaction.

[--non-interactive]



Power UserGracefully transfer ownership of thespecified volume collection to the speci-fied replication partner. Ownership andfull control is given to the replicationpartner. The volumes that are associatedwith the volume collection are taken of-fline before the final snapshot is takenand replicated. Therefore, full data syn-chronization is ensured as part of thetransfer.

name--handover

Enter the name of the downstream part-ner. Ownership will be transferred to thisreplication partner.

--partner name

Do not automatically reverse the direc-tion of replication. If you do not specifythis option, the new owner begins toreplicate to the original array when thehandover completes.

[--no_reverse]

Cancel an in-progress handover.[--abort]

Allows a handover even if the upstreamsite is down.

[--override_upstream_down]

Do not prompt for confirmation of thisaction.

[--non-interactive]

Power UserDiscontinue replication for a protectionschedule of the specified volume collec-tion.

name--stop_repl

Specify the protection schedule to discon-tinue.

--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 lists the periodic snapshot volcolls.

Nimble Storage $ volcoll --list --replication_type periodic_snapshot--------------------+---------------+-------------------------------------------Volume Collection Application Owned ByName Synchronization--------------------+---------------+-------------------------------------------periodic-vc1 none g1a1periodic-vc2 none g1a1


periodic-vc3 none g1a1

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/AAssociated 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 the volume collection byusing 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 configureVSS application synchronization before you can validate synchronization using this command.

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 and sets theconfiguration not to reverse

Nimble OS $ volcoll --handover forreplication--partner array2 --no_reverse

This example stops replication for a schedule named everyotherhour on a volume collection named forreplication.

Nimble OS $ volcoll --stop_repl forreplication --schedule everyotherhour

This example shows creating a volume collection with app sync type generic:

Nimble OS $ volcoll --create gen-sync-test-vc1 --app_sync generic--agent_hostname 10.xx.xxx.xxx --agent_username Administrator --agent_passwordNim123#

This example shows creating a volume collection from a protection template:

Nimble OS $ volcoll --create gen-sync-test-vc2 --prottmpl gen-sync-test-prottmpl


This example shows editing volume collection while providing app sync type generic and its arguments:

Nimble OS $ volcoll --edit gen-sync-test-vc1 --agent_hostname 10.xx.xxx.xxx--agent_username admin

--agent_password Nim123

This example shows creating volume collection with an app id of hyperv:

Nimble OS $ volcoll --create MyVolColl --app_syncvss --app_server 10.xx.xx.xxx --app_id hyperv

witness

The witness command enables you to set up and manage the witness host configuration.

Synopsis

witness --help

witness --add --user username--password password--host {hostname|ipaddr1|ipaddr2|ipaddr..}--port rest_portnum

witness --info

witness --remove

witness --test

Options


Administra-tor

Show usage information for the com-mand.

N/A--help

Administra-tor

Login username of the witness. This mustbe a non-root that can login to the wit-ness host (mandatory).

--user username--add

Login password of the new witness.–password password

Host name or IP addresses of witness(mandatory).

--host {hostname|ipaddr1,ipaddr2,...}

Port number of witness. If not specified,default port is 5395.

--port rest_portnum

Administra-tor

List detailed information about the wit-ness configuration.

N/A--info

Administra-tor

Remove an existing witness configura-tion.

N/A--remove

Administra-tor

Test the witness configuration betweenthe array and the witness.

N/A--test


Regulatory Information

Regulatory Warnings

European Union (EU), Australia, New Zealand

Warning

This is a Class A product. In a domestic environment this product may cause radio interference in which case the user may berequired to take adequate measures.

Israel

Warning


Korea

Warning


Taiwan

Warning


Thailand

(Compliance Certification Only)

This telecommunication equipment is in compliance with NBTC requirements. (Applies to CS210, CS215, CS235, CS300,CS500, CS700 model arrays, including the ES1-Series expansion

shelf.)

Saudi Arabia

Nimble Storage product CS200, CS300, CS500, CS700 arrays, and ES1 expansion shelf models comply with the CITC TechnicalSpecification CITC IT001.

USA

Regulatory Information 219

This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of theFCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment isoperated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if notinstalled and used in accordance with the instruction manual, may cause harmful interference to radio communications.Operation of this equipment in a residential area is likely to cause harmful interference in which case the user is required tocorrect the interference at his own expense.


Command Reference - infosight.hpe.com

Documents

Transcript of Command Reference - infosight.hpe.com