HP 3PAR CLI Reference Guide

This is a CLI command line reference guide for HP’s 3PAR OS, and is based on version 3.3.1. It is a complete list of commands and a description of their function, I’d recommend reviewing HP’s official support documentation for specific information on command line arguments and advanced functions of each command. This is designed to be a quick reference of the commands available for use.

Adaptive Flash Cache
createflashcache Creates flash cache for
the cluster.
removeflashcache Remove flash cache
from the cluster.
setflashcache Sets the flash cache
policy for virtual
volumes.
showflashcache Shows either the status
node, or flash cache
policy for virtual
volumes.
statcache Show the flash cache
and data cache statistics
in a timed loop.
Adaptive Optimization (AO)
createaocfg Creates an AO
configuration.
removeaocfg Removes specified AO
configurations from the
system.
setaocfg Updates an AO
showaocfg Shows AO
Certificate
createcert Create self-signed SSL
certificate or a certificate
signing request (CSR)
for the 3PAR Storage
System SSL services.
showcert Show information about
SSL certificates of the
3PAR Storage System.
importcert Imports certificates for a
given service.
removecert Removes certificates
that are no longer
trusted.
CIM Server
setcim Sets the properties of
the CIM server,
including options to
enable or disable the
SLP, HTTP and HTTPS
ports for the CIM server.
showcim Displays the CIM server
setting information and
status.
startcim Starts the CIM server to
service CIM requests.
stopcim Stops the CIM server
from servicing CIM
requests.
Disk Enclosure Management Commands
Drive Cage Management
locatecage Locates a particular
drive cage.
setcage Sets parameters for a
drive cage.
showcage Displays drive cage
information.
Encryption
controlencryption Controls data
encryption.
showencryption Shows data encryption.
Physical Disk Management
admitpd Admits one or all
physical disks to enable
their use.
checkpd Executes surface scans
on physical disks.
controlpd Spins physical disks up
or down.
dismisspd Dismisses one or more
physical disks from use.
movepd Moves data from
specified Physical Disks
to a temporary location
selected by the system.
setpd Marks physical disks as
allocatable for logical
disks.
showpd Displays physical disks
in the system.
Domain Management
changedomain Changes the
currentdomain CLI
environment parameter.
createdomain Shows a list of domains
on the system.
createdomainset Defines a new set of
domains and provides
the option of assigning
one or more domains to
that set.
movetodomain Moves objects from one
domain to another.
removedomain Removes an existing
domain from the system.
removedomainset Removes a domain set
or removes domains
from an existing set.
setdomain Sets the parameters and
modifies the properties
of a domain.
setdomainset Sets the parameters and
modifies the properties
of a domain set.
showdomain Displays the list of
domains on a system.
showdomainset Displays the domain
sets defined on the
3PAR Storage System
and their members.
Dual Sign-On Request
removecorequest Removes rejected,
cancelled, or executed
dual sign-on requests.
setcorequest Approve or deny a
pending dual sign-on
command approval
request, modify the
queue size, execute an
approved request, or
cancel a pending
request.
showcorequest Displays status of CO
approval requests or
queue size.
File Access Audit Settings
setfsaudit Set File Access Audit
settings.
showfsaudit Display File Access
Audit settings.
File Persona
setfs Update global File
Persona Settings
showfs Show information of a
File Persona cluster.
startfs Initialize and start File
Persona on the system.
statfs Show statistics for File
Persona.
stopfs Stop or remove File
Persona.
File Persona Antivirus
setfsav Set antivirus properties
for File Persona.
showfsav Show antivirus
properties for File
Persona.
startfsav Start antivirus service or
scan for File Persona.
stopfsav Stop the antivirus
service or stop/pause a
scan.
File Persona Archiving
removefsarchive Deletes the WORM/
WORM-retained file(s),
removes the retention
period or deletes
retention validation scan
on the fstore.
setfsarchive Set or modify archiving
properties for File
Persona.
showfsarchive Displays policy setting,
retention setting and
status of validation
scans.
startfsarchive Starts or resumes
validation jobs.
stopfsarchive Stops or pauses data
validation jobs.
File Persona Group Accounts
createfsgroup Create a local group
account associated with
File Persona.
showfsgroup Show local group
information associated
with File Persona.
removefsgroup Remove a local group
account associated with
File Persona.
setfsgroup Modify a local group
account associated with
File Persona.
File Persona NDMP
setfsndmp Set NDMP properties for
File Persona.
showfsndmp Show NDMP properties
for File Persona.
startfsndmp Start NDMP and ISCSI
service.
stopfsndmp Stop NDMP and ISCSI
service.
File Persona Network Commands
createfsnetwork Configures multiple
networks by creating
new network.
removefsnetwork Removes the given
network.
setfsnetwork Modifies parameters for
multiple networks.
showfsnetwork Displays multiple
networks configuration.
File Persona Routes
createfsroute Create a route for a
target address with a
gateway.
removefsroute Removes an existing
route for a target
address.
setfsroute Modifies an existing
route for a target
address.
showfsroute Displays routes for
target addresses.
File Persona Snapshots
createfsnap Create a snapshot for
File Persona.
removefsnap Remove file store
snapshots from File
Persona.
showfsnap Show snapshot
information for File
Persona.
showfsnapclean Show details of an on-
demand snapshot
reclamation task.
startfsnapclean Start or resume an on-
demand snapshot
reclamation task.
stopfsnapclean Stop or pause an on-
demand snapshot
reclamation task.
File Persona User Accounts
createfsuser Create a local user
account associated with
File Persona.
removefsuser Remove a local user
account associated with
File Persona.
setfsuser Modify a local user
account associated with
File Persona.
showfsuser Show local user
information associated
with File Persona.
File Provisioning Group
createfpg Create a file
provisioning group.
growfpg Grow a file provisioning
group.
removefpg Remove a file
provisioning group.
setfpg Modify the properties of
a file provisioning group.
showfpg Show file provisioning
group information.
File Share 
createfshare Create a file share.
removefshare Remove a file share
from a File Persona
cluster.
setfshare Modify the properties of
a file share.
showfshare Show file share
information.
File Store 
createfstore Create a file store.
removefstore Remove a file store.
setfstore Modify the properties of
a file store.
showfstore Show file store
information.
Health and Alert Management
removealert Removes one or more
alerts.
setalert Sets the status of
system alerts.
showalert Displays system alerts.
showeventlog Displays event logs.
checkhealth Displays the status of
the system hardware
and software
components.
Help and Utility Commands
cli Provides a means to set
up your CLI session or to
enter directly into a CLI
shell.
clihelp Lists all commands or
details for a specified
command.
cmore Pages the output of
commands.
help Lists all commands or
details for a specified
command.
setclienv Sets the CLI
environment parameters.
showclienv Displays the CLI
environment parameters.
LDAP Management 
setauthparam Sets the authentication
parameters.
showauthparam Shows authentication
parameters and
integrates the
authentication and
authorization features
using LDAP.
checkpassword Supports authentication
and authorization using
LDAP.
Licensing Management
setlicense Sets the license key.
showlicense Displays the installed
license info or key.
Node Subsystem Management 
Firmware Versions
showfirmwaredb Displays a current
database of firmware
levels.
Node Date info
setdate Sets the system time
and date on all nodes.
showdate Displays the date and
time on all system
nodes.
Controller Node Properties
setnode Sets the properties of
the node components
such as the serial
number of the power
supply.
shownode Displays an overview of
the node specific
properties.
shownodeenv Displays the node’s
environmental status.
Controller Node EEPROM Log
showeeprom Displays node EEPROM
information.
Array and Controller Node Info
locatenode Locates a particular
node component by
blinking LEDs on the
node.
locatesys Locates a system by
blinking its LEDs.
setsys Enables you to set
system-wide parameters
such as the raw space
alert.
showsys Displays the 3PAR
Storage System
properties, including
system name, model,
serial number, and
system capacity.
Network Interface Config
setnet Sets the administration
network interface
configuration.
shownet Displays the network
configuration and status.
Port Information
checkport Performs a loopback
test on Fibre Channel
ports.
controlport Controls Fibre Channel
or Remote Copy ports.
controliscsiport Used to set up the
parameters and
characteristics of an
iSCSI port.
showiscsisession Shows the iSCSI active
sessions per port.
showport Displays system port
information.
showportarp Shows the ARP table for
iSCSI ports in the
system.
showportdev Displays detailed
information about
devices on a Fibre
Channel port.
showportisns Show iSNS host
information for iSCSI
ports in the system.
showportlesb Displays Link Error
Status Block information
about devices on a Fibre
Channel port.
showtarget Displays unrecognized
targets.
statiscsi Displays the iSCSI
statistics.
statiscsisession Displays the iSCSI
session statistics.
Battery Management
setbattery Sets battery properties.
showbattery Displays battery status
information.
System Manager
setsysmgr Sets the system
manager startup state.
showsysmgr Displays the system
manager startup state.
showtoc Displays the system
table of contents
summary.
showtocgen Displays the system
table of contents
generation number.
Node Rescue
startnoderescue Initiates a node rescue,
which initializes the
internal node disk of the
specified node to match
the contents of the other
node disks.
Performance Management Commands
Chunklet Stats
histch Displays histogram data
for individual chunklets.
setstatch Sets statistics collection
mode on chunklets.
setstatpdch Sets statistics collection
mode on physical disk
chunklets.
statch Displays statistics for
individual chunklets.
Data Cache
statcmp Displays statistics for
cache memory pages.
Node CPU Stats
statcpu Displays statistics for
CPU use.
Logical Disk Stats
histld Displays histogram data
for logical disks.
statld Displays statistics for
logical disks.
Link Stats
statlink Displays statistics for
links.
Physical Disk Stats
histpd Displays histogram data
for physical disks.
statpd Displays statistics for
physical disks.
Port Stats
histport Displays histogram data
for Fibre Channel ports.
statport Displays statistics for
Fibre Channel ports.
System Tuner
tunepd Displays physical disks
with high service times
and optionally performs
load balancing.
tunesys Analyzes disk usage
and adjusts resources.
tunevv Changes the layout of a
virtual volume.
Virtual LUN Stats
histvlun Displays histogram data
for VLUNs.
statvlun Displays statistics for
VLUNs.
Virtual Volume Stats
histvv Displays histogram data
for virtual volumes.
statvv Displays statistics for
virtual volumes.
Remove Copy Volume Stats
histrcvv Displays histogram data
for Remote Copy
volumes.
statrcvv Displays statistics for
Remote Copy volumes.
Preserved Data 
showpdata Displays preserved data
status.
Replication Commands
Physical Copy
creategroupvvcopy Creates consistent
group physical copies of
a list of virtual volumes.
createvvcopy Copies a virtual volume.
promotevvcopy Promotes a physical
copy back to a base
volume.
Remote Copy
admitrcopylink Admits a network link for
Remote Copy use.
admitrcopytarget Adds a target to a
Remote Copy volume
group
admitrcopyvv Admits a virtual volume
to a Remote Copy
volume group.
checkrclink Performs a latency and
throughput test on a
remote copy link.
creatercopygroup Creates a group for
Remote Copy.
creatercopytarget Creates a target for
Remote Copy.
dismissrcopylink Dismisses a network link
from Remote Copy use.
dismissrcopytarget Dismisses a Remote
Copy target from a
Remote Copy volume
group.
dismissrcopyvv Dismisses a virtual
volume from a Remote
Copy volume group.
removercopygroup Removes a group used
for Remote Copy.
removercopytarget Removes a target used
for Remote Copy.
setrcopygroup Sets a volume group’s
policy for dealing with
I/O failure and error
handling, or switches
the direction of a volume
group.
setrcopytarget Sets the Remote Copy
target state.
showrcopy Displays the details of a
Remote Copy
configuration.
showrctransport Shows status and info
about end-to-end
transport for Remote
Copy in the system.
startrcopy Starts a Remote Copy
subsystem.
startrcopygroup Starts a Remote Copy
volume group.
statrcopy Displays Remote Copy
statistics.
stoprcopy Stops a Remote Copy
subsystem.
stoprcopygroup Stops a Remote Copy
volume group.
syncrcopy Synchronizes Remote
Copy volume groups.
Virtual Copy
createsv Creates snapshot
volumes.
creategroupsv Creates consistent
group snapshots of a list
of virtual volumes.
promotesv Copies the differences
of a virtual copy back to
its base volume.
promotegroupsv Copies the differences
of snapshots back to
their base volumes, to
allow to revert the base
volumes to an earlier
point in time.
updatevv Updates a snapshot
virtual volume with a
new snapshot.
Security Hardening Commands
SP Credential
Command Description
removespcredential Removes all Service
Processor credentials
on the array.
Support Recovery Account Password
Command Description
controlrecoveryauth Control the method used
to authenticate recovery
accounts.
Service Commands
Disk Enclosure
admithw Admits new hardware
into the system.
controlmag Takes drives or
magazines on or off
loop.
servicecage Prepares a drive cage
for service.
servicehost Prepares a port for host
attachment.
servicemag Prepares a drive
magazine for service.
upgradecage Upgrades drive cage
firmware.
upgradepd Upgrades disk firmware.
General/Node
servicenode Prepares a node for
service.
shutdownnode Shuts down an
individual system node.
shutdownsys Shuts down the entire
system.
QoS
setqos Creates and updates
QoS rules in a system.
showqos Lists the QoS rules
configured in a system.
statqos Displays historical
performance data
reports for QoS rules.
Software Version
showpatch Displays patches
applied to a system.
showversion Displays software
versions.
SNMP Agent Commands
addsnmpmgr Adds an SNMP
manager to receive trap
notifications.
checksnmp Allows a user to send an
SNMPv2 test trap to the
list of managers
removesnmpmgr Removes an SNMP trap
manager.
removesnmppw Removes an SNMP
password.
removesnmpuser Removes an SNMP
user.
setsnmppw Allows users to update
SNMP passwords.
setsnmpmgr Changes an SNMP
manager’s properties.
showsnmpmgr Displays SNMP trap
managers.
showsnmppw Displays SNMP access
passwords.
showsnmpuser Displays information
about SNMP users.
Sparing Commands
createspare Creates spare
chunklets.
movech Moves specified
chunklets.
movechtospare Moves specified
chunklets to spare.
movepd Moves data from
specified physical disks
to a temporary location
selected by the system.
movepdtospare Moves specified
physical disks to spare.
moverelocpd Moves chunklets
relocated from a
physical disk to another
physical disk.
removespare Removes spare
chunklets.
showspare Displays information
about spare and
relocated chunklets.
SSH Access
setsshkey Sets the SSH public key
for users enabling login
without a password.
showsshkey Displays all SSH public
keys that have been set
with setshhkey.
removesshkey Removes a user’s SSH
public key.
SSH Banner
removesshbanner Removes the SSH
banner.
setsshbanner Sets the SSH banner
that is displayed before
the user logs in.
showsshbanner Display the SSH banner
that has been set with
setsshbanner.
System Reporter
controlsr Make changes to the
System Reporter.
createsralertcrit Creates the criteria that
System Reporter
evaluates to determine
if a performance alert
should be generated.
removesralertcrit Removes the criteria
that System Reporter
evaluates to determine
if a performance alert
should be generated.
setsralertcrit Sets the criteria that
System Reporter
evaluates to determine
if a performance alert
should be generated.
showsr Displays System
Reporter status.
showsralertcrit Displays the criteria
that System Reporter
evaluates to determine
if a performance alert
should be generated.
sraomoves Shows the space that
Adaptive Optimization
(AO) has moved
between tiers.
srcpgspace Displays historical
space data reports for
common provisioning
groups (CPGs).
srhistld Displays historical
histogram performance
data reports for logical
disks.
srhistpd Displays historical
histogram data reports
for physical disks.
srhistport Displays historical
histogram performance
data reports for ports.
srhistvlun Displays historical
histogram performance
data reports for VLUNs.
srldspace Displays historical
space data reports for
logical disks (LDs).
srpdspace Displays historical
space data reports for
physical disks (PDs).
srrgiodensity Shows the distribution
of IOP/s intensity for
Logical Disk (LD)
regions for a common
provisioning group
(CPG) or Adaptive
Optimization (AO)
configuration.
srstatcmp Displays historical
performance data
reports for cache
memory.
srstatcpu Displays historical
performance data
reports for CPUs.
srstatfsav Displays system
reporter performance
reports for file service
anti-virus.
srstatfsblock Displays System
reporter performance
reports for file service
block devices.
srstatfscpu Displays system
reporter performance
reports for file service
CPU usage.
srstatfsfpg Displays system
reporter performance
reports for file service
file provisioning groups.
srstatfsmem Displays system
reporter performance
reports for file service
memory usage.
srstatfsnet Displays system
reporter performance
reports for file service
Ethernet interfaces.
srstatfsnfs Displays system
reporter performance
reports for file service
NFS.
srstatfssmb Displays system
reporter performance
reports for file service
SMB.
srstatfssnapshot Displays system
reporter performance
reports for file service
snapshots.
srstatiscsi System reporter
performance for iSCSI
ports.
srstatiscsisession System reporter
performance for iSCSI
sessions.
srstatld Displays historical
performance data
reports for logical disks.
srstatlink Displays historical
performance data
reports for links
(internode, PCI and
cache memory).
srstatpd Displays historical
performance data
reports for physical
disks.
srstatport Displays historical
performance data
reports for ports.
srstatqos Displays historical
performance data
reports for QoS rules.
srstatvlun Displays historical
performance data
reports for VLUNs.
srstatvv System reporter
performance reports for
virtual volumes.
srsysspace System reporter space
reports for the system.
srvvspace Displays historical
space data reports for
virtual volumes (VVs).
Task Management
canceltask Cancels one or more
tasks.
removetask Removes information
about one or more tasks
and their details.
settask Sets the priority on a
specified task.
showtask Displays information
about tasks.
starttask Executes commands
with long running times.
waittask Asks the CLI to wait for
a task to complete
before proceeding.
User Management
createsched Allows users to
schedule tasks that are
periodically run by the
scheduler.
removesched Removes a scheduled
task from the system.
setsched Allows users to
suspend, pause, change
the schedule, change
the parameters, and
change the name of
currently scheduled
tasks.
showsched Displays the state of
tasks currently
scheduled on the
system.
createuser Creates user accounts.
removeuser Removes user
accounts.
removeuserconn Removes user
connections.
setpassword Changes your
password.
setuser Sets your user
properties.
setuseracl Sets your Access
Control List (ACL).
showuser Displays user accounts.
showuseracl Displays your access
control list (ACL).
showuserconn Displays user
connections.
showrole Displays information
about rights assigned to
roles in the system.
VASA Provider
setvasa Set the VASA Provider
server properties.
showvasa Show properties of the
VASA web service
provider.
startvasa Start the VASA Provider
server to service HTTPS
requests.
showvasa Show properties of the
VASA web service
provider.
stopvasa Stop the VASA Provider
server from servicing
HTTPS requests.
Virtual File Server
createvfs Create a virtual file
server.
removevfs Remove a virtual file
server.
setvfs Modify the properties of
a virtual file server.
showvfs Show virtual file server
information.
Virtual File Server Network
createfsip Assigns an IP address
to a virtual file server.
removefsip Removes the network
configuration of a virtual
file server.
setfsip Modify the network
configuration of a virtual
file server.
showfsip Show the network
configuration of a virtual
file server.
Virtual File Server Quota
setfsquota Set the quotas for a
specific virtual file
server.
showfsquota Show the quotas for a
specific virtual file
server.
Virtual File Server Backup Configuration
backupfsconf Create a configuration
backup for a virtual file
server.
restorefsconf Restore a configuration
backup for a virtual file
server on the same or a
different system with
same fpg and vfs
structure.
Volume Management
Common Provisioning Group Management
compactcpg Consolidates logical disk
space in a CPG into as
few logical disks as
possible, allowing
unused logical disks to
be removed.
createcpg Creates a Common
Provisioning Group
(CPG).
removecpg Removes CPGs.
setcpg Changes the properties
CPGs.
showcpg Displays CPGs.
Host Management
createhost Creates host and host
path definitions.
createhostset Creates a new set of
hosts and provides the
option of assigning one
or more existing hosts to
that set.
removehost Removes host
definitions from the
system.
removehostset Removes a host set or
removes hosts from an
existing set.
showhost Displays defined hosts
in the system.
showhostset Displays the host sets
defined on the 3PAR
Storage System and
their members.
sethost Sets properties on
existing system hosts,
including options to
annotate a host with
descriptor information
such as physical
location, IP address,
operating system,
model, and so on.
sethostset Sets the parameters and
modifies the properties
of a host set.
Logical Disk Management
checkld Performs validity checks
of data on logical disks.
compactld Consolidates space on
the logical disks.
removeld Removes logical disks.
showld Displays logical disks.
startld Starts logical disks.
Space and Storage Management
showblock Displays block mapping
information for virtual
volumes, logical disks,
and physical disks.
showldch Displays logical disk to
physical disk chunklet
mapping.
showldmap Displays logical disk to
virtual volume mapping.
showpdch Displays the status of
selected chunklets of
physical disks.
showpdvv Displays physical disk to
virtual volume mapping.
showspace Displays estimated free
space.
showvvmap Displays virtual volume
to logical disk mapping.
showvvolvm Displays information
about all virtual
machines (VVol-based)
or a specific virtual
machine in a system.
showvvpd Displays virtual volume
distribution across
physical disks.
Template Management
createtemplate Creates templates for
the creation of logical
disks, virtual volumes,
thinly provisioned virtual
volumes, and common
provisioning groups.
removetemplate Removes one or more
templates.
settemplate Modifies template
properties.
showtemplate Displays existing
templates.
Virtual Volume Management
admitvv Creates and admits
remotely exported virtual
volume definitions to
enable the migration of
these volumes.
checkvv Performs validity checks
of virtual volume
administrative
information.
createvv Creates a virtual volume
from logical disks.
createvvset Defines a new set of
virtual volumes provides
the option of assigning
one or more existing
virtual volumes to that
set.
freespace Frees SA and SD
spaces from a virtual
volume if they are not in
use.
growvv Increases the size of a
virtual volume by adding
logical disks.
importvv Migrates data from a
remote LUN to the local
3PAR Storage System.
removevv Removes virtual
volumes or logical disks
from common
provisioning groups.
removevvset Removes a virtual
volume set or virtual
volumes from an
existing set.
setvv Modifies properties
associated with a virtual
volume.
setvvolsc Creates, removes, and
sets properties of
Storage Containers for
virtual volumes.
setvvset Sets the parameters and
modifies the properties
of a virtual volume set.
showrsv Displays information
about reservation and
registration of VLUNs
connected on a Fibre
Channel port.
showvv Displays virtual volumes
in the system.
showvvolsc Display information
about VVol storage
containers in the
system.
showvvcpg Displays the virtual
volume sets defined on
the 3PAR Storage
System and their
associated members.
showvvset Displays the virtual
volume sets defined on
the 3PAR Storage
System and their
members.
startvv Starts virtual volumes.
updatesnapspace Starts a task to update
the actual snapshot
space used by a virtual
volume.
Virtual LUN Management
createvlun Creates a virtual volume
as a SCSI LUN.
removevlun Removes VLUNs.
showvlun Displays VLUNs in the
system.
Web Services API (WSAPI)
removewapisession Removes the WSAPI
user connections.
setwsapi Sets properties of the
Web Services API
server.
showwsapi Displays the WSAPI
server service
configuration state.
showwsapisession Displays the WSAPI
server sessions
connection information.
startwsapi Starts the WSAPI
server.
stopwsapi Stops the WSAPI
server.
Advertisements

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.