SANtricity 11.8 Commands

SANtricity CLI docs

Get started

Command formatting

CLI structure

Structure of CLI commands

Interactive mode

CLI wrapper syntax

Downloadble SMcli parameters

Script command structure

Structure of a script command

Synopsis of script commands

Recurring syntax elements

Naming conventions

Format rules

Script commands

Windows PowerShell

Detailed error reporting

Add comments to a script file

Script command guidelines

Firmware compatibility levels

SMcli https mode

Volume group migration

Commands by category

Administrators commands

Alert configuration commands

Array configuration commands

Auto support commands

Mirroring commands

Performance tuning commands

Replication commands

Security commands

Storage monitor personnel commands

Volume configuration commands

Commands A-Z

A

activate asynchronous mirroring

activate storagearray firmware

activate synchronous mirroring

add array label

add certificate from array

add certificate from file

add drives to ssd cache

add volume asyncmirrorgroup

autoconfigure storagearray hotspares

autoconfigure storagearray

C

change ssd cache application type

check asyncmirrorgroup repositoryconsistency

check repositoryconsistency

check storagearray connectivity

check syncmirror

check volume parity

clear alldrivechannels stats

clear asyncmirrorfault

clear emailalert configuration

clear storagearray configuration

clear storagearray eventlog

clear storagearray firmwarependingarea

clear storagearray recoverymode

clear syslog configuration

clear volume reservations

clear volume unreadablesectors

create asyncmirrorgroup

create cgsnapimage consistencygroup

create cgsnapvolume

create consistencygroup

create diskpool

create hostgroup

create hostport

create initiator

create iscsiinitiator

create mapping cgsnapvolume

create mapping volume

create raid volume automatic drive select

create raid volume free extent based select

create raid volume manual drive select

create read only snapshot volume

create snapgroup

create snapimage

create snapshot volume

create snmpcommunity

create snmptrapdestination

create snmpuser username

create ssdcache

create storagearray directoryserver

create storagearray securitykey

create storagearray syslog

create syncmirror

create volume diskpool

create volumecopy

create volumegroup

D

deactivate storagearray feature

deactivate storagearray

delete asyncmirrorgroup

delete auditlog

delete certificates

delete cgsnapimage consistencygroup

delete consistencygroup

delete controller cacertificate

delete diskpool

delete emailalert

delete hostgroup

delete hostport

delete initiator

delete iscsiinitiator

delete sgsnapvolume

delete snapgroup

delete snapimage

delete snapvolume

delete snmpcommunity

delete snmptrapdestination

delete snmpuser username

delete ssdcache

delete storagearray directoryservers

delete storagearray keymanagementcertificate

delete storagearray loginbanner

delete storagearray syslog

delete storagearray trustedcertificate

delete volume from disk pool

delete volumegroup

diagnose asyncmirrorgroup

diagnose controller iscsihostport

diagnose controller

diagnose syncmirror

disable storagearray externalkeymanagement file

disable storagearray

download controller arraymanagementservercertificate

download controller cacertificate

download controller trustedcertificate

download drive firmware

download storagearray drivefirmware file

download storagearray firmware

download storagearray keymanagementcertificate

download storagearray nvsram

download tray configurationsettings

download tray firmware file

E

enable controller datatransfer

enable diskpool security

enable or disable autosupport individual arrays

enable storagearray externalkeymanagement file

enable storagearray feature file

enable volumegroup security

establish asyncmirror volume

export storagearray securitykey

G

getting started with authentication

getting started with external key management

getting started with internal key management

I

import storagearray securitykey file

L

load storagearray dbmdatabase

R

recopy volumecopy target

recover disabled driveports

recover sasport miswire

recreate storagearray mirrorrepository

recreate storagearray securitykey

reduce disk pool capacity

remove array label

remove asyncmirrorgroup

remove drives from ssd cache

remove lunmapping

remove member volume from consistency group

remove storagearray directoryserver

remove syncmirror

remove volume asyncmirrorgroup

remove volumecopy target

rename ssd cache

repair data parity

repair volume parity

replace drive replacementdrive

reset controller arraymanagementsignedcertificate

reset controller

reset iscsiipaddress

reset storagearray arvmstats asyncmirrorgroup

reset storagearray autosupport schedule

reset storagearray diagnosticdata

reset storagearray hostportstatisticsbaseline

reset storagearray ibstatsbaseline

reset storagearray iscsistatsbaseline

reset storagearray iserstatsbaseline

reset storagearray rlsbaseline

reset storagearray sasphybaseline

reset storagearray socbaseline

reset storagearray volumedistribution

resume asyncmirrorgroup

resume cgsnapvolume

resume snapimage rollback

resume snapvolume

resume ssdcache

resume syncmirror

revive snapgroup

revive snapvolume

revive volumegroup

S

save ...

save alldrives logfile

save alltrays logfile

save check volume parity job parity errors

save controller arraymanagementcsr

save controller arraymanagementsignedcertificate

save controller cacertificate

save controller nvsram file

save drivechannel faultdiagnostics file

save storage system diagnostic data

save storagearray arvmstats asyncmirrorgroup

save storagearray autoloadbalancestatistics file

save storagearray autosupport log

save storagearray configuration

save storagearray controllerhealthimage

save storagearray dbmdatabase

save storagearray dbmvalidatorinfo

save storagearray firmwareinventory

save storagearray hostportstatistics

save storagearray ibstats

save storagearray iscsistatistics

save storagearray iserstatistics

save storagearray keymanagementcertificate

save storagearray keymanagementclientcsr

save storagearray loginbanner

save storagearray performancestats

save storagearray rlscounts

save storagearray sasphycounts

save storagearray soccounts

save storagearray statecapture

save storagearray supportdata

save storagearray trustedcertificate

save storagearray warningevents

set ...

set asyncmirrorgroup

set autosupport https delivery method

set cgsnapvolume

set consistency group attributes

set consistencygroup addcgmembervolume

set controller dnsservers

set controller hostport

set controller iscsihostport

set controller ntpservers

set controller service action allowed indicator

set disk pool modify disk pool

set drive hotspare

set drive nativestate

set drive operationalstate

set drive securityid

set drive serviceallowedindicator

set drivechannel

set email smtp delivery method

set hostchannel

set iscsiinitiator

set iscsitarget

set session erroraction

set snapgroup enableschedule

set snapgroup increase decreaserepositorycapacity

set snapgroup mediascanenabled

set snapvolume converttoreadwrite

set snapvolume increase decreaserepositorycapacity

set snapvolume mediascanenabled

set snmpcommunity

set snmpsystemvariables

set snmptrapdestination trapreceiverip

set snmpuser username

set storagearray autoloadbalancingenable

set storagearray autosupport schedule

set storagearray autosupportmaintenancewindow

set storagearray autosupportondemand

set storagearray autosupportremotediag

set storagearray cachemirrordataassurancecheckenable

set storagearray controllerhealthimageallowoverwrite

set storagearray directoryserver roles

set storagearray directoryserver

set storagearray externalkeymanagement

set storagearray hostconnectivityreporting

set storagearray icmppingresponse

set storagearray isnsipv4configurationmethod

set storagearray isnsipv6address

set storagearray isnslisteningport

set storagearray isnsregistration

set storagearray isnsserverrefresh

set storagearray learncycledate controller

set storagearray localusername

set storagearray loginbanner

set storagearray managementinterface

set storagearray odxenabled

set storagearray passwordlength

set storagearray pqvalidateonreconstruct

set storagearray redundancymode

set storagearray resourceprovisionedvolumes

set storagearray revocationchecksettings

set storagearray securitykey

set storagearray syslog

set storagearray time

set storagearray traypositions

set storagearray unnameddiscoverysession

set storagearray usersession

set storagearray vaaienabled

set storagearray

set thin volume attributes

set tray attribute

set tray drawer

set tray identification

set tray serviceallowedindicator

set volume group attributes for volume in a volume group

set volume logicalunitnumber

set volume ssdcacheenabled

set volumecopy target

set volumegroup forcedstate

set volumegroup

show ...

show alldrives downloadprogress

show alldrives performancestats

show allhostports

show allsnmpcommunities

show allsnmpusers

show array label

show asyncmirrorgroup summary

show asyncmirrorgroup synchronizationprogress

show auditlog configuration

show auditlog summary

show certificates

show cgsnapimage

show check volume parity jobs

show consistencygroup

show controller arraymanagementsignedcertificate summary

show controller cacertificate

show controller diagnostic status

show controller nvsram

show controller

show drivechannel stats

show emailalert summary

show iscsisessions

show replaceabledrives

show snapvolume

show snmpsystemvariables

show ssd cache statistics

show storagearray autoconfiguration

show storagearray autosupport

show storagearray cachemirrordataassurancecheckenable

show storagearray controllerhealthimage

show storagearray dbmdatabase

show storagearray directoryservices summary

show storagearray hostconnectivityreporting

show storagearray hosttopology

show storagearray iscsinegotiationdefaults

show storagearray lunmappings

show storagearray odxsetting

show storagearray powerinfo

show storagearray revocationchecksettings

show storagearray syslog

show storagearray trustedcertificate summary

show storagearray unconfiguredinitiators

show storagearray unconfigurediscsiinitiators

show storagearray unreadablesectors

show storagearray usersession

show storagearray

show syncmirror candidates

show syncmirror synchronizationprogress

show syslog summary

show textstring

show volume actionprogress

show volume performancestats

show volume reservations

show volume summary

show volumecopy source targetcandidates

show volumecopy sourcecandidates

show volumecopy

show volumegroup exportdependencies

show volumegroup importdependencies

show volumegroup

smcli ...

smcli autosupportconfig show

smcli autosupportconfig test

smcli autosupportconfig

smcli autosupportlog

smcli autosupportschedule reset

smcli autosupportschedule show

smcli supportbundle schedule

start ...

start asyncmirrorgroup synchronize

start cgsnapimage rollback

start check volume parity job

start controller iscsihostport dhcprefresh

start controller

start diskpool fullprovisioning

start diskpool locate

start diskpool resourceprovisioning

start drive erase

start drive initialize

start drive locate

start drive reconstruct

start drivechannel faultdiagnostics

start drivechannel locate

start emailalert test

start increasevolumecapacity volume

start secureerase drive

start snapimage rollback

start snmptrapdestination

start ssdcache locate

start ssdcache performancemodeling

start storagearray autosupport deliverytest

start storagearray autosupport manualdispatch

start storagearray configdbdiagnostic

start storagearray controllerhealthimage controller

start storagearray directoryservices test

start storagearray externalkeymanagement test

start storagearray isnsserverrefresh

start storagearray locate

start storagearray ocspresponderurl test

start storagearray syslog test

start syncmirror primary synchronize

start syslog test

start tray locate

start volume initialization

start volume initialize

start volumegroup defragment

start volumegroup export

start volumegroup fullprovisioning

start volumegroup import

start volumegroup locate

start volumegroup resourceprovisioning

stop ...

stop asyncmirrorgroup rolechange

stop cgsnapimage rollback

stop cgsnapvolume

stop check volume parity job

stop consistencygroup pendingsnapimagecreation

stop diskpool locate

stop drive locate

stop drive replace

stop drivechannel faultdiagnostics

stop drivechannel locate

stop pendingsnapimagecreation

stop snapimage rollback

stop snapvolume

stop ssdcache locate

stop ssdcache performancemodeling

stop storagearray configdbdiagnostic

stop storagearray drivefirmwaredownload

stop storagearray iscsisession

stop storagearray locate

stop tray locate

stop volumecopy target source

stop volumegroup locate

suspend ...

suspend asyncmirrorgroup

suspend ssdcache

suspend syncmirror primaries

V

validate storagearray securitykey

to Japanese version

Structure of CLI commands

The CLI commands are in the form of a command wrapper and elements embedded into the wrapper. A CLI command consists of these elements:

A command wrapper identified by the term SMcli
The storage system identifier
Terminals that define the operation to be performed
Script commands

The CLI command wrapper is a shell that identifies storage system controllers, embeds operational terminals, embeds script commands, and passes these values to the script engine.

All CLI commands have the following structure:

SMcli *storageArray terminal script-commands*;

SMcli invokes the command line interface.
storageArray is the name or the IP address of the storage system.
terminal is a CLI value that defines the environment and the purpose for the command.
script-commands are one or more script commands or the name of a script file that contains script commands. (The script commands configure and manage the storage system.)

If you enter an incomplete or inaccurate SMcli string that does not have the correct syntax, parameter names, options, or terminals, the script engine returns usage information.