lscluster

The lscluster command returns a concise list or a detailed view of a cluster.

Syntax

Read syntax diagramSkip visual syntax diagram
>>- svcinfo -- -- lscluster -- --------------------------------->

>--+-----------------------------------+-- --+----------+-- ---->
   '- -filtervalue -- attribute=value -'     '- -nohdr -'      

>--+----------+-- --+-----------------------+-- -- ------------->
   '- -bytes -'     '- -delim -- delimiter -'         

>--+-----------------+--+----------------+---------------------><
   '- -filtervalue? -'  +- cluster_id ---+   
                        '- cluster_name -'   

Parameters

-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter attribute value are displayed. If a capacity is specified, the units must also be included.
Note: Some filters allow the asterisk character (*) when you enter the command. The following rules apply to the use of wildcard characters with the SAN Volume Controller CLI:
  • The wildcard character is an asterisk (*).
  • The command can contain a maximum of one wildcard.
  • When you use a wildcard, you must enclose the filter entry within double quotation marks (""), as follows:
    svcinfo lscluster -filtervalue  "name=md*"
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for each item of data in a detailed style view. The -nohdr parameter suppresses the display of these headings.
Note: If there is no data to be displayed, headings are not displayed.
-bytes
(Optional) Specifies that you want the report to display all capacities as bytes.
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each column is set to the maximum possible width of each item of data. In a detailed view, each item of data has its own row, and if the headers are displayed, the data is separated from the header by a space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a one-byte character. If you enter -delim : on the command line, the colon character (:) separates all items of data in a concise view; for example, the spacing of columns does not occur. In a detailed view, the data is separated from its header by the specified delimiter.
-filtervalue?
(Optional) displays a list of filters that can be applied against this view. The following filter attributes are valid for the lscluster command:
  • cluster_name
  • cluster_unique_id
  • id
  • name
cluster_id | cluster_name
(Optional) Specifies the name or ID of a cluster. When you use this parameter, the detailed view of the specific cluster is displayed and any value that you specified by the -filtervalue parameter is ignored. If you do not specify the cluster_id | cluster_name parameter, the concise view of all clusters that match the filtering requirements that are specified by the -filtervalue parameter are displayed.

Description

This command displays a concise list or a detailed view of a cluster.

Table 1 provides the attribute values that can be displayed as output view data.
Table 1. Attribute values
Attribute Possible Values
location local, remote
statistics status on, off
email_state running, stopped, invalid
partnership fully_configured, partially_configured_local, partially_configured_local_stopped, not present, fully_configured_stopped, fully_configured_remote_stopped, fully_configured_local_excluded, fully_configured_remote_excluded, fully_configured_exceeded

Information about the remote cluster is reported by the lscluster command if the mkpartnership command has been issued from the local cluster to the remote cluster; for example, if the partnership has been at least partially established from the local cluster.

You can issue the svcinfo lscluster command to display a detailed view of the cluster.

svcinfo lscluster -delim : 10030a007e5

where 10030a007e5 is the cluster name.
Detailed view shows the fields described for remote clusters only; if the cluster Location is local, then Partnership and Bandwidth do not apply (and are not defined or provided). For a remote cluster, these fields indicate the following information:
  • Location: remote
  • Partnership:
    fully_configured
    The mkpartnership command has been issued in both directions and the remote cluster is online and available.
    partially_configured_local
    The mkpartnership command has only been issued from the local cluster to the remote cluster. The remote cluster is online and available for partnership.
    partially_configured_local_stopped
    The mkpartnership command has only been issued from the local cluster to the remote cluster. The chpartnership command with the stop parameter has been issued from the local cluster, and the remote cluster is online and available. You need to issue the chpartnership command with the start parameter on the local cluster, and mkpartnership on the remote cluster.
    Not Present
    The mkpartnership command has been issued from the local cluster to the remote cluster, and the remote cluster is not available. Either the remote cluster is offline, or it is not connected to the local cluster.
    fully_configured_stopped
    The mkpartnership command has been issued in both directions and the remote cluster is online and available. The chpartnership command with the stop parameter has been issued from the local cluster.
    fully_configured__remote_stopped
    The mkpartnership command has been issued in both directions and the remote cluster is online and available. The chpartnership command with the stop parameter has been issued from the remote cluster.
    fully_configured__local_excluded
    The mkpartnership command has been issued in both directions. The local cluster has excluded the connection to the remote cluster due to too many problems, or either cluster in the partnership is unable to sustain the I/O workload for the Metro Mirror or Global Mirror relationships.
    fully_configured__remote_excluded
    The mkpartnership command has been issued in both directions. The remote cluster has excluded the connection to the local cluster due to too many problems, or either cluster in the partnership is unable to sustain the I/O workload for the Metro Mirror or Global Mirror relationships.
    fully_configured__exceeded
    There are too many clusters in the cluster network, and the partnership from the local cluster to the remote has been disabled. Refer to the 1710/1720 errors in the cluster error log at the local and remote clusters.
  • Bandwidth: The bandwidth available on the intercluster link for background copy, in megabytes per second (MBps).

A concise invocation example

svcinfo lscluster -delim :

The concise resulting output

id:name:location:partnership:bandwidth:id_alias
000002006420A162:cluster0:local:::000002006420A162

A detailed invocation example

svcinfo lscluster -delim : cluster1

The detailed resulting output

id:1521071282978998
name:cluster1
location:local
partnership:fully_configured_stopped
bandwidth:
total_mdisk_capacity:1673.3GB
space_in_mdisk_grps:0
space_allocated to vdisks:0.00MB
total_free_space:1673.3GB
statistics_status:on
statistics_frequency:15
required_memory:8192
cluster_locale:en_US
time_zone:522 UTC
code_level:5.1.0.0
FC_Port_Speed:2Gb
console_IP:9.20.165.12:123
id_alias:1521071282978998
gm_link_tolerance:300
gm_inter_cluster_delay_simulation:0
gm_intra_cluster_delay_simulation:0
email_reply:fred@mycompany.com
email_contact:Fred Higgins
email_contact_primary:01202 123456
email_contact_alternate:44-202-876543-4455
email_contact_location:London Thames Bank
email_state:running
inventory_mail_interval:0
total_vdiskcopy_capacity:40.00GB
total_used_capacity:22.50GB
total_overallocation:67
total_vdisk_capacity:30.00GB
cluster_ntp_ip_address:9.20.199.43
cluster_isns_IP_address:
iscsi_auth_method:none
iscsi_chap_secret:
auth_service_configured:yes
auth_service_enabled:yes
auth_service_url:https://1.2.3.4/login
auth_service_user_name:secadmin
auth_service_pwd_set:yes
auth_service_cert_set:yes
relationship_bandwidth_limit:25
Library | Support | Terms of use | Feedback
© Copyright IBM Corporation 2003, 2009. All Rights Reserved.