EMC® Navisphere® Analyzer Command Line Interface (CLI) : Reference
EMC® Navisphere® Analyzer Command Line Interface (CLI) : Reference
EMC® Navisphere® Analyzer Command Line Interface (CLI) : Reference
REFERENCE
P/N 300-004-210
REV A02
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Copyright © 2006-2007 EMC Corporation. All rights reserved.
EMC believes the information in this publication is accurate as of its publication date. The information is
subject to change without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATION MAKES NO
REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS
PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable
software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
Preface ..................................................................................................... 5
3
Contents
Index ...................................................................................................... 51
About this manual This manual describes the CLI commands you use to monitor
storage-system performance using EMC® Navisphere® Analyzer
software. Each major section includes introductory and format
information.
Audience This manual is intended for those who will use the naviseccli
command to monitor and tune CX3-series and CX-series disk-array
storage systems with analyzer. Readers of this guide should be
familiar with the following topics:
◆ The operating system running on the servers you will manage.
◆ Storage-system components and configurations.
5
Preface
Conventions used in EMC uses the following conventions for notes, cautions, warnings,
this guide and danger notices.
! CAUTION
A caution contains information essential to avoid data loss or
damage to the system or equipment.
Typographical conventions
This manual uses the following format conventions:
Finding current The most up-to-date information about the EMC Navisphere
information Analyzer CLI is posted on the EMC Powerlink® website. We
recommend that you download the latest information before you run
the CLI commands.
To access EMC Powerlink, use the following link:
http://Powerlink.EMC.com
Where to get help EMC support, product, and licensing information can be obtained as
follows.
Product information — For documentation, release notes, software
updates, or for information about EMC products, licensing, and
service, go to the EMC Powerlink website (registration required) at:
http://Powerlink.EMC.com
7
Preface
Your comments Your suggestions will help us continue to improve the accuracy,
organization, and overall quality of the user publications. Please send
your opinion of this guide to:
[email protected]
9
About EMC Navisphere Analyzer
Prerequisites
Analyzer requires the following:
◆ Navisphere Manager must be installed and enabled on at least
one of the storage systems in the storage-system domain that you
want to analyze.
CX300, CX500, CX700, and CX3-series storage systems ship from the
factory with Navisphere Manager preinstalled and enabled. CX200,
CX400, and CX600 storage systems ship from the factory with
Navisphere Manager preinstalled, but not enabled. To enable Navisphere
Manager, the manager enabler must be installed.
11
About EMC Navisphere Analyzer
This chapter explains the naviseccli command and the commands for
monitoring and measuring the performance of CX3-series and
CX-series disk-array storage systems with the analyzer option.
Note: If you currently use Java CLI to issue CLI commands, please note that
Secure CLI is replacing Java CLI; therefore, only Secure CLI will support new
features. We recommend that you use Secure CLI. Secure CLI is also faster
and more secure than Java CLI. Please refer to the Navisphere Command Line
Interface (CLI) Reference (P/N 300-003-628 Revision A02) for Java CLI support.
Note: The commands in this chapter function only with a storage system that
has the optional analyzer software installed.
Topics are:
◆ About Secure CLI ............................................................................... 14
◆ Getting started with Secure CLI....................................................... 15
◆ naviseccli ............................................................................................. 17
◆ analyzer -set ........................................................................................ 22
◆ analyzer -get........................................................................................ 24
◆ analyzer -logging ............................................................................... 25
◆ analyzer -start ..................................................................................... 26
◆ analyzer -stop ..................................................................................... 27
◆ analyzer -status................................................................................... 28
13
Analyzer CLI Commands
Note: Refer to the Host Agent/CLI and Utilities Release Notes, available on
the Powerlink website, for a list of supported operating systems. You must be
running FLARE ® Operating Environment version 02.19.xxx.5.yyy or higher.
Note: For commands that originated in Classic CLI, some command output
may be enhanced; for example, Secure CLI can retrieve and display
information from peer SPs. For Classic CLI commands that produce multiple
warnings and require multiple confirmations, Secure CLI provides a single
summary of warnings and a single confirmation. In general, Secure CLI
preserves original command syntax and output for script compatibility.
Secure CLI does not support commands targeted to host agents, such
as -lunmapinfo. For commands that you can issue to either an SP or
host agent, such as –getagent, if you issue the command to a host
agent, Secure CLI displays an error message. You must use Classic
CLI to issue commands to host agents. For a complete list of these
commands, refer to the EMC Navisphere Command Line Interface (CLI)
Reference.
Note: Secure CLI does not distinguish case of characters so, regardless of the
host operating system, you can use either uppercase, lowercase, or any
combination of characters as you type commands.
If a Secure CLI command fails and the CLI does not generate its own
error message, it displays an error message from the SP agent. Secure
CLI generates errors about command line syntax for commands and
switches and their values.
Secure CLI commands return 0 if the command is successful, or a
number greater than 0 if the command is unsuccessful.
15
Analyzer CLI Commands
For example, to add yourself to the security file on the current host,
given the alternative username altusername, the password mypass
and the scope 0 (global scope), type:
naviseccli -AddUserSecurity -password mypass -scope 0 -user
altusername
Then, on this host, you can enter CLI commands to any storage
system on which you have an account that matches the username
altusername, with password mypass and global scope (scope 0).
The security file is stored in your default home directory. With Secure
CLI, you can specify an alternative file path using the optional
-secfilepath switch.
Note: If you specify an alternative location for the security file, you must
specify the file path in every subsequent CLI command you issue to ensure
the CLI locates the security file.
naviseccli
Sends status or configuration requests to a storage system using
command line
User access Anyone who can log in to a server running Navisphere CLI 6.X or
later can use this command.
17
Analyzer CLI Commands
Note: If you specify the -user switch, you can create an alternative
username to your server login name in the security file you create on this
server. If you use the -secfilepath switch, you can specify an alternative
location to your default home directory for the security file on this server.
You must then use the -secfilepath switch in each subsequent command
you issue.
-f filename
Specifies to store data in the file filename.
-m
Suppresses output except for values. This switch is most useful
when used as part of a script.
-nopoll|-np
Directs the feature provider not to issue a poll request. This
switch significantly increases performance when dealing with
large or multiple storage systems. The feature provider
automatically polls unless this switch is specified.
Note: When the -nopoll switch is set, get commands may return stale
data and set commands may erase previously changed settings. Use
caution when the -nopoll switch is set.
-parse |-p
Directs the CLI to validate the command. The CLI verifies the
command syntax and displays a message stating whether the
command was valid. The CLI takes no other action.
-password password
Specifies the password on the storage system you want to log in
to. The password is visible in the command line. Passwords are
case-sensitive.
If you want to mask the password, and you are not using a
security file, you can omit this switch from the command line.
The CLI then prompts you to enter a password. The information
you enter into the password prompt is concealed.
Note: You can omit this switch if you are using a security file. See
-AddUserSecurity.
-port portnumber
Sets the port number (type) of the storage system. The default is
443. If you choose to change the default port number,
management port 2163 will be supported, however you must
specify the -port switch and number 2163 in every subsequent
command you issue.
-q
Suppresses error messages. This switch is useful when included
as part of a script.
-RemoveUserSecurity
Directs the CLI to remove user security information about the
current user from the security file on this server.
-scope 0|1|2
Specifies whether the user account on the storage system you
want to log in to is local, global, or lightweight directory access
protocol (LDAP). 0 (default) indicates global, 1 indicates local,
and 2 indicates LDAP.
19
Analyzer CLI Commands
Note: If you use the -secfilepath switch to set up an alternative path for
your security file, you must use this switch in every subsequent CLI
command you issue to ensure the CLI locates the security file.
Note: You can use this switch when establishing a security file to specify
an alternative username. See -AddUserSecurity.
-v
Enables verbose error descriptions. This is the default unless -q is
specified.
-xml
Specifies command output in XML format. Use the -o (override
switch) when specifying -xml with commands that require
confirmation. Otherwise, the XML output will contain your
confirmation string.
CMD
One of a set of commands used with the naviseccli command.
CMD switches The CMD switches are described on the pages that follow.
21
Analyzer CLI Commands
analyzer -set
Modifies the performance logging properties
Description The naviseccli analyzer command with the -set switch lets you
modify the performance logging properties.
User Access You must have a user account on the storage system on which you
want to execute the command. If one of the switches is specified, the
user account needs the administrator or manager role.
-default
Resets the values of all performance properties back to their
default values. It does not change the -nonstop or -logperiod
switch when performance logging is running.
You cannot specify -nonstop and -logperiod in the same command line. If
you do not specify any switches, you will get back the current values.
23
Analyzer CLI Commands
analyzer -get
Returns the current values of the performance logging properties
Description The naviseccli analyzer command with the -get switch lets you view
the current values of the performance logging properties for the
switch you specify.
User Access You must have a user account on the storage system on which you
want to execute the command.
Note: If you do not specify any switches, the analyzer -get command displays
all the current values.
analyzer -logging
Resets performance logging
Description The naviseccli analyzer command with the -logging switch lets you
reset performance logging.
User Access You must have a user account on the storage system on which you
want to execute the command. You need administrator or manager
privilges to use this command.
25
Analyzer CLI Commands
analyzer -start
Starts performance logging
Description The naviseccli analyzer command with the -start switch starts
performance logging. It turns on statistics logging if it is not on
already.
User Access You must have a user account on the storage system on which you
want to execute the command. You need administrator or manager
privileges to use this command.
analyzer -stop
Stops performance logging
Description The naviseccli analyzer command with the -stop switch stops
performance logging. It restores the statistics logging state to what it
was before logging was started.
User Access You must have a user account on the storage system on which you
want to execute the command. You need administrator or manager
privilges to use this command.
27
Analyzer CLI Commands
analyzer -status
Displays performance logging status
Description The naviseccli analyzer command with the -status switch lets you
see the current status of performance logging. Possible status
includes the following:
◆ Running. Started on date time
◆ Stopped
◆ Stopped on date time
User Access You must have a user account on the storage system on which you
want to execute the command.
Client Tools
This chapter describes the Analyzer client tools that you use with
naviseccli.
Topics include::
◆ analyzer -archive ................................................................................ 30
◆ analyzer -archivedump ..................................................................... 32
◆ analyzer -archiveretrieve .................................................................. 47
◆ analyzer -archivemerge..................................................................... 49
29
Client Tools
analyzer -archive
Manages archive files
Description The naviseccli analyzer command with the -archive switch lets you
list, retrieve, or delete one or more archive files from a SP. It retrieves
both the encrypted and decrypted archive files.
User Access You must have a user account on the storage system on which you
want to execute the command.
-new
Immediately creates a new archive file and output name for the
new archive file. If you cannot create a new archive file because
less than ten samples were collected, this switch returns the name
of the newest archive file.
-statusnew filename
Returns the status of the new archive file, filename, which you
created with the -new switch. The possible status is done or not
done.
Output
Index Size in KBLast ModifiedFilename
0 39 10/04/2006 16:07:24APM00035101236_SPA_2006-10-04_20-07-21-GMT_M05-00.nar
1 60 10/06/2006 10:39:56 APM00035101236_SPA_2006-10-06_14-39-56-GMT_M05-00.nar
2 114 10/06/2006 13:49:51 APM00035101236_SPA_2006-10-06_17-49-50-GMT_M05-00.nar
3 68 10/08/2006 12:12:42 APM00035101236_SPA_2006-10-08_16-12-42-GMT_M05-00.nar
4 68 10/08/2006 14:48:42 APM00035101236_SPA_2006-10-08_18-48-42-GMT_M05-00.nar
5 70 10/08/2006 17:24:42 APM00035101236_SPA_2006-10-08_21-24-42-GMT_M05-00.nar
6 70 10/08/2006 20:00:42 APM00035101236_SPA_2006-10-09_00-00-42-GMT_M05-00.nar
7 71 10/08/2006 22:36:42 APM00035101236_SPA_2006-10-09_02-36-42-GMT_M05-00.nar
8 70 10/09/2006 01:12:42 APM00035101236_SPA_2006-10-09_05-12-42-GMT_M05-00.nar
9 70 10/09/2006 03:48:42 APM00035101236_SPA_2006-10-09_07-48-42-GMT_M05-00.nar
10 71 10/09/2006 06:24:42 APM00035101236_SPA_2006-10-09_10-24-41-GMT_M05-00.nar
11 69 10/09/2006 09:00:42 APM00035101236_SPA_2006-10-09_13-00-42-GMT_M05-00.nar
12 72 10/09/2006 11:36:42 APM00035101236_SPA_2006-10-09_15-36-42-GMT_M05-00.nar
31
Client Tools
analyzer -archivedump
Dumps analyzer archive files
User Access The host, user/password and scope options of naviseccli are ignored
since this command runs locally.
where:
-data
Dumps data from archive files. You must provide the archive
filename following the -data command.
The optional switches are as follows:
-out filename
Dumps multiple files. Specify multiple output filenames
separated by commas. The output filenames list corresponds
to the dumped filename list.
You can dump multiple files into a single file using the -join switch.
-join
Appends the output from multiple files into a single file. The
header will be dumped only once if this switch is used and if
the header switch is enabled. This switch is valid only if you
specify multiple files. If you use this switch with the single file
following -data, the switch is ignored.
-overwrite y|n
Works with the -out switch. If you use the -overwrite switch
without the -out switch, it is ignored. The -overwrite switch
applies to all the output files if you specify multiple files to
dump.
y = Without a warning, overwrites the existing file specified
by the -out switch.
n = Displays an error message if the file that the -out switch
specified already exists.
-xml
Specifies the output in XML format. This switch is optional,
and you cannot use it with the -delim type. If you do not
specify the -xml switch, delimited output results. If you use it
with the -data command and the -format switch, an error
message appears.
33
Client Tools
-delim code
Specifies a delimiter that separates the output data. With this
switch, you can specify the output as delimited type. It is
optional and cannot be used with the -xml switch. Specify the
delimiter when you use this switch. If you do not specify
either -xml or -delim, delimited output results.
Delimiter Code
Comma (default) cm
Semicolon sc
Colon cl
Tab tb
Slash sl
Backslash bs
Period pd
White space ws
If you use a slash or a period as a delimiter, you must also use the
-enquote switch with an option other than None.
-enquote
Encloses each performance characteristic within a set of
special characters. By default, the special character None is
used. The possible special characters for the switch are listed
below:
None no
Quote qu
Apostrophe ap
Accent character ac
Use this switch only when you specify delimited as an output type
delimited.
-eol
Specifies a particular end-of-line character. The output reaches
an end of line when all performance characteristics for one
specific object at a particular time have been output. The
underlying client system determines the default end-of-line
character. The possible end-of-line characters for the switch
are listed below:
Carriage return cr
Line feed lf
Use this switch only when you specify delimited as an output type.
-header
Specifies whether to output a column header. This switch is
optional. If you do not specify the switch, by default, it
outputs a header.
y = Output a header
n = Do not output a header.
-object codes
Specifies the objects for which to collect performance statistics
and the order in which to output them.
SP s
LUN l
MetaLUN ml
Disk d
Snap session ss
35
Client Tools
Asynchronous mirror am
RAID group rg
Host h
Port p
-format codes
Specifies which performance characteristics to output and the
order in which they appear. The -format switch requires one
or more of the codes listed below. If you do not specify this
switch, all performance characteristics are output in the order
listed below:
37
Client Tools
Flush Ratio SP fr
39
Client Tools
Response Time –Optimal [ms] Response Time –Nonoptimal [ms] rto/rtn LUN, MetaLUN
Total Bandwidth–Optimal [MB/s] Total Bandwidth –Nonoptimal [MB/s] tbo/tbn LUN, MetaLUN
Total Throughput –Optimal [IO/s] Total Throughput–Nonoptimal [IO/s] tto/ttn LUN, MetaLUN
Read Bandwidth– Optimal [MB/s] Read Bandwidth–Nonoptimal [MB/s] rbo/rbn LUN, MetaLUN
Read Throughput –Optimal [IO/s] Read Throughput–Nonoptimal [IO/s] rioo/rion LUN, MetaLUN
Average Busy Queue Length–Optimal Average Busy Queue Length– abqlo/abqln LUN, MetaLUN
Nonoptimal
Service Time –Optimal [ms] Service Time–Nonoptimal [ms] sto/stn LUN, MetaLUN
LUN 2 HK192200361 A 0 0 0
41
Client Tools
-stime starttime
Specifies an archive poll time from which to start iterating
through the data. The -stime switch requires start time to be in
the following format:
mm/dd/yyyy hh:mm:ss
where:
mm is the month of a year (1-12)
dd is the day of a month (1-31)
yyyy is the four-digit year
hh is the hour of the day (0-23)
mm is the minute in an hour (0-59)
ss is the second in a minute (0-59). You must enclose the time
in double quotation marks.
The -stime switch works in combination with the -ftime
switch, described below. If the start time is greater than the
end time, an error message appears. If you do not specify a
start time, this switch defaults to the earliest poll time in the
archive file.
If you use the -stime switch with the -timezone switch, you must
apply the time zone you specify to the start time.
If the start time you specify does not exist in the time interval
of the archive file, an error message containing the valid time
range of the archive file appears. Also, if the start time format
is not valid, an error message appears.
-ftime endtime
Specifies an archive poll time from which to stop iterating
through the data. The -ftime switch requires end time to be in
the following format:
mm/dd/yyyy hh:mm:ss
where:
mm is the month of a year (1-12)
dd is the day of a month (1-31)
yyyy is the four-digit year
If you use the -ftime switch with the -timezone switch, you must
apply the time zone you specify to the end time.
If the end time you specify does not exist in the time interval
of the archive file, an error message containing the valid time
range of the archive file appears. Also, if the end time format is
not valid, an error message appears.
-timezone code
Applies a particular time zone to the performance
characteristic, Poll Time, included in the output data. By
default, analyzer displays this characteristic in the local time
of the client system. The possible time zones for the switch are
listed below:
-progress
Displays information about the current dump status,
including the name of the file being dumped and the
percentage dumped. An approximate value is calculated
based on the number of objects for the percentage dumped
information. This switch works with the -out switch. If you
use the -progress switch without the -out switch, it is ignored.
Do not use this switch in scripts.
43
Client Tools
-stats
Dumps the statistical information for multiple archive files.
Dumped information of different files is separated by a blank
line. The output information includes the start time, end time,
total number of objects, LUNs, SPs, disks, metaLUNs, snap
sessions, and the number of other objects such as host, storage
system.
You can use the following switches with the -stats command:
-out, -join, -overwrite, and -timezone codes (described above).
-rel
Dumps the relationship information among the various objects in
the archive file. You must provide the archive filename following
the -rel command. You can specify multiple archive files
separated by commas to dump the relationship information of all
of them.
In addition to the switches, -join, -out, -overwrite, -progress,
-enquote, -eol, -xml, -delim and -progress (described above), you
can also use the following optional switches with the -rel
command:
-root objcode
Specifies the root for the dumped relationship information.
Dumps the relationship information about the specified root
and its subnodes. The following object codes specify the object
types of a root node:
SP s
Disk d
Snap session ss
Asynchronous mirror am
RAID group rg
Host h
MetaLUN ml
LUN l
Port p
Note: Not specifying the switch dumps the relationship information for
the storage system. If you specify multiple switches for this option, an
error message appears.
-level depth
Specifies the depth of the relationship information to be
dumped. Specify the level number as an integer. For example,
specifying the level as 2 dumps the immediate subnodes of all
the objects of the type you specified with the -root switch.
Specifying the level as 1 dumps the name of all object types
you specified with the -root switch . If you specify a level as 0,
an error message appears. Not specifying this switch dumps
the complete hierarchy of all the objects of the type specified
with the -root switch.
-config
Dumps the configuration information of objects in the archive
file. You must provide the archive filename following the -config
command. You can specify multiple archive files separated by
commas to dump the configuration information for all of them.
You can use the following switches with the -config command:
-out, -join, -overwrite, -xml, -delim, -enquote, -eol, and
-progress (described above).
-object objcode
Specifies for which objects and in what order you want to
dump the configuration information.
SP s
Disk d
Snap session ss
45
Client Tools
Asynchronous mirror am
RAID group rg
Host h
MetaLUN ml
LUN l
Port p
analyzer -archiveretrieve
Retrieves analyzer archive files
User Access You must have a user account on the storage system on which you
want to execute the command.
47
Client Tools
Output None
analyzer -archivemerge
Merges analyzer archive files
User Access The host, user/password and scope options of naviseccli are ignored
since this command runs locally.
49
Client Tools
Output None
A D
account, user 15 dump 32
addusersecurity 15, 16, 17, 18, 19 -config 32
altlocation 16 -data 32
altusername 16 -rel 32
analyzer chart types -stats 32
-IO Size Distribution Detail 10
-IO Size Distribution Summary 10
F
-LUN IO Disk Detail (for LUNs only) 10
file, security 15
-Performance Detail 10
-Performance Overview 10
-Performance Summary 10 L
-Performance Survey 10 lunmapinfo 14
analyzer CLI commands
-archive 30
-archivedump 32
N
-archivemerge 49 narinterval 22, 24
-archiveretrieve 47 naviseccli command 17
-get 24 Navisphere security 15
-logging 25 nopoll 18
-set 22
-start 26 P
-status 28 parse 17, 19
-stop 27 password 15
analyzer prerequisites 11 port 17, 19
C R
case (of characters in CLI commands) 15 removeusersecurity 15, 17, 19
command line format, spaces in 21 requirements Secure CLI 15
rtinterval 24
51
Index
S
secfilepath 16, 17, 20
Secure CLI
naviseccli command switches 17
requirements 15
security, Navisphere 15
T
Timeout 17
timeout 20
U
user, security 15
username 15