pcm-list-cluster

lists the clusters in a system and provides the detailed information for a cluster

Synopsis

pcm-list-cluster -u username [-p password] [options]

Description

The pcm-list-cluster command is run on the management node.

It provides a summary of the current clusters, including:
  • Cluster name, status, action, author, and account.
It also provides details for a cluster, including:
  • Cluster information such as cluster name, cluster status, author, description, and action
  • Tier information such as tier name, number of servers, and server names
  • Layer information such as names, execution, and status of the pre-provison, post-provion, and server scripts
  • User variable information such as variable names and values

Parameters

-u username
Specifies user account credentials for authentication against Platform Cluster Manager Community Edition, where username is the user name.
-p password
Specifies user account credentials for authentication against Platform Cluster Manager Community Edition, where password is the password of the user. The parameter is optional. If it is not specified, the user is prompted for the password.

Options

-c | --cluster cluster-name
Specifies a cluster, where cluster-name is the name of a cluster.
-h | --help
Displays the pcm-list-cluster command help information.
-v | --version
Displays the pcm-list-cluster command version information.

Examples

  • To see a summary of the existing clusters, issue the following command:
    # pcm-list-cluster -u root -p password

NAME         Status   Action   Author   Account
cluster_01   Active   -        root     AdminAccount
  • To see detailed information for the cluster_01 cluster, issue the following command:
    # pcm-list-cluster -u root -p password -c cluster_01
    Command output:
    CLUSTER_NAME: cluster_01

Summary
-------
Status: Active
Author: root
Account: AdminAccount
Description: -
Action: Provision

Tier
----
Name: Master
Servers: compute5
Number of Servers: 1

Pre-provision layers
  No layers

Server layers
  Layer: Master
  Layer Execution: CREATE
  Layer Execution Status: Executing

Post-provision layers
  No layers

User Variables
--------------
No user variables