cluster-cli

This command is supported only on these:

  • ElasticXL Cluster

  • Maestro Security Group

  • Scalable Chassis Security Group

Note - You must run this command in the Expert mode.

Description

  • Shows cluster information.

  • Controls the administrative state of Security Group Members on the specified Site.

  • Controls the administrative state of the specified Site.

Related Commands

Syntax

cluster-cli --help

{cluster-cli set | cset} [-f {json [-p] | widget}]

      members-admin-state

            ids <SGM ID> {up | down}

            local {up | down}

            remote {up | down}

      members-reboot

            ids <Site ID>

            local

            remote}

      sites-admin-state

            ids <Site ID> {up | down}

            local {up | down}

            remote {up | down}

{cluster-cli show | cinfo} [-f {json [-p] | widget}]

            info [-l]

                  connection [--sip <Source IP Address>] [--dip <Destination IP Address>] [--sport <Source Port>] [--dport <Destination Port>] [--proto <Protocol Number>]

                  cpu

                  interfaces

                  overview

                  pnotes

                  policy

                  provision

                  throughput

cluster-cli tui

Shortened commands:

  • The command "cset" is the alias for the command "cluster-cli set"

  • The command "cinfo" is the alias for the command "cluster-cli show info"

  • The command "cconn" is the alias for the command " cluster-cli show info connection"

  • The command "cstat" is the alias for the command "cluster-cli show info overview"

Parameters

Parameter

Description

--help

Shows the built-in help.

-f {json [-p] | widget}

--format {json [-p] | widget}

Specifies the output format:

  • json [-p] - JSON (the parameter "-p" show the "pretty" JSON)

  • widget - tabular format (this is the default)

cluster-cli set members-admin-state

Configures the administrative state of the specified Security Group Members (up or down).

For Gaia gClish, see set cluster members-admin-state.

  • cluster-cli set members-admin-state ids <SGM ID> {up | down}

    Configures the administrative state (up or down) of the specified Security Group Members.

    <SGM IDs> can be:

    • One Security Group Member (for example, 1_1)

    • A comma-separated list of Security Group Members (for example, 1_1,1_4)

    • A range of Security Group Members (for example, 1_1-1_4)

  • cluster-cli set members-admin-state local {up | down}

    Configures the administrative state (up or down) of all all Security Group Members on the local Site (to which you are connected).

  • cluster-cli set members-admin-state remote {up | down}

    Configures the administrative state (up or down) of all Security Group Members on the remote Site.

cluster-cli set members-reboot

Reboots all Security Group Members on the specified Site.

For Gaia gClish, see set cluster members-reboot.

  • cluster-cli set members-reboot ids <SGM ID>

    Reboots the specified Security Group Members.

    <SGM IDs> can be:

    • One Security Group Member (for example, 1_1)

    • A comma-separated list of Security Group Members (for example, 1_1,1_4)

    • A range of Security Group Members (for example, 1_1-1_4)

  • cluster-cli set members-reboot local}

    Reboots all Security Group Members on the local Site, to which you are currently connected.

  • cluster-cli set members-reboot remote}

    Reboots all Security Group Members on the remote Site.

cluster-cli set sites-admin-state

Configures the administrative state of the entire Site (up or down).

For Gaia gClish, see set cluster sites-admin-state.

  • cluster-cli set sites-admin-state ids <Site ID> {up | down}

    Configures the administrative state (up or down) of the entire specified Site:

    • 1 - Applies to Site #1

    • 2 - Applies to Site #2

  • cluster-cli set sites-admin-state local {up | down}

    Configures the administrative state (up or down) of the local Site (to which you are connected).

  • cluster-cli set sites-admin-state remote {up | down}

    Configures the administrative state (up or down) of the remote Site.

cluster-cli show info [-l]

Shows cluster configuration.

The parameter "-l" shows continuous (live) output.

For Gaia gClish, see show cluster info.

cluster-cli show info connection [<Parameters>]

Shows the current cluster connections.

cluster-cli show info [-l] cpu

Shows the CPU usage and the roles of the CPU cores.

cluster-cli show info [-l] interfaces

Shows information about the cluster interfaces:

  • Name

  • IP Address

  • Driver name

  • State

  • Throughput

  • Packet rate

cluster-cli show info [-l] overview

Shows the cluster overview information:

  • State of each Site

  • State of each Security Group Member

  • Throughput

  • Packet rate

  • Connection rate

  • Number of concurrent connections

  • Overall CPU usage

  • CoreXL split (Firewall instances / SND instances)

  • Overall CPU usage for CoreXL Firewall instances and SND instances

  • RAM usage

  • Which Critical Devices report their state as "problem"

  • State of Heart Beat

cluster-cli show info [-l] pnotes

Shows the Critical Devices that report their state as "problem".

cluster-cli show info [-l] policy

Shows information about the installed policy.

cluster-cli show info [-l] provision

Shows the provisioning state of new Security Group Members.

You can see the progress if there are new Security Group Members that are joining the Security Group.

cluster-cli show info [-l] throughput

Shows the traffic throughput for the Management Interfaces and the Sync Interfaces.

cluster-cli tui

Opens the Textual UI:

  1. In the left panel, click the required command.

  2. In the top right panel, click the required option.

  3. In the bottom right panel, examine the syntax.

  4. Press the CTRL +R keys to close the TUI and run the selected command

To close the TUI without running a command, press the CTRL +C or CTRL +D keys.

Examples

[Expert@HostName-ch0x-0x:0]# cluster-cli show info cpu
Member 1_01
┌───────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
│ Range/IDX │ 0       │ 1       │ 2       │ 3       │ 4       │ 5       │ 6       │ 7       │ 8       │ 9       │
├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ 0-9       │ [S] 1   │ [S] 0   │ [S] 0   │ [S] 1   │ [F] 7   │ [F] 12  │ [F] 8   │ [F] 7   │ [F] 6   │ [F] 9   │
│ 10-19     │ [S] 1   │ [S] 0   │ [S] 0   │ [S] 0   │ [F] 7   │ [F] 14  │ [F] 8   │ [F] 9   │ [F] 9   │ [F] 9   │
│ 20-29     │         │         │         │         │         │         │         │         │         │         │
│ 30-39     │         │         │         │         │         │         │         │         │         │         │
└───────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
Member 2_01
┌───────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
│ Range/IDX │ 0       │ 1       │ 2       │ 3       │ 4       │ 5       │ 6       │ 7       │ 8       │ 9       │
├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ 0-9       │ [S] 1   │ [S] 0   │ [S] 0   │ [S] 0   │ [S] 0   │ [S] 0   │ [S] 1   │ [F] 9   │ [F] 10  │ [F] 7   │
│ 10-19     │ [F] 9   │ [F] 4   │ [F] 6   │ [F] 6   │ [F] 4   │ [F] 6   │ [S] 0   │ [S] 0   │ [S] 0   │ [S] 0   │
│ 20-29     │ [S] 0   │ [S] 0   │ [S] 0   │ [F] 4   │ [F] 7   │ [F] 5   │ [F] 7   │ [F] 7   │ [F] 5   │ [F] 6   │
│ 30-39     │ [F] 8   │ [F] 7   │         │         │         │         │         │         │         │         │
└───────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
CPU Type: (F) - FWK, (S) - SND, (O) - Other

[Expert@HostName-ch0x-0x:0]#
 
[Expert@HostName-ch0x-0x:0]# cinfo interfaces
┌───────────────────────────────────── Interfaces ──────────────────────────────────────┐
│                                                                                       │
│  Name       │ IP Address      │ Driver          │ State   │ Throughput │ Packet Rate  │
│ ────────────┼─────────────────┼─────────────────┼─────────┼────────────┼───────────── │
│  ethsBP1-01 │                 │ i40e            │ UP      │ 171.9K     │ 97           │
│  ethsBP1-02 │                 │ i40e            │ UP      │ 554.5K     │ 495          │
│  ethsBP1-03 │                 │ i40e            │ NO LINK │ 0          │ 0            │
│  ethsBP1-04 │                 │ i40e            │ NO LINK │ 0          │ 0            │
│  BPEth0     │                 │ bonding         │ UP      │ 171.9K     │ 97           │
│  BPEth1     │                 │ bonding         │ UP      │ 554.5K     │ 495          │
│  eth1-Mgmt1 │                 │ Pseudo Ethernet │ UP      │ 25.3K      │ 27           │
│  eth2-Mgmt1 │                 │ Pseudo Ethernet │ UP      │ 22.2K      │ 25           │
│  magg1      │ 10.33.25.66/24  │ bonding         │ UP      │ 47.5K      │ 52           │
│  bond2      │                 │ bonding         │ NO LINK │ 0          │ 0            │
│  bond2.222  │ 10.33.222.66/24 │ vlan            │ UP      │ 0          │ 0            │
│  bond2.223  │ 10.33.223.66/24 │ vlan            │ UP      │ 0          │ 0            │
│  eth1-61    │                 │ Pseudo Ethernet │ DOWN    │ 0          │ 0            │
│  ethsBP2-01 │                 │ igb             │ NO LINK │ 0          │ 0            │
│  ethsBP2-02 │                 │ igb             │ NO LINK │ 0          │ 0            │
│  ethsBP2-03 │                 │ igb             │ NO LINK │ 0          │ 0            │
│  ethsBP2-04 │                 │ igb             │ NO LINK │ 0          │ 0            │
│                                                                                       │
└───────────────────────────────────────────────────────────────────────────────────────┘

[Expert@HostName-ch0x-0x:0]#