跳转到内容
AsterNOS
Ask AI

Logical Interface

此内容尚不支持你的语言。

URLs Summary

Section titled “URLs Summary”
URLGETPOSTPATCHPUTDELETE
/rest/v1/rpc/clear-counters-interfaceNYNNN
/rest/v1/rpc/clear-counters-rifNYNNN
/rest/v1/rpc/clear-router-interfaceNYNNN
/rest/v1/rpc/clear-vlan-membershipNYNNN
/rest/v1/running/interfaces/{name}YNYNY
/rest/v1/running/interfaces/{name}/ipv4YYYNY
/rest/v1/running/interfaces/{name}/ipv4/address/{ip-prefix}YYNNY
/rest/v1/running/interfaces/{name}/ipv6YYYNY
/rest/v1/running/interfaces/{name}/ipv6/address/{ip-prefix}YYNNY
/rest/v1/running/interfaces/{name}/statisticsYNNNN
/rest/v1/rpc/show-counters-interfaceNYNNN
/rest/v1/rpc/show-counters-router-interfaceNYNNN
/rest/v1/rpc/show-interfaceNYNNN
/rest/v1/rpc/show-interface-descriptionNYNNN
/rest/v1/rpc/show-interface-errdownNYNNN
/rest/v1/rpc/show-interface-startup-delayNYNNN
/rest/v1/rpc/show-interface-summaryNYNNN
/rest/v1/rpc/show-ip-interfaceNYNNN
/rest/v1/rpc/show-ipv6-interfaceNYNNN
/rest/v1/rpc/show-sub-interfaceNYNNN

Clear router interface

Section titled “Clear router interface”
POST HTTPS://{switch IP}/rest/v1/rpc/clear-router-interface
{
    "interface": "Ethernet1"
}

Clear vlan members for interface

Section titled “Clear vlan members for interface”
POST HTTPS://{switch IP}/rest/v1/rpc/clear-vlan-membership
{
    "interface": "Ethernet1"
}

Get interface statistics

Section titled “Get interface statistics”
GET HTTPS://{switch IP}/rest/v1/running/interfaces/{name}/statistics

Get counters of interface

Section titled “Get counters of interface”
POST HTTPS://{switch IP}/rest/v1/rpc/show-counters-interface
{
    "name": "Ethernet1"
}

response:

{
    "interface": [
        {
            "name": "Ethernet1",
            "state": "down",
            "rx-ok": "0",
            "rx-bps": "0.00 B/s",
            "rx-util": "0.00%",
            "rx-err": "0",
            "rx-drp": "0",
            "rx-ovr": "0",
            "tx-ok": "0",
            "tx-bps": "0.00 B/s",
            "tx-util": "0.00%",
            "tx-err": "0",
            "tx-drp": "0",
            "tx-ovr": "0"
        }
    ]
}

Get counters of router interface

Section titled “Get counters of router interface”
POST HTTPS://{switch IP}/rest/v1/rpc/show-counters-router-interface
{
    "name": "Vlan200"
}

Get interface summary

Section titled “Get interface summary”
POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-summary

response:

{
    "interface": [
        {
            "name": "Ethernet1",
            "lanes": "0",
            "speed": "25G",
            "mtu": 9216,
            "fec": "none",
            "alias": "Y1",
            "interface-mode": "N/A",
            "oper-status": "down",
            "admin-status": "up",
            "transceiver-type": "SFP/SFP+/SFP28",
            "asym-pfc": "N/A"
        },
        {
            "name": "Ethernet2",
            "lanes": "1",
            "speed": "25G",
            "mtu": 9216,
            "fec": "rs",
            "alias": "Y2",
            "interface-mode": "N/A",
            "oper-status": "down",
            "admin-status": "up",
            "transceiver-type": "N/A",
            "asym-pfc": "N/A"
        },
        ......
        {
            "name": "Ethernet56",
            "lanes": "80,81,82,83",
            "speed": "100G",
            "mtu": 9216,
            "fec": "rs",
            "alias": "C8",
            "interface-mode": "N/A",
            "oper-status": "down",
            "admin-status": "up",
            "transceiver-type": "N/A",
            "asym-pfc": "N/A"
        }
    ]
}

Get interface

Section titled “Get interface”
POST HTTPS://{switch IP}/rest/v1/rpc/show-interface
{
    "interface": "Ethernet1"
}

response:

{
    "name": "Ethernet1",
    "admin-status": "up",
    "line-protocol-status": "down",
    "hardware": "Eth",
    "mac-address": "00:01:02:03:04:05",
    "interface-index": "0",
    "description": "N/A",
    "ipv4-assignment-mode": "not-set",
    "ipv6-assignment-mode": "not-set",
    "mtu": 9216,
    "line-speed": "25.0G",
    "auto-negotiation": false,
    "input-statistics": {
        "packets": 0,
        "octets": 0,
        "multicasts": 0,
        "broadcasts": 0,
        "unicasts": 0,
        "errors": 0,
        "discards": 0,
        "crc-errors": 0
    },
    "output-statistics": {
        "packets": 0,
        "octets": 0,
        "multicasts": 0,
        "broadcasts": 0,
        "unicasts": 0,
        "errors": 0,
        "discards": 0
    }
}

Get sub-interface

Section titled “Get sub-interface”
POST HTTPS://{switch IP}/rest/v1/rpc/show-sub-interface
{
    "interface": "Ethernet1.100"
}

response:

{
    "interface": [
        {
            "name": "Ethernet1.100",
            "speed": "25G",
            "mtu": 9216,
            "vlan-id": 100,
            "admin-status": "up",
            "type": "802.1q-encapsulation"
        }
    ]
}

Get interface error down

Section titled “Get interface error down”
POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-errdown

response:

{
    "interface": [
        {
            "name": "Ethernet1",
            "status": "up"
        },
        {
            "name": "Ethernet1.100",
            "status": "up"
        },
        {
            "name": "Ethernet56",
            "status": "up"
        }
    ]
}

Get interface description

Section titled “Get interface description”
POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-description

response:

{
    "interface": [
        {
            "name": "Ethernet1",
            "oper-status": "down",
            "admin-status": "up",
            "alias": "Y1",
            "description": "restapi-test"
        },
        {
            "name": "Ethernet1.100",
            "oper-status": "down",
            "admin-status": "up",
            "alias": "N/A"
        },
        ......
        {
            "name": "Ethernet55",
            "oper-status": "down",
            "admin-status": "up",
            "alias": "C7"
        },
        {
            "name": "Vlan10",
            "oper-status": "up",
            "admin-status": "up",
            "alias": "N/A"
        }
    ]
}

Get interface startup delay

Section titled “Get interface startup delay”
POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-startup-delay

response:

{
    "interface": [
        {
            "name": "Ethernet1",
            "startup-delay": 150
        },
        ......
        {
            "name": "Ethernet56",
            "startup-delay": 150
        }
    ]
}

Get interface ip address

Section titled “Get interface ip address”
POST HTTPS://{switch IP}/rest/v1/rpc/show-ip-interface

response:

{
    "interface": [
        {
            "name": "Ethernet43",
            "master": "",
            "ip-prefix": [
                "43.0.0.1/24"
            ],
            "admin-status": "up",
            "oper-status": "up",
            "bgp-neighbor": "N/A",
            "neighbor-ip": "N/A"
        },
        {
            "name": "Ethernet49",
            "master": "",
            "ip-prefix": [
                "12.1.1.1/24"
            ],
            "admin-status": "up",
            "oper-status": "down",
            "bgp-neighbor": "N/A",
            "neighbor-ip": "N/A"
        },
        {
            "name": "Loopback0",
            "master": "",
            "ip-prefix": [
                "10.1.0.174/32"
            ],
            "admin-status": "up",
            "oper-status": "up",
            "bgp-neighbor": "N/A",
            "neighbor-ip": "N/A"
        },
        {
            "name": "Mgmt0",
            "master": "",
            "ip-prefix": [
                "10.250.0.174/24"
            ],
            "admin-status": "up",
            "oper-status": "up",
            "bgp-neighbor": "N/A",
            "neighbor-ip": "N/A"
        }
    ]
}

Get interface ipv6 address

Section titled “Get interface ipv6 address”
POST HTTPS://{switch IP}/rest/v1/rpc/show-ipv6-interface

response：

{
    "interface": [
        {
            "name": "Ethernet30",
            "master": "",
            "ip-prefix": [
                "2026::1/64"
            ],
            "admin-status": "up",
            "oper-status": "up",
            "bgp-neighbor": "N/A",
            "neighbor-ip": "N/A"
        },
        {
            "name": "Vlan100",
            "master": "",
            "ip-prefix": [
                "2027::2/64"
            ],
            "admin-status": "up",
            "oper-status": "up",
            "bgp-neighbor": "N/A",
            "neighbor-ip": "N/A"
        }
    ]
}

Get all interfaces information

Section titled “Get all interfaces information”
GET HTTPS://{switch IP}/rest/v1/running/interfaces

response：

{
    "result": [
        {
            "name": "Ethernet1",
            "description": "restapi-test",
            "admin-status": true,
            "interface-mode": "none",
            "oper-status": false,
            "mtu": 9216,
            "statistics": {},
            "ethernet-config": {
                "port-speed": "SPEED_25G",
                "fec": "none",
                "lanes": [
                    0
                ],
                "index": 0,
                "alias": "Y1"
            },
            "transceiver": {}
        },
        ......
        {
            "name": "Ethernet10",
            "admin-status": true,
            "interface-mode": "none",
            "oper-status": false,
            "mtu": 9216,
            "statistics": {},
            "ethernet-config": {
                "port-speed": "SPEED_25G",
                "fec": "rs",
                "lanes": [
                    9
                ],
                "index": 9,
                "alias": "Y10"
            },
            "transceiver": {}
        },
        {
            "name": "Vlan100",
            "admin-status": true,
            "interface-mode": "routed",
            "oper-status": true,
            "ipv6-link-local": true,
            "statistics": {},
            "ipv4": {
                "vrrps": [],
                "address": [],
                "neighbor": []
            },
            "ipv6": {
                "router-advertisement": {},
                "vrrps": [],
                "address": [
                    {
                        "ip-prefix": "2027::2/64",
                        "secondary": false
                    }
                ],
                "neighbor": []
            },
            "arp-dynamic-learning": {}
        },
        {
            "name": "Ethernet1.100",
            "admin-status": true,
            "interface-mode": "routed",
            "oper-status": false,
            "mtu": 9216,
            "statistics": {},
            "ipv4": {
                "vrrps": [],
                "address": [],
                "neighbor": []
            },
            "ipv6": {
                "router-advertisement": {},
                "vrrps": [],
                "address": [],
                "neighbor": []
            },
            "arp-dynamic-learning": {}
        },
        {
            "name": "Loopback0",
            "admin-status": true,
            "interface-mode": "routed",
            "oper-status": true,
            "statistics": {},
            "ipv4": {
                "vrrps": [],
                "address": [
                    {
                        "ip-prefix": "10.1.0.174/32",
                        "secondary": false
                    }
                ],
                "neighbor": []
            },
            "ipv6": {
                "router-advertisement": {},
                "vrrps": [],
                "address": [],
                "neighbor": []
            },
            "arp-dynamic-learning": {}
        }
    ]
}

Modify an ethernet interface

Section titled “Modify an ethernet interface”
PATCH HTTPS://{switch IP}/rest/v1/running/interfaces/Ethernet1
{
    "mtu": 1510,
    "mac-address": "00:11:22:33:44:55"
}

Delete a loopback interface

Section titled “Delete a loopback interface”
DELETE HTTPS://{switch IP}/rest/v1/running/interfaces/Loopback100

Create IPv4 address for interface

Section titled “Create IPv4 address for interface”
POST HTTPS://{switch IP}/rest/v1/running/interfaces/Ethernet1/ipv4
{
    "address": [
        {"ip-prefix": "192.168.100.100/20"}
    ]
}

Delete IPv4 address from interface

Section titled “Delete IPv4 address from interface”
DETELE rest/v1/running/interfaces/Ethernet2/ipv4/address/20.1.1.2%2F20

Create an IPv6 address for interface

Section titled “Create an IPv6 address for interface”
POST HTTPS://{switch IP}/rest/v1/running/interfaces/Vlan2345/ipv6/address
{
    "ip-prefix": "fec0::1234/64"
}

Properties Descriptions

Section titled “Properties Descriptions”

Interfaces configurable fields

Section titled “Interfaces configurable fields”

Tree Diagrams

  +--rw interfaces
     +--rw interface* [name]
        +--rw name
        +--rw description?
        +--rw admin-status?
        +--rw interface-mode?
        +--ro oper-status?
        +--rw mac-address?
        +--rw mac-address-learning?
        +--rw mtu?
        +--rw vrf?
        +--rw nat-zone?
        +--rw ipv4
        |  +--rw address* [ip-prefix]
        |  |  +--rw ip-prefix
        |  |  +--rw secondary?
        +--rw ipv6
        |  +--rw address* [ip-prefix]
        |  |  +--rw ip-prefix
        |  |  +--rw secondary?
        +--rw ipv6-link-local?
        +--rw ndp-proxy?
        +--rw pbr-policy?

Table of Properties

NameRequiredType/RangeDescription
interfacesMPath-only node, has no configurable value. Interface parameters.
nameMEthernet name Ethernet sub-interface name Lag1..9999 Link-aggregation sub-interface name Loopback0..199 Vlan1..4094(sub-property of interfaces) The name of the interface.
descriptionCOstring within 255 characters(sub-property of interfaces) Only applicable when name is a Ethernet,Ethernet sub-interface,PortChannel,PortChannel sub-interface name. A textual description of the interface.
admin-statusO”true""false”(sub-property of interfaces) This leaf contains the configured, desired state of the interface. Default value:“true”
interface-modeCO”routed""trunk""none”(sub-property of interfaces) Only applicable when name is a Ethernet,PortChannel,Vlan name. Set the interface to access, trunk, none mode.VLAN and IP interface configuration may be automatically deleted after changing this field.
oper-statusRO”true""false”(sub-property of interfaces) The current operational state of the interface.
mac-addressCOA:B:C:D:E:F(sub-property of interfaces) Only applicable when name is a Ethernet,Ethernet sub-interface,PortChannel,PortChannel sub-interface,VLAN name. The interface’s address at its protocol sub-layer.For example, for an 802.x interface, this object normally contains a Media Access Control (MAC) address.The interface’s media-specific modules must define the bit and byte ordering and the format of the value of this object.For interfaces that do not have such an address (e.g., a serial line), this node is not present.
mac-address-learningCO”true""false”(sub-property of interfaces) Only applicable when name is a Ethernet,PortChannel name. Set interface mac-address learning, only support for vlan and its members.When an interface is configured as a vlan member, mac-address-learning is automatically enabled.Default value:“false”
mtuCO1312..9216(sub-property of interfaces) Only applicable when name is a Ethernet,Ethernet sub-interface,PortChannel,PortChannel sub-interface,VLAN name. Set the max transmission unit size in octets for the physical interface.If this is not set, the mtu is set to the operational default Default value: 9216
vrfO”default” vrf name(sub-property of interfaces) Set interface VRF.
nat-zoneO0..1(sub-property of interfaces) Set interface nat zone (0..1). Default value: 0
ipv4M(sub-property of interfaces) Path-only node, has no configurable value. Parameters for the IPv4 address family.
addressM(sub-property of ipv4) Path-only node, has no configurable value. The list of IPv4 addresses on the interface.
ip-prefixMA.B.C.D/M(sub-property of address)
secondaryCO”true""false”(sub-property of address) Only applicable when name is a Ethernet,Ethernet sub-interface,PortChannel,PortChannel sub-interface,VLAN name. Set secondary IPv6 address for interface. Must set primary IPv6 address in the same network first.Default value:“false”
ipv6M(sub-property of interfaces) Path-only node, has no configurable value. Parameters for the IPv6 address family.
addressM(sub-property of ipv6) Path-only node, has no configurable value. The list of IPv6 addresses on the interface.
ip-prefixMXX:XX:XX:XX:XX:XX:XX:XX/M(sub-property of address)
secondaryCO”true""false”(sub-property of address) Only applicable when name is a Ethernet,Ethernet sub-interface,PortChannel,PortChannel sub-interface,VLAN name. Set secondary IPv6 address for interface. Must set primary IPv6 address in the same network first Default value:“false”
ipv6-link-localCO”true""false”(sub-property of interfaces) Only applicable when name is a Ethernet,Ethernet sub-interface,PortChannel,PortChannel sub-interface,VLAN name. Set ipv6 use link local.When an IPv6 address is configured on the interface, ipv6-link-local is automatically enabled. Default value:“false”
ndp-proxyCO”true""false”(sub-property of interfaces) Only applicable when name is a Ethernet,PortChannel,Vlan name. Set interface NDP proxy. Default value:“false”
pbr-policyCOstring(sub-property of interfaces) Only applicable when name is a Ethernet,PortChannel name. Name of the pbr-map to apply.Only support in ethernet and portchannel, not support subinterface.

Interfaces read-only fields

Section titled “Interfaces read-only fields”

Tree Diagrams

  +--rw interfaces
     +--rw interface* [name]
        +--rw name
        +--ro statistics
           +--ro in-octets?
           +--ro in-unicast-pkts?
           +--ro in-broadcast-pkts?
           +--ro in-multicast-pkts?
           +--ro in-discards?
           +--ro in-errors?
           +--ro out-octets?
           +--ro out-unicast-pkts?
           +--ro out-broadcast-pkts?
           +--ro out-multicast-pkts?
           +--ro out-discards?
           +--ro out-errors?

Table of Properties

NameRequiredType/RangeDescription
interfacesMPath-only node, has no configurable value. Interface parameters.
nameMEthernet name Ethernet sub-interface name PortChannel name PortChannel sub-interface name VLAN name Loopback name(sub-property of interfaces) The name of the interface.
statisticsRO(sub-property of interfaces) Path-only node, has no configurable value. A collection of interface-related statistics objects.
in-octetsROyang:counter64(sub-property of interfaces) The total number of octets received on the interface, including framing characters.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of”discontinuity-time”.
in-unicast-pktsROyang:counter64(sub-property of interfaces) The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were not addressed to a multicast or broadcast address at this sub-layer.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
in-broadcast-pktsROyang:counter64(sub-property of interfaces) The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were addressed to a broadcast address at this sub-layer.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
in-multicast-pktsROyang:counter64(sub-property of interfaces) The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were addressed to a multicast address at this sub-layer.For a MAC-layer protocol, this includes both Group and Functional addresses.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
in-discardsROyang:counter64(sub-property of interfaces) The number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol.One possible reason for discarding such a packet could be to free up buffer space.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
in-errorsROyang:counter64(sub-property of interfaces) For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol.For character- oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
out-octetsROyang:counter64(sub-property of interfaces) The total number of octets transmitted out of the interface, including framing characters.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
out-unicast-pktsROyang:counter64(sub-property of interfaces) The total number of packets that higher-level protocols requested be transmitted and that were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
out-broadcast-pktsROyang:counter64(sub-property of interfaces) The total number of packets that higher-level protocols requested be transmitted and that were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
out-multicast-pktsROyang:counter64(sub-property of interfaces) The total number of packets that higher-level protocols requested be transmitted and that were addressed to a multicast address at this sub-layer, including those that were discarded or not sent.For a MAC-layer protocol, this includes both Group and Functional addresses.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
out-discardsROyang:counter64(sub-property of interfaces) The number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted.One possible reason for discarding such a packet could be to free up buffer space.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.
out-errorsROyang:counter64(sub-property of interfaces) For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors.For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors.Discontinuities in the value of this counter can occur at re-initialization of the management system and at other times as indicated by the value of “discontinuity-time”.

Clear counters interface

Section titled “Clear counters interface”

Tree Diagrams

    +---x clear-counters-interface
    |  +--ro output
    |     +--ro data?

Table of Properties

NameRequiredType/RangeDescription
clear-counters-interfaceMPath-only node, has no configurable value. RPC for clearing interface counters
dataROstring(sub-property of output) the result of clear counters interface.

Clear counters router interface Tree Diagrams

Section titled “Clear counters router interface Tree Diagrams”
    +---x clear-counters-rif
    |  +--ro output
    |     +--ro data?

Table of Properties

NameRequiredType/RangeDescription
clear-counters-rifMPath-only node, has no configurable value. RPC for clearing router interface counters
dataROstring(sub-property of output) the result of clear counters router interface.

Show counters interface

Section titled “Show counters interface”

Tree Diagrams

    +---x show-counters-interface
    |  +---w input
    |  |  +---w name?
    |  |  +---w errors-only?
    |  |  +---w rates-only?
    |  |  +---w raw-stats?
    |  |  +---w period?
    |  |  +---w all?
    |  |  +---w detail?
    |  |  +---w json?
    |  +--ro output
    |     +--ro interface* [name]
    |     |  +--ro name
    |     |  +--ro state?
    |     |  +--ro rx-ok?
    |     |  +--ro rx-bps?
    |     |  +--ro rx-util?
    |     |  +--ro rx-err?
    |     |  +--ro rx-drp?
    |     |  +--ro rx-ovr?
    |     |  +--ro tx-ok?
    |     |  +--ro tx-bps?
    |     |  +--ro tx-util?
    |     |  +--ro tx-err?
    |     |  +--ro tx-drp?
    |     |  +--ro tx-ovr?
    |     +--ro result?

Table of Properties

NameRequiredType/RangeDescription
show-counters-interfaceMPath-only node, has no configurable value.RPC for showing interface counters.
nameOEthernet name Lag Name(sub-property of input)The name of the interface.
errors-onlyO”true""false”(sub-property of input)Display interface errors.
rates-onlyO”true""false”(sub-property of input)Display interface rates.
raw-statsO”true""false”(sub-property of input)Raw stats (unmodified output of netstat).
periodO0..100(sub-property of input)Display stats over a specified period (in seconds), default=0.
allO”true""false”(sub-property of input)Display all the stats counters.
detailO”true""false”(sub-property of input)Display detailed statistics.
jsonO”true""false”(sub-property of input)Display in JSON format.
interfaceRO(sub-property of output)Path-only node, has no configurable value.Structured interface counter output for RPC clients.
nameROstring(sub-property of interface)
stateRO”up""down""not-available”(sub-property of interface)
rx-okROstring(sub-property of interface)
rx-bpsROstring(sub-property of interface)
rx-utilROstring(sub-property of interface)
rx-errROstring(sub-property of interface)
rx-drpROstring(sub-property of interface)
rx-ovrROstring(sub-property of interface)
tx-okROstring(sub-property of interface)
tx-bpsROstring(sub-property of interface)
tx-utilROstring(sub-property of interface)
tx-errROstring(sub-property of interface)
tx-drpROstring(sub-property of interface)
tx-ovrROstring(sub-property of interface)
resultRO(sub-property of output)A table that shows counter of router Interface

Show counters router interface

Section titled “Show counters router interface”

Tree Diagrams

    +---x show-counters-router-interface
    |  +---w input
    |  |  +---w name?
    |  |  +---w period?
    |  |  +---w json?
    |  +--ro output
    |     +--ro interface* [name]
    |     |  +--ro name
    |     |  +--ro rx-ok?
    |     |  +--ro rx-bps?
    |     |  +--ro rx-util?
    |     |  +--ro rx-err?
    |     |  +--ro rx-drp?
    |     |  +--ro rx-ovr?
    |     |  +--ro tx-ok?
    |     |  +--ro tx-bps?
    |     |  +--ro tx-util?
    |     |  +--ro tx-err?
    |     |  +--ro tx-drp?
    |     |  +--ro tx-ovr?
    |     +--ro result?

Table of Properties

NameRequiredType/RangeDescription
show-counters-router-interfaceMPath-only node, has no configurable value.RPC for showing router interface counters.
nameOEthernet name
Ethernet sub-interface name
Lag Name
Lag sub-interface name.Loopback0..199.Vlan1..4094		(sub-property of input)The name of the router interface.
periodO0..100(sub-property of input)Display stats over a specified period (in seconds),default=0.
jsonO”true""false”(sub-property of input)Display in JSON format.
interfaceRO(sub-property of output)Path-only node, has no configurable value.Structured router interface counter output for RPC clients.
nameROstring(sub-property of interface)
rx-okROstring(sub-property of interface)
rx-bpsROstring(sub-property of interface)
rx-utilROstring(sub-property of interface)
rx-errROstring(sub-property of interface)
rx-drpROstring(sub-property of interface)
rx-ovrROstring(sub-property of interface)
tx-okROstring(sub-property of interface)
tx-bpsROstring(sub-property of interface)
tx-utilROstring(sub-property of interface)
tx-errROstring(sub-property of interface)
tx-drpROstring(sub-property of interface)
tx-ovrROstring(sub-property of interface)
resultRO(sub-property of output)A table that shows counter of router Interface

Clear vlan membership for interface

Section titled “Clear vlan membership for interface”

Tree Diagrams

    +---x clear-vlan-membership
    |  +---w input
    |     +---w interface

Table of Properties

NameRequiredType/RangeDescription
clear-vlan-membershipMPath-only node, has no configurable value. Clear VLAN membership of an Ethernet port or link aggregation group. Return an error if the interface is a router interface.
interfaceMstring(sub-property of input) The name of the interface.

Clear router interface

Section titled “Clear router interface”

Tree Diagrams

    +---x clear-router-interface
    |  +---w input
    |     +---w interface

Table of Properties

NameRequiredType/RangeDescription
clear-router-interfaceMPath-only node, has no configurable value. Clear router interface of an Ethernet port or link aggregation group. Return an error if the interface is a VLAN trunk port.
interfaceMstring(sub-property of input) The name of the interface.

Show interface summary

Section titled “Show interface summary”

Tree Diagrams

    +---x show-interface-summary
    |  +--ro output
    |     +--ro interface* [name]
    |        +--ro name
    |        +--ro lanes?
    |        +--ro speed?
    |        +--ro mtu?
    |        +--ro fec?
    |        +--ro alias?
    |        +--ro interface-mode?
    |        +--ro oper-status?
    |        +--ro admin-status?
    |        +--ro transceiver-type?
    |        +--ro asym-pfc?

Table of Properties

NameRequiredType/RangeDescription
show-interface-summaryMPath-only node, has no configurable value.
interfaceRO(sub-property of output)Path-only node, has no configurable value.Structured interface summary for ethernet ports and link aggregations.
nameROEthernet name
Lag Name		(sub-property of interface)The name of the interface.
lanesROstring(sub-property of interface)Comma-separated lanes for ethernet ports, or ‘N/A’ for link aggregations.
speedROstring(sub-property of interface)Operational speed formatted for display, such as ‘100G’ or ‘N/A’.
mtuRO0..65535(sub-property of interface)The MTU of the interface.
fecROstring(sub-property of interface)The FEC mode, or ‘N/A’.
aliasROstring(sub-property of interface)The configured alias, or ‘N/A’.
interface-modeROstring(sub-property of interface)The derived interface mode, such as ‘trunk’, ‘routed’, a parent link aggregation, or ‘N/A’.
oper-statusRO”up""down”(sub-property of interface)The operational status of the interface.
admin-statusRO”up""down”(sub-property of interface)The administrative status of the interface.
transceiver-typeROstring(sub-property of interface)The transceiver type, or ‘N/A’.
asym-pfcROstring(sub-property of interface)The asymmetric PFC state, or ‘N/A’.

Show interface detail information

Section titled “Show interface detail information”

Tree Diagrams

    +---x show-interface
    |  +---w input
    |  |  +---w interface
    |  +--ro output
    |     +--ro name?
    |     +--ro admin-status?
    |     +--ro line-protocol-status?
    |     +--ro hardware?
    |     +--ro mac-address?
    |     +--ro interface-index?
    |     +--ro description?
    |     +--ro ipv4-address?
    |     +--ro ipv4-assignment-mode?
    |     +--ro ipv6-assignment-mode?
    |     +--ro mtu?
    |     +--ro line-speed?
    |     +--ro current-speed?
    |     +--ro auto-negotiation?
    |     +--ro input-statistics
    |     |  +--ro packets?
    |     |  +--ro octets?
    |     |  +--ro multicasts?
    |     |  +--ro broadcasts?
    |     |  +--ro unicasts?
    |     |  +--ro errors?
    |     |  +--ro discards?
    |     |  +--ro crc-errors?
    |     +--ro output-statistics
    |        +--ro packets?
    |        +--ro octets?
    |        +--ro multicasts?
    |        +--ro broadcasts?
    |        +--ro unicasts?
    |        +--ro errors?
    |        +--ro discards?

Table of Properties

NameRequiredType/RangeDescription
show-interfaceMPath-only node, has no configurable value.
interfaceMEthernet name
Lag Name		(sub-property of input)The name of the ethernet or link-aggregation interface.
nameROstring(sub-property of output)The interface name.
admin-statusRO”up""down”(sub-property of output)The administrative status of the interface.
line-protocol-statusRO”up""down”(sub-property of output)The operational line protocol status of the interface.
hardwareROstring(sub-property of output)The interface hardware type.
mac-addressROstring(sub-property of output)The interface MAC address, or N/A.
interface-indexROstring(sub-property of output)The interface index.
descriptionROstring(sub-property of output)The interface description, or N/A.
ipv4-addressROstring(sub-property of output)The primary IPv4 address if configured.
ipv4-assignment-modeROstring(sub-property of output)The IPv4 address assignment mode.
ipv6-assignment-modeROstring(sub-property of output)The IPv6 address assignment mode.
mtuRO0..65535(sub-property of output)The IP MTU in bytes.
line-speedROstring(sub-property of output)The configured interface speed.
current-speedROstring(sub-property of output)The current interface speed for link-aggregation interfaces.
auto-negotiationRO”true""false”(sub-property of output)Whether auto-negotiation is enabled.
input-statisticsRO(sub-property of output)Path-only node, has no configurable value.Input packet statistics.
packetsROuint64(sub-property of input-statistics)
octetsROuint64(sub-property of input-statistics)
multicastsROuint64(sub-property of input-statistics)
broadcastsROuint64(sub-property of input-statistics)
unicastsROuint64(sub-property of input-statistics)
errorsROuint64(sub-property of input-statistics)
discardsROuint64(sub-property of input-statistics)
crc-errorsROuint64(sub-property of input-statistics)
output-statisticsRO(sub-property of output)Path-only node, has no configurable value.Output packet statistics.
packetsROuint64(sub-property of output-statistics)
octetsROuint64(sub-property of output-statistics)
multicastsROuint64(sub-property of output-statistics)
broadcastsROuint64(sub-property of output-statistics)
unicastsROuint64(sub-property of output-statistics)
errorsROuint64(sub-property of output-statistics)
discardsROuint64(sub-property of output-statistics)

Show sub interface

Section titled “Show sub interface”

Tree Diagrams

    +---x show-sub-interface
    |  +---w input
    |  |  +---w interface?
    |  +--ro output
    |     +--ro interface* [name]
    |     |  +--ro name
    |     |  +--ro speed?
    |     |  +--ro mtu?
    |     |  +--ro vlan-id?
    |     |  +--ro admin-status?
    |     |  +--ro type?
    |     +--ro result?

Table of Properties

NameRequiredType/RangeDescription
show-sub-interfaceMPath-only node, has no configurable value.
interfaceOEthernet Sub-interface Name.Lag Sub-interface Name(sub-property of input)The name of the ethernet or link-aggregation sub-interface.
interfaceRO(sub-property of output)Path-only node, has no configurable value.
nameROstring(sub-property of interface)
speedROstring(sub-property of interface)
mtuRO0..65535(sub-property of interface)
vlan-idRO1..4094(sub-property of interface)
admin-statusRO”up""down”(sub-property of interface)
typeROstring(sub-property of interface)
resultRO(sub-property of output)A table that shows sub Interface

Show interface error down

Section titled “Show interface error down”

Tree Diagrams

    +---x show-interface-errdown
    |  +--ro output
    |     +--ro interface* [name]
    |        +--ro name
    |        +--ro status?

Table of Properties

NameRequiredType/RangeDescription
show-interface-errdownMPath-only node, has no configurable value.
interfaceRO(sub-property of output)Path-only node, has no configurable value.
nameROstring(sub-property of interface)
statusRO”up""errdown”(sub-property of interface)

Show interface description

Section titled “Show interface description”

Tree Diagrams

    +---x show-interface-description
    |  +--ro output
    |     +--ro interface* [name]
    |        +--ro name
    |        +--ro oper-status?
    |        +--ro admin-status?
    |        +--ro alias?
    |        +--ro description?

Table of Properties

NameRequiredType/RangeDescription
show-interface-descriptionMPath-only node, has no configurable value.
interfaceRO(sub-property of output)Path-only node, has no configurable value.
nameROstring(sub-property of interface)
oper-statusRO”up""down”(sub-property of interface)
admin-statusRO”up""down”(sub-property of interface)
aliasROstring(sub-property of interface)
descriptionROstring(sub-property of interface)

Show interface startup delay

Section titled “Show interface startup delay”

Tree Diagrams

    +---x show-interface-startup-delay
    |  +--ro output
    |     +--ro interface* [name]
    |        +--ro name
    |        +--ro startup-delay?

Table of Properties

NameRequiredType/RangeDescription
show-interface-startup-delayMPath-only node, has no configurable value.
interfaceRO(sub-property of output)
Path-only node, has no configurable value.
nameROEthernet name(sub-property of interface)
startup-delayRO0..65535(sub-property of interface)

Show interface IPv4 address

Section titled “Show interface IPv4 address”

Tree Diagrams

    +---x show-ip-interface
    |  +--ro output
    |     +--ro interface* [name]
    |        +--ro name
    |        +--ro master?
    |        +--ro ip-prefix*
    |        +--ro admin-status?
    |        +--ro oper-status?
    |        +--ro bgp-neighbor?
    |        +--ro neighbor-ip?

Table of Properties

NameRequiredType/RangeDescription
show-ip-interfaceMPath-only node, has no configurable value.
interfaceRO(sub-property of output)Path-only node, has no configurable value.
nameROstring(sub-property of interface)
masterROstring(sub-property of interface)
ip-prefixROstring(sub-property of interface)IPv4 prefixes configured on the interface.
admin-statusRO”up""down”(sub-property of interface)
oper-statusRO”up""down”(sub-property of interface)
bgp-neighborROstring(sub-property of interface)
neighbor-ipROstring(sub-property of interface)

Show interface IPv6 address

Section titled “Show interface IPv6 address”

Tree Diagrams

    +---x show-ipv6-interface
       +--ro output
          +--ro interface* [name]
             +--ro name
             +--ro master?
             +--ro ip-prefix*
             +--ro admin-status?
             +--ro oper-status?
             +--ro bgp-neighbor?
             +--ro neighbor-ip?

Table of Properties

NameRequiredType/RangeDescription
show-ipv6-interfaceMPath-only node, has no configurable value.
interfaceRO(sub-property of output)Path-only node, has no configurable value.
nameROstring(sub-property of interface)
masterROstring(sub-property of interface)
ip-prefixROstring(sub-property of interface)IPv6 prefixes configured on the interface.
admin-statusRO”up""down”(sub-property of interface)
oper-statusRO”up""down”(sub-property of interface)
bgp-neighborROstring(sub-property of interface)
neighbor-ipROstring(sub-property of interface)