orch_stat

This command is supported only on:

  • Maestro Orchestrator

Note - You can run this command in Gaia Clish or in the Expert mode.

Description

Shows information about the Maestro Orchestrator.

Related Commands

Syntax

orch_stat -h
orch_stat -x

orch_stat

      -a

      -A

      -c

      -d

      -D {port | interface | sg | gw} <Object Name> [<Object Name 2> ...]

      -j

      -l

      -L

      -M {port | sg | gw}

      -p

      -q

      -t

      -v

      -V {vlan | port_id | interface | lag_id } <Object Name> [<Object Name 2> ...]

      sample_rate <Number of Seconds> <Object Name> [<Object Name 2> ...]

Parameters

Parameter

Description

-h

--help

Shows the built-in help.

-x

--print_examples

Shows the usage examples.

<Object Name>

Specifies the applicable object for specific commands (you can specify more than one object):

  • To specify a Port Name, use this format:

    <Orchestrator ID>/<Port Label>/<Subport Label>

  • To specify a Port ID, use this format:

    <0xHexDecPortID>

  • To specify a Security Group ID, use this format:

    <Security Group ID>

  • To specify a Security Group Member, use this format:

    <Security Group ID>_<Site ID>_<Security Group Member ID>

  • To specify an Interface Name, use one of these formats:

    • eth<Number>-<Number>

    • eth<Number>-Mgmt<Number>

    • ethsBP<Number>-<Number>

    • SYNC-INT

    • SYNC-EXT

  • To specify a VLAN ID, use this format:

    <VLAN ID>

  • To specify a LAG (Link Aggregation) ID, use this format:

    <0xHexDecLAGID>

-a

--all

Shows all information from all categories.

-A

--authentication

Shows the authentication status for this Orchestrator.

-c

--console

Shows the output in the format that is more suitable for a console connection.

-d

--deployment

Shows the deployment and device data for this Orchestrator.

Shows these columns in the output in the "MHO Device Status" section:

  • Device Type (the hardware model of the Orchestrator)

  • Serial Number (the serial number of the Orchestrator)

  • MAC Address (UID) (the MAC Address of the Orchestrator - the first "Mgmt" port)

Shows these columns in the output in the "MHO Deployment Information" section:

  • MHO ID (Full ID of the Orchestrator - <Site ID>_<Orchestrator ID>)

  • Site ID (ID of the Maestro Site)

  • Member ID (ID of the Orchestrator on its Site)

  • Number of MHOs on site (number of Orchestrators on this Site)

  • Number of Sites (number of Maestro Sites)

-D <Parameters>

--discard_counters <Parameters>

Shows the discard counters for the specified objects.

  • -D port <Port Name of Port ID>

    Specifies a port object.

    To see the Port Names and Port IDs, run "orch_stat --ports".

  • -D sg <Security Group ID>

    Specifies a Security Group object.

  • -D gw <Security Group ID>/<Site ID>/<Security Group Member ID>

    Specifies a Security Group Member object.

-j

--json

Shows output in the JSON format.

-l

--lag

Shows the LAG (Link Aggregation) information.

 

Shows these columns in the output in the "MHO Sync LAGs(Bonds) Status" section:

  • Lag Name (only in verbose output)

  • Lag ID (only in verbose output)

  • Sync Type (Local Site or Remote Site)

  • Status (up or down)

  • Physical Ports (<Orchestrator ID>/<Port ID>/<Split ID>)

  • Ports ID (internal port ID)

  • Logical Port (<Port ID> or <Split ID>)

  • Link State (up or down)

  • Membership State (active or inactive)

  • Host Name (hostname of the remote Orchestrator)

  • Remote Interface (name of the peer interface)

 

Shows these columns in the output in the "Gateway LAGs(Bonds) Status" section:

  • SG (ID of the Security Group)

  • GW (ID of the Security Group Member)

  • Status (up or down)

  • LSP State (forward or drop)

  • Ports ID (internal port ID)

  • Logical Port (<Port ID> or <Split ID>)

  • Physical Ports (<Orchestrator ID>/<Port ID>/<Split ID>)

  • Link State (up or down)

  • Membership State (active or inactive)

  • Serial (serial number of the Security Group Member)

  • Remote Interface (name of the peer interface)

  • Host Name (hostname of the remote Security Group Member)

  • Internal IP

-L

--LLDP

Shows the LLDP information.

The Security Appliances send LLDP packets to the Orchestrator.

Based on these LLDP packets, the Orchestrator maintains the internal database of the Security Appliances and the Orchestrator ports, to which they are connected.

Shows these columns in the output:

  • Physical Port(<Orchestrator ID>/<Port ID>/<Split ID>)

  • Logical Port (<Port ID> or <Split ID>)

  • Hostname (hostname of the Security Group Member)

  • Type ("GW" or "---")

  • ID (serial number of the Security Group Member, only in verbose output)

  • HW Type (hardware model of the Security Group Member)

  • Version (software version of the Security Group Member)

  • State (active or inactive)

  • IP (internal IP address of the Security Group Member)

  • Remote Interface (name of the peer interface, only in verbose output)

-M <Parameters

--traffic_monitor <Parameters

Show live monitoring of throughput and packet rate.

  • -D port <Port Name of Port ID>

    Specifies a port object.

    To see the Port Names and Port IDs, run "orch_stat --ports".

  • -D sg <Security Group ID>

    Specifies a Security Group object.

  • -D gw <Security Group ID>/<Site ID>/<Security Group Member ID>

    Specifies a Security Group Member object.

-p

--ports

Shows information about Orchestrator ports.

Shows these columns in the output:

  • Physical Port (<Orchestrator ID>/<Port ID>/<Split ID>)

  • Logical Port (<Port ID> or <Split ID>, only in verbose output)

  • Port ID (internal port ID, only in verbose output)

  • Interface Name (interface name in Gaia OS)

  • Type (Management, Uplink, Downlink, Site Sync, SSM Sync)

  • SG (ID of the Security Group)

  • QSFP Mode (port speed)

  • Admin State (up or down)

  • Link State (up or down)

  • Transceiver State (plugged or unplugged)

  • Auto Negotiation (enabled or disabled, only in verbose output)

  • Operating Speed

  • MTU

  • RX Frames

  • TX Frames

-q

--quick

Shows only information that is quick to retrieve.

-t

--topology

Shows the topology information for Security Groups.

Also see asg monitor (on Maestro Orchestrator).

-v

--verbose

Shows verbose output.

-V <Parameters

--vlan <Parameters

Shows VLAN assignments.

  • -V vlan {all | <VLAN ID 1> <VLAN ID 2> ... <VLAN ID N>

    Specifies a VLAN ID object.

  • -V port_id {all | <Port ID 1> <Port ID 2> ... <Port ID N>

    Specifies a Port ID object.

    To see the Port IDs, run "orch_stat --ports".

  • -V interface <Name 1> <Name 2> ... <Name N>

    Specifies an interface object.

    The name is one of these:

    • eth<N>-<N>

    • eth<N>-Mgmt<N>

    • ethsBP<N>-<N>

    • SYNC-INT

    • SYNC-EXT

    To see the interface names, run "orch_stat --ports".

  • -V lag_id {all | <LAG ID 1> <LAG ID 2> ... <LAG ID N>

    Specifies a LAG (Link Aggregation) ID object.

    To see the LAG IDs, run "orch_stat --lag".

 

Shows these columns in the output in the "VLAN's ports" section:

  • VLAN ID

  • Port ID (internal port ID)

  • Interface Name

  • Type (Management, Uplink, Downlink)

  • Tagged Member (true or false)

Shows these columns in the output in the "VLAN's LAGs" section:

  • VLAN ID

  • LAG ID

  • LAG Name

  • Tagged Member (true or false)

sample_rate <Parameters

Specifies the interval (in seconds) between samples.

Usage Examples

[Expert@MyOrch_1:0]# orch_stat -x
Usage Examples:
        all: orch_stat -a [-v] [-j]
        authentication: orch_stat -A [-v] [-j]
        deployment: orch_stat -d [-j]
        LLDP: orch_stat -L [-v] [-j]
        ports: orch_stat -p [-v] [-j]
        topology: orch_stat -t [-j]
        discard_counters:
                option 1: orch_stat -D port 1/32/1 1/1/1 [-j]
                option 2: orch_stat -D port all [-j]
                option 3: orch_stat -D interface eth2-Mgmt1 SYNC-EXT ethsBP1-02 eth2-29 [-j]
                option 4: orch_stat -D gw 1_2_1 3_2_1 [-j]
                option 5: orch_stat -D sg 1 2 3
                option 6: orch_stat -D sg all [-j]
        lag:
                option 1: orch_stat [-v] [-j]
                option 2: orch_stat -l [-v] [-j]
        traffic_monitor:
                option 1: orch_stat -M port 2/32/1
                option 2: orch_stat -M gw 1_2_1 3_2_1 [-v]
                option 3: orch_stat -M sg 1 2 3 sample_rate 5 [-v]
        vlan:
                option 1: orch_stat -V port_id 0x13d00 0x11f00 [-v] [-j]
                option 2: orch_stat -V port_id all [-v] [-j]
                option 3: orch_stat -V vlan 1 2 100 [-v] [-j]
                option 4: orch_stat -V vlan all [-v] [-j]
                option 5: orch_stat -V interface  ethsBP1-02 eth2-21 eth1-Mgmt1 SYNC-INT [-v] [-j]
                option 6: orch_stat -V lag_id  0x10000100 0x10000300 [-v] [-j]
                option 7: orch_stat -V lag_id  all [-v] [-j]
        print_examples: orch_stat -x
        console: orch_stat -c [-v]
[Expert@MyOrch_1:0]#

Examples

[Expert@MyOrch_1:0]# orch_stat --deployment

MHO Device Status
+-------------------------------------+---------------+-------------------+
| Device Type                         | Serial Number | MAC Address (UID) |
+-------------------------------------+---------------+-------------------+
| Maestro Hyperscale Orchestrator 170 | xxxxxxxxxx13  | xx:xx:xx:xx:65:00 |
+-------------------------------------+---------------+-------------------+


MHO Deployment Information
+--------+---------+-----------+------------------------+-----------------+
| MHO ID | Site ID | Member ID | Number of MHOs on site | Number of Sites |
+--------+---------+-----------+------------------------+-----------------+
| 1_1    | 1       | 1         | 2                      | 2               |
+--------+---------+-----------+------------------------+-----------------+

[Expert@MyOrch_1:0]#
 
[Expert@MyOrch_1:0]# orch_stat --topology

Security Groups Topology:
        Security Group 1:
                Management IP: 192.168.15.114
                Site 1:
                        Gateway 1: R81.20, Check Point 6600, xxxxxxxxC4
                        Gateway 2: R81.20, Check Point 6600, xxxxxxxx0A
                        Gateway 3: R81.20, Check Point 15400, xxxxxxxx63

                Site 2:
                        Gateway 1: R81.20, Check Point 6600, xxxxxxxx60
                        Gateway 2: R81.20, Check Point 6600, xxxxxxxx61
                        Gateway 3: R81.20, Check Point 15400, xxxxxxxx54

        Security Group 2:
                Management IP: 192.168.15.112
                Site 1:
                        Gateway 1: R81.20, Check Point 9200, xxxxxxxx48

                Site 2:
                        Gateway 1: R81.20, Check Point 9200, xxxxxxxx66

[Expert@MyOrch_1:0]#
 
Expert@MyOrch_1:0]# orch_stat --ports --verbose

Ports Status
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| Physical Port | Logical Port | Port ID | Interface Name | Type      | SG  | QSFP Mode | Admin State | Link State | Transceiver State | Auto Negotiation | Operating Speed | MTU   | RX Frames | TX Frames  |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/1/1         | 1            | 0x1003d | eth1-Mgmt1     | Mgmt      | 1   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 160081654 | 106918354  |
|               |              |         |                |           | 2   |           |             |            |                   |                  |                 |       |           |            |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/2/1         | 2            | 0x1003e | eth1-Mgmt2     | Mgmt      | --- | 10G       | DOWN        | DOWN       | PLUGGED           | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/3/1         | 3            | 0x1003f | eth1-Mgmt3     | Mgmt      | --- | 10G       | DOWN        | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/4/1         | 4            | 0x10040 | eth1-Mgmt4     | Mgmt      | --- | 10G       | DOWN        | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
... ...
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/9/1         | 9            | 0x10035 | eth1-09        | Uplink    | 1   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 136902865 | 22308164   |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/10/1        | 10           | 0x10036 | eth1-10        | Uplink    | 1   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 13937170  | 23350852   |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
... ...
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/25/1        | 25           | 0x10025 | eth1-25        | Uplink    | --- | 10G       | DOWN        | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/26/1        | 26           | 0x10026 | eth1-26        | Uplink    | --- | 10G       | DOWN        | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/27/1        | 27           | 0x10027 | ethsBP1-01     | Downlink  | 2   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 290826396 | 308088637  |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/28/1        | 28           | 0x10028 | ethsBP1-01     | Downlink  | 1   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 503701019 | 983198224  |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/29/1        | 29           | 0x10021 | ethsBP1-01     | Downlink  | 1   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_SR         | 10240 | 205812953 | 854456696  |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/30/1        | 30           | 0x10022 | ---            | Downlink  | --- | 10G       | UP          | DOWN       | PLUGGED           | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/31/1        | 31           | 0x10023 | ethsBP1-01     | Downlink  | 1   | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 297659182 | 1007254275 |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
... ...
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/47/1        | 47           | 0x1000f | SYNC-EXT       | Site Sync | --- | 10G       | UP          | UP         | PLUGGED           | ENABLED          | 10GB_CR         | 10240 | 790125955 | 873548486  |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/48/1        | 48           | 0x10010 | SYNC-INT       | SSM Sync  | --- | 10G       | UP          | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
... ...
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/55/1        | 61           | 0x1001d | eth1-61        | Downlink  | --- | 100G      | DOWN        | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+
| 1/56/1        | 63           | 0x1001f | eth1-63        | Downlink  | --- | 100G      | DOWN        | DOWN       | UNPLUGGED         | ENABLED          | N/A             | 10240 | 0         | 0          |
+---------------+--------------+---------+----------------+-----------+-----+-----------+-------------+------------+-------------------+------------------+-----------------+-------+-----------+------------+

[Expert@MyOrch_1:0]#
 
[Expert@MyOrch_1:0]# orch_stat --LLDP --verbose

LLDP Status
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+
| Physical Port | Logical Port | Hostname           | Type | ID             | HW Type           | Version | State  | IP             | Remote Interface |
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+
| 1/27/1        | 27           | My_SG2-s01-01      | GW   | xxxxxxxx48     | Check Point 9200  | R81.20  | ACTIVE | 198.51.102.1   | ethsBP1-01       |
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+
| 1/28/1        | 28           | My_SG1-s01-01      | GW   | xxxxxxxxC4     | Check Point 6600  | R81.20  | ACTIVE | 198.51.101.1   | ethsBP1-01       |
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+
| 1/29/1        | 29           | My_SG1-s01-03      | GW   | xxxxxxxx63     | Check Point 15400 | R81.20  | ACTIVE | 198.51.101.3   | ethsBP1-01       |
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+
| 1/31/1        | 31           | My_SG1-s01-02      | GW   | xxxxxxxx0A     | Check Point 6600  | R81.20  | ACTIVE | 198.51.101.2   | ethsBP1-01       |
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+
| 1/47/1        | 47           | MyOrch_2           | ---  | ---            | ---               | ---     | ---    | 192.168.15.108 | eth1-Sync-E-47   |
+---------------+--------------+--------------------+------+----------------+-------------------+---------+--------+----------------+------------------+

[Expert@MyOrch_1:0]#
 
[Expert@MyOrch_1:0]# orch_stat --lag --verbose

MHO Sync LAGs(Bonds) Status
+----------+------------+-------------+--------+----------------+----------+--------------+------------+------------------+-------------+------------------+
| Lag Name | Lag ID     | Sync Type   | Status | Physical Ports | Ports ID | Logical Port | Link State | Membership State | Host Name   | Remote Interface |
+----------+------------+-------------+--------+----------------+----------+--------------+------------+------------------+-------------+------------------+
| SYNC-INT | 0x10000000 | Local Site  | DOWN   | 1/48/1         | 0x10010  | 48           | DOWN       | Inactive         | ---         | ---              |
+----------+------------+-------------+--------+----------------+----------+--------------+------------+------------------+-------------+------------------+
| SYNC-EXT | 0x10000001 | Remote Site | UP     | 1/47/1         | 0x1000f  | 47           | UP         | Active           | MyOrch_2    | eth1-Sync-E-47   |
+----------+------------+-------------+--------+----------------+----------+--------------+------------+------------------+-------------+------------------+


Gateway LAGs(Bonds) Status
+----------+------------+----+-----+--------+-----------+----------+--------------+----------------+------------+------------------+----------------+------------------+--------------------+--------------+
| Lag Name | Lag ID     | SG | GW  | Status | LSP State | Ports ID | Logical Port | Physical Ports | Link State | Membership State | Serial         | Remote Interface | Host Name          | Internal IP  |
+----------+------------+----+-----+--------+-----------+----------+--------------+----------------+------------+------------------+----------------+------------------+--------------------+--------------+
| 1_1_1    | 0x10000002 | 1  | 1_1 | UP     | FORWARD   | 0x10028  | 28           | 1/28/1         | UP         | Active           | xxxxxxxxC4     | ethsBP1-01       | My_SG1-s01-01      | 198.51.101.1 |
+----------+------------+----+-----+--------+-----------+----------+--------------+----------------+------------+------------------+----------------+------------------+--------------------+--------------+
| 1_1_2    | 0x10000003 | 1  | 1_2 | UP     | FORWARD   | 0x10023  | 31           | 1/31/1         | UP         | Active           | xxxxxxxx0A     | ethsBP1-01       | My_SG1-s01-02      | 198.51.101.2 |
+----------+------------+----+-----+--------+-----------+----------+--------------+----------------+------------+------------------+----------------+------------------+--------------------+--------------+
| 1_1_3    | 0x10000004 | 1  | 1_3 | UP     | FORWARD   | 0x10021  | 29           | 1/29/1         | UP         | Active           | xxxxxxxx63     | ethsBP1-01       | My_SG1-s01-03      | 198.51.101.3 |
+----------+------------+----+-----+--------+-----------+----------+--------------+----------------+------------+------------------+----------------+------------------+--------------------+--------------+
| 2_1_1    | 0x10000007 | 2  | 1_1 | UP     | FORWARD   | 0x10027  | 27           | 1/27/1         | UP         | Active           | xxxxxxxx48     | ethsBP1-01       | My_SG2-s01-01      | 198.51.102.1 |
+----------+------------+----+-----+--------+-----------+----------+--------------+----------------+------------+------------------+----------------+------------------+--------------------+--------------+

[Expert@MyOrch_1:0]#