Maestro Orchestrator

CPView Gauges

  1. Run: cpview

  2. From the top, click Orchestrator > click the applicable tab.

CLI

See the Scalable Platforms Administration Guide for your version (R82 and higher).

On the Orchestrator, run these commands in the Expert mode:

orch_stat -h

orch_stat --LLDP

orch_stat --lag [--verbose]

orch_stat --ports

Metric Information

Metric ID

Metric Description

Metric Type

Metric Units

Metric Labels

Metric Label Description

orchestrator.deployment.member_id

The Member ID of this Orchestrator on its Maestro Site.

This metric is available in:

  • R82 and higher

Gauge

 

{'device_type', 'serial', 'mac_address', 'site_id'}

  • device_type

    The hardware model of the Orchestrator.

  • serial

    The serial number of the Orchestrator.

  • mac_address

    The MAC address of the Orchestrator.

  • site_id

    The ID of the Maestro Site.

orchestrator.deployment.num_of_mhos_on_site

The number of Orchestrators on this Maestro Site.

This metric is available in:

  • R82 and higher

Gauge

 

{'site_id'}

  • site_id

    The ID of the Maestro Site.

orchestrator.deployment.num_of_sites

The number of Maestro Sites.

This metric is available in:

  • R82 and higher

Gauge

 

{'site_id'}

  • site_id

    The ID of the Maestro Site.

orchestrator.deployment.orchd

The status of the main daemon orchd on this Orchestrator:

  • 0.0 - Down

  • 1.0 - Up (default)

This metric is available in:

  • R82 and higher

Gauge

 

 

 

orchestrator.deployment.site_id

The ID of the Maestro Site.

This metric is available in:

  • R82 and higher

Gauge

 

{'site_id'}

  • site_id

    The ID of the Maestro Site.

orchestrator.lldp

Information about the LLDP messages received from Security Appliances.

This metric is available in:

  • R82 and higher

AsyncCounter

{state}

{'physical_port', 'logical_port', 'hostname', 'type', 'id', 'ip', 'port_id', 'hw_type', 'state', 'version', 'remote_interface'}

  • physical_port

    The ID of the physical port on the Orchestrator (in the format "<Orchestrator ID>/<Port Label>/<Subport Label>").

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

  • hostname

    The hostname of the Security Appliance.

  • type

    The type (role) of port on the Orchestrator ("GW" or "Orchestrator").

  • id

    Either the ID of the Security Appliance, or the Member ID of the Orchestrator on this Maestro Site.

  • ip

    The IP Address of the Security Appliance.

  • port_id

    The internal port ID.

  • hw_type

    The hardware model of the Security Appliance.

  • state

    The state of the Security Appliance ("ACTIVE" or "UNASSIGNED").

  • version

    The software version on the Security Appliance.

  • remote_interface

    The name of the interface on the Security Appliance.

orchestrator.lag

The current states of Bond (LAG) interfaces for communication with peer Orchestrators - on the same site and on the peer site.

This metric is available in:

  • R82 and higher

AsyncUpDownCounter

{state}

{'status', 'lag_id', 'lag_id_full', 'lag_name', 'sync_type', 'hostname', 'link_state', 'logical_port', 'membership_state', 'physical_port', 'port_id'}

  • status

    The status of the Bond interface ("UP" or "DOWN").

  • lag_id

    The LAG ID.

  • lag_id_full

    The LAG full ID.

  • lag_name

    The LAG name ("SYNC-INT" or "SYNC-EXT").

  • sync_type

    The sync type - "Local Site" (internal sync on the same Site) or "Remote Site" (external sync between Sites).

  • hostname

    The hostname of the peer Orchestrator.

  • link_state

    The status of the Bond interface link ("UP" or "DOWN").

  • logical_por

    The logical port ID ("<Port ID>" or "<Split ID>")

  • membership_state

    The LAG Membership State ("Active" or "Inactive").

  • physical_port

    The physical port ID (in the format "<Orchestrator ID>/<Port ID>/<Split ID>").

  • port_id

    The internal port ID.

orchestrator.ports.admin_state

The administrative state of the port on this Orchestrator:

  • 0.0 - Down

  • 1.0 - Up (default)

This metric is available in:

  • R82 and higher

Gauge

{state}

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.labels

General information about the ports on this Orchestrator.

This metric is available in:

  • R82 and higher

Gauge

 

{'name', 'Interface Name', 'Type', 'Security Group', 'Operating Speed', 'QSFP Mode', 'MTU', 'logical_port', 'port_id', 'auto_negotiation'}

  • name

    The name of the port on the Orchestrator.

  • Interface Name

    The name of the interface (in Gaia OS) on the Orchestrator.

  • type

    The type (role) of the port on the Orchestrator ("Mgmt", "Uplink", "Downlink", "SSM Sync" (internal sync), or "Site Sync" (external sync)).

  • Security Group

    The ID of the Security Group, to which this port is assigned.

  • Operating Speed

    The port speed.

  • QSFP Mode

    The QSFP Mode of the port.

  • MTU

    The port MTU.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

  • port_id

    The internal port ID.

  • auto_negotiation

    The auto-negotiation status ("Enabled" or "Disabled").

orchestrator.ports.link_state

The link state of the ports on this Orchestrator.

This metric is available in:

  • R82 and higher

Gauge

{state}

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.transceiver_state

The transceiver state in the port on this Orchestrator:

  • 0.0 - Unplugged

  • 1.0 - Plugged (default)

This metric is available in:

  • R82 and higher

Gauge

{state}

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.rx_bytes_per_second

Received (RX) traffic by the port, in Bytes per second.

This metric is available in:

  • R82 and higher

Gauge

{bytes}/s

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.rx_frames_per_second

Received (RX) traffic by the port, in packets (frames) per second.

This metric is available in:

  • R82 and higher

Gauge

{packets}/s

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.rx_mbit_per_second

Received (RX) traffic by the port, in Megabits per second.

This metric is available in:

  • R82 and higher

Gauge

Mbit/s

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.tx_bytes_per_second

Transmitted (TX) traffic by the port, in Bytes per second.

This metric is available in:

  • R82 and higher

Gauge

{bytes}/s

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.tx_frames_per_second

Transmitted (TX) traffic by the port, in packets (frames) per second.

This metric is available in:

  • R82 and higher

Gauge

{packets}/s

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.ports.tx_mbit_per_second

Transmitted (TX) traffic by the port, in Megabits per second.

This metric is available in:

  • R82 and higher

Gauge

Mbit/s

{'name', 'logical_port'}

  • name

    The name of the port on the Orchestrator.

  • logical_port

    The ID of the logical port on the Orchestrator (number "<Port Label>" from the physical port ID).

orchestrator.sg_lag

The current states of Bond (LAG) interfaces for communication between the Orchestrator and the Security Appliances.

This metric is available in:

  • R82 and higher

AsyncUpDownCounter

{state}

{'status', 'lag_id', 'lag_id_full', 'gw', 'lag_name', 'lsp_state', 'hostname', 'link_state', 'logical_port', 'membership_state', 'physical_port', 'port_id', 'remote_interface', 'serial', 'sg'}

  • status

    The status of the Bond interface ("UP" or "DOWN").

  • lag_id

    The LAG ID.

  • lag_id_full

    The LAG full ID.

  • gw

    The ID of the Security Group Member.

  • lag_name

    The LAG name.

  • lsp_state

    The LSP state ("FORWARD" or "DROP").

  • hostname

    The hostname of the remote Security Group Member.

  • link_state

    The status of the Bond interface link ("UP" or "DOWN").

  • logical_port

    The logical port ID ("<Port ID>" or "<Split ID>").

  • membership_state

    The LAG Membership State ("Active" or "Inactive").

  • physical_port

    The physical port ID (in the format "<Orchestrator ID>/<Port ID>/<Split ID>").

  • port_id

    The internal port ID.

  • remote_interface

    The name of the peer interface.

  • serial

    The serial number of the Security Appliance.

  • sg

    The ID of the Security Group.