Clustered system commands

Use the system commands to monitor and modify systems and their properties.

addnode
Use the addnode command to add a new (candidate) node to an existing system. Enter this command any time after a system is created. If you are adding a node to a system, make sure that the model type of the new node is supported by the system code (code) version of the existing system. If the model type is not supported by the code, upgrade the system to a code version that supports the model type of the new node.
addiscsistorageport
Use the addiscsistorageport command to establish Internet Small Computer Systems Interface (iSCSI) login sessions from any (or all) nodes in a specified I/O group (or the entire clustered system) to a discovered backend target iSCSI controller.
cfgportip (Deprecated)
The cfgportip command has been deprecated. Instead of using cfgportip command use mkip command to create a new IP address and associate it with a portset. You can use chportethernet command to configure the permitted uses of ethernet ports and the maximum transmission unit (MTU) setting for the ethernet ports.
chbanner
Use the chbanner command to configure the login message that is displayed during CLI Secure Shell (SSH) login.
chcluster (Discontinued)
Attention: The chcluster command has been discontinued. Use the chsystem command instead.
chiogrp
Use the chiogrp command to modify I/O group properties or enable maintenance mode.
chiscsistorageport
Use the chiscsistorageport command to change authentication parameters, such as setting authentication credentials, removing authentication parameters, or updating credentials.
chiscsiportauth
Use the chiscsiportauth command to set or configure the iSCSI Initiator authentication or authorization information that is used to connect to the backend IBM® Cloud storage.
chnode
Use the chnode command to change the name that is assigned to a node as well as other options. You can then use the new name when running subsequent commands. All parameters that are associated with this command are optional. However, you must specify one or more parameters.
chnodebattery
Use the chnodebattery command to set or clear the light-emitting diode (LED) on a hot-swappable battery (in a node).
chnodebootdrive
Use the chnodebootdrive command to change a drive or synchronize the drives on a system if a drive or field-replaceable unit (FRU) replacement drive breaks.
chnodecanister
You can use the chnodecanister command to change the name that is assigned to a node and other options. The name can then be used when running subsequent commands. All the parameters that are associated with this command are optional. However, you must specify one or more parameters with this command.
chnodehw
Use the chnodehw command to update the hardware configuration for a node.
chnodecanisterhw
Use the chnodecanisterhw command to update the hardware configuration for a node canister.
chquorum
Use the chquorum command to change the quorum association.
chsecurity
Use the chsecurity command to change the security settings for a system.
chsite
Use the chsite command to change the site name. This command applies only to models that support multiple I/O groups.
chsra
Use the chsra command to configure support assistance.
chsystem
Use the chsystem command to modify the attributes of an existing system. Enter this command any time after a system is created. All the parameters that are associated with this command are optional. However, you must specify one or more parameters with this command.
chsystemlimits
Use the chsystemlimits command to modify the warning threshold for a particular object.
chsystemcert
Use the chsystemcert command to manage the Secure Sockets Layer (SSL) certificate that is installed on a system.
chsystemip (Deprecated)
The chsystemip command is deprecated and can not be used to change or remove IP addresses configured on a port other than 1 and 2 or if it is configured using VLAN. To change the port use chip command and to remove the port use rmip command.
chsystemethernet
The chsystemethernet command is used to set the priority tag for host attachment, system, and storage traffic.
chsystempatch
Use the chsystempatch the command to enable or disable the patch auto-update process for a specific installed patch. If the patch does not support this process, a corresponding error message is returned.
chthrottle
Use the chthrottle command to change attributes associated with a specified throttle object.
chcompatibilitymode
Use the chcompatibilitymode command to change whether a feature is enabled in compatibility mode.
cpdumps
Use the cpdumps command to copy dump files from a nonconfiguration node onto the configuration node.
detectiscsistorageportcandidate
Use the detectiscsistorageportcandidate command to establish Internet Small Computer Systems Interface (iSCSI) login sessions from any nodes in a specified I/O group to a discovered backend iSCSI target controller.
help
Use the help (or man) command to display help information for system commands.
lsavailablepatch
Use the lsavailablepatch command to list the patches that are compatible with the software version on the system and those of which that can be auto-updated. The command output also indicates whether the specific patches listed are already installed on the system.
lsclustercandidate (Discontinued)
Attention: The lsclustercandidate command has been discontinued. Use the lspartnershipcandidate command instead.
lscluster (Discontinued)
Attention: The lscluster command is discontinued. Use a combination of the lspartnership, lspartnershipcandidate, and lssystem commands instead.
lsclusterip (Discontinued)
Attention: The lsclusterip command has been discontinued. Use the lssystemip command instead.
lsclusterstats (Discontinued)
Attention: The lsclusterstats command is discontinued. Use the lssystemstats command instead.
lsdiscoverystatus
Use the lsdiscoverystatus command to determine whether a discovery operation is in progress.
lsfabric
Use the lsfabric command to generate a report that displays the Fibre Channel (FC) connectivity between nodes, controllers, and hosts.
lsfabricport
Use the lsfabricport command to display the FDMI information that is discovered by the system.
lsnvmefabric
Use the lsnvmefabric command to display information about NVMe logins from configured hosts.
lsfcportcandidate
Use the lsfcportcandidate command to list the Fibre Channel (FC) ports. This information is used to find open FC ports.
lsiscsiportauth
Use the lsiscsiportauth command to display the per initiator port authentication and authorization information that is configured.
lsiscsistorageport
Use the lsiscsistorageport command to display the details of the iSCSI login sessions that are established from the initiator's iSCSI source ports to the iSCSI backend target controller ports.
lsiscsistorageportcandidate
Use the lsiscsistorageportcandidate command to display a concise or detailed list of information about the candidate Internet Small Computer Systems Interface (iSCSI) target controller iSCSI Qualified Name (IQN) that is specified with the target IP from the specified initiator source ports.
lsiogrp
Use the lsiogrp command to display a concise list or a detailed view of input/output (I/O) groups visible to the system.
lshbaportcandidate (Deprecated)
The lshbaportcandidate command is deprecated. Use either the lsfcportcandidate or lssasportcandidate command instead.
lsiogrphost
Use the lsiogrphost command to display a list of the hosts mapped to a specified I/O group.
lsiogrpcandidate
Use the lsiogrpcandidate command to list the I/O groups that can have nodes added to them.
lsnode
Use the lsnode command to return a concise list or a detailed view of nodes that are part of the system .
lsnodebattery
Use the lsnodebattery command to display information about the batteries in a node.
lsnodecandidate
Use the lsnodecandidate command to list all of the nodes that are available to add to the clustered system.
lsnodecanister
The lsnodecanister command returns a concise list or a detailed view of node canisters that are part of the system.
lsnodecanisterhw
Use the lsnodecanisterhw command to display the configured and actual hardware configuration of node canisters in the clustered system.
lsnodecanisterstats
The lsnodecanisterstats command displays the most recent values of all node canister statistics, and displays all node canister statistics for a particular canister. This command also can be used to display a history of values for a subset of available statistics.
lsnodecanistervpd
The lsnodecanistervpd command displays the vital product data (VPD) for each node canister.
lsnodedependentvdisks (Deprecated)
Attention: The lsnodedependentvdisks command is deprecated. Use the lsdependentvdisks command instead.
lsnodehw
Use the lsnodehw command to display the configured and actual hardware configuration of nodes in the clustered system.
lsnodepsu
Use the lsnodepsu command to display the power supply unit information of nodes in a system.
lsnodestats
Use the lsnodestats command to display the most recent values of statistics for all nodes or node canisters, and display all statistics for a particular node or node canister. Additionally, You can use this command to display a history of values for a given subset of available statistics. This command is only applicable for IBM SAN Volume Controller.
lsnodevpd
Use the lsnodevpd command to display the vital product data (VPD) for each node.
lspoolcapacity
Use the lspoolcapacity command to display the pool-specific capacity information.
lsportip (Deprecated)
The lsportip command has been deprecated and maintained only as stub view for backward compatibility purpose. Instead of lsportip command use lsip command to view information about configured IP addresses for all type (host, storage or replication) of connectivity and lsportethernet command to provide information about physical ethernet ports.
lsportfc
Use the lsportfc command to view the status and properties of the Fibre Channel (FC) input/output (I/O) ports for the clustered system.
lsportsas
Use the lsportsas command to display the status of all SAS ports in the clustered system.
lsportstats
Use the lsportstats command to view the port transfer and failure counts and Small Form-factor Pluggable (SFP) diagnostics data that is recorded in the statistics file for a node.
lsportusb
Use the lsportusb command to display information about Universal Serial Bus (USB) ports.
lsquorum
Use the lsquorum command to list the quorum devices that the system uses to store quorum data.
lsroute
Use the lsroute command to display the IP routing table.
lstimezones
Use the lstimezones command to list the time zones that are available on the system. Each time zone is assigned an ID that can be used in the settimezone command to set the time zone.
lssasportcandidate
Use the lssasportcandidate command to list the unconfigured serial-attached SCSI (SAS) ports that are logged in and available to add to the SAS worldwide port name (WWPN) or host objects.
lssecurity
Use the lssecurity command to display the current system Secure Sockets Layer (SSL) or Transport Layer Security (TLS) security settings.
lssite
Use the lssite command to report the names of the sites.
lssra
Use the lssra command to check both secure remote assistance status and the time of the last login.
lssystemcapacity
Use the lssystemcapacity command to display the capacity values for the system as a whole.
lsthrottle
Use the lsthrottle command to list throttle objects that are configured in the clustered system.
lssystem
Use the lssystem command to display a detailed view of a system.
lssystemlimits
Use the lssystemlimits command to display a list of object consumption and limits for the system.
lssystemcert
Use the lssystemcert command to list information about the current system Secure Sockets Layer (SSL) certificate.
lssystemethernet
Use the lssystemethernet command to list system-wide Ethernet priority tag details for host attachment, system, and storage traffic.
lssystemip
Use the lssystemip command to display a list of the system management IP addresses configured for each port.
lssystemstats
Use the lssystemstats command to display the most recent values of all node statistics in a system, or to display a history of values for a specified subset of available statistics across all nodes in a system. This command also can be used to display a history of values for a specified subset of available statistics.
lstargetportfc
Use the lstargetportfc command to generate the list of host count and login count for each worldwide port names (WWPNs) required to set up Fibre Channel (FC) zoning and to display the current failover status of host IO ports.
lscompatibilitymode
Use the lscompatibilitymode command to display the information on features that are enabled for compatibility.
mkquorumapp
Use the mkquorumapp command to generate a Java™ application to use for quorum.
mkthrottle
Use the mkthrottle command to create a new throttle object and associate it with an object (such as a volume). You can also create offloaded I/O throttling (which is a single clustered system throttle).
ping
Use the ping command to diagnose IP configuration problems. The command checks whether the specified IP address is accessible from the node on which the command is run by using the specified IP address.
rmiscsistorageport
Use the rmiscsistorageport command to remove established Internet Small Computer Systems Interface (iSCSI) sessions between system nodes and backend iSCSI target.
rmnode
The rmnode command deletes a node (or spare node) from the clustered system. You can enter this command anytime after a clustered system is created. This command makes the node a candidate that is ready to be added back into this clustered system or another system.
rmnodecanister
Use the rmnodecanister command to delete a node canister from the system. Enter this command at any time after a system has been created.
rmportip (Deprecated)
The rmportip command has been deprecated. Use the rmip command instead.
rmthrottle
Use the rmthrottle command to remove the throttle object associated with any volume.
setclustertime (Discontinued)
Attention: The setclustertime command has been discontinued. Use the setsystemtime command instead.
setsystemtime
Use the setsystemtime command to set the time for the system.
setpwdreset
Use the setpwdreset command to view and change the status of the password-reset feature for the node.
settimezone
Use the settimezone command to set the time zone for the system.
showtimezone
Use the showtimezone command to display the current time zone settings for the cluster.
startstats
Use the startstats command to modify the interval at which per-node statistics for volumes, managed disks (MDisks), and nodes are collected.
stopcluster (Discontinued)
Attention: The stopcluster command is discontinued. Use the stopsystem command instead.
stopsystem
Use the stopsystem command to shut down a single node or the entire system in a controlled manner. When you issue this command, you are prompted with a confirmation of intent to process the command.
swapnode
Use the swapnode command to facilitate maintenance actions that maintain availability without interruptions by using virtualized target ports on a hot spare node. This command is used during hardware replacement procedures, or as alternative to place a node in service state.
chnodeserviceip
Use the chnodeserviceip command to set the service address for a specific node. This command enables a non-superuser to set the service address for a specific node.
svcinfo lsnodestatus
Use the svcinfo lsnodestatus command to view the status of a node.
svctask restartservice
Use the svctask restartservice command to restart a named service. This command enables security administrator and administrator to restart a service.
svctask startsystem
Use the svctask startsystem command to take a single node out of service state. This command only enables security administrator and administrator to start a node.
svcinfo traceroute
Use the svcinfo traceroute command to print the wide area network (WAN) route packets to a specified host.
detectfabricport
Use the detectfabricport command to trigger the fabric discovery.

Parent topic: CLI reference