Logical Interface

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/rpc/clear-counters-interface	N	Y	N	N	N
/rest/v1/rpc/clear-counters-rif	N	Y	N	N	N
/rest/v1/rpc/clear-router-interface	N	Y	N	N	N
/rest/v1/rpc/clear-vlan-membership	N	Y	N	N	N
/rest/v1/running/interfaces/{name}	Y	N	Y	N	Y
/rest/v1/running/interfaces/{name}/ipv4	Y	Y	Y	N	Y
/rest/v1/running/interfaces/{name}/ipv4/address/{ip-prefix}	Y	Y	N	N	Y
/rest/v1/running/interfaces/{name}/ipv6	Y	Y	Y	N	Y
/rest/v1/running/interfaces/{name}/ipv6/address/{ip-prefix}	Y	Y	N	N	Y
/rest/v1/running/interfaces/{name}/statistics	Y	N	N	N	N
/rest/v1/rpc/show-counters-interface	N	Y	N	N	N
/rest/v1/rpc/show-counters-router-interface	N	Y	N	N	N
/rest/v1/rpc/show-interface	N	Y	N	N	N
/rest/v1/rpc/show-interface-description	N	Y	N	N	N
/rest/v1/rpc/show-interface-errdown	N	Y	N	N	N
/rest/v1/rpc/show-interface-startup-delay	N	Y	N	N	N
/rest/v1/rpc/show-interface-summary	N	Y	N	N	N
/rest/v1/rpc/show-ip-interface	N	Y	N	N	N
/rest/v1/rpc/show-ipv6-interface	N	Y	N	N	N
/rest/v1/rpc/show-sub-interface	N	Y	N	N	N

Clear router interface

POST HTTPS://{switch IP}/rest/v1/rpc/clear-router-interface
{
    "interface": "Ethernet1"
}

Clear vlan members for interface

POST HTTPS://{switch IP}/rest/v1/rpc/clear-vlan-membership
{
    "interface": "Ethernet1"
}

Get interface statistics

GET HTTPS://{switch IP}/rest/v1/running/interfaces/{name}/statistics

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

POST HTTPS://{switch IP}/rest/v1/rpc/show-counters-router-interface
{
    "name": "Vlan200"
}

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

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

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

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

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

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

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

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

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

PATCH HTTPS://{switch IP}/rest/v1/running/interfaces/Ethernet1
{
    "mtu": 1510,
    "mac-address": "00:11:22:33:44:55"
}

Delete a loopback interface

DELETE HTTPS://{switch IP}/rest/v1/running/interfaces/Loopback100

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

DETELE rest/v1/running/interfaces/Ethernet2/ipv4/address/20.1.1.2%2F20

Create an IPv6 address for interface

POST HTTPS://{switch IP}/rest/v1/running/interfaces/Vlan2345/ipv6/address
{
    "ip-prefix": "fec0::1234/64"
}

Properties Descriptions

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

Name	Required	Type/Range	Description
interfaces	M		Path-only node, has no configurable value.
Interface parameters.
name	M	Ethernet 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.
description	CO	string 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-status	O	”true"
"false”	(sub-property of interfaces)
This leaf contains the configured, desired state of the interface.
Default value: “true”
interface-mode	CO	”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-status	RO	”true"
"false”	(sub-property of interfaces)
The current operational state of the interface.
mac-address	CO	A: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-learning	CO	”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”
mtu	CO	1312..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
vrf	O	”default”
vrf name	(sub-property of interfaces)
Set interface VRF.
nat-zone	O	0..1	(sub-property of interfaces)
Set interface nat zone (0..1).
Default value: 0
ipv4	M		(sub-property of interfaces)
Path-only node, has no configurable value.
Parameters for the IPv4 address family.
address	M		(sub-property of ipv4)
Path-only node, has no configurable value.
The list of IPv4 addresses on the interface.
ip-prefix	M	A.B.C.D/M	(sub-property of address)
secondary	CO	”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	M		(sub-property of interfaces)
Path-only node, has no configurable value.
Parameters for the IPv6 address family.
address	M		(sub-property of ipv6)
Path-only node, has no configurable value.
The list of IPv6 addresses on the interface.
ip-prefix	M	XX:XX:XX:XX:XX:XX:XX:XX/M	(sub-property of address)

| secondary | CO | “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-local | CO | “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-proxy | CO | “true” “false” | (sub-property of interfaces) Only applicable when name is a Ethernet,PortChannel,Vlan name. Set interface NDP proxy. Default value: “false” | | pbr-policy | CO | string | (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 sub interface. |

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

Name	Required	Type/Range	Description
interfaces	M		Path-only node, has no configurable value.
Interface parameters.
name	M	Ethernet name
Ethernet sub-interface name
PortChannel name
PortChannel sub-interface name
VLAN name
Loopback name	(sub-property of interfaces)
The name of the interface.
statistics	RO		(sub-property of interfaces)
Path-only node, has no configurable value.
A collection of interface-related statistics objects.
in-octets	RO	yang: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-pkts	RO	yang: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-pkts	RO	yang: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-pkts	RO	yang: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-discards	RO	yang: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-errors	RO	yang: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-octets	RO	yang: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-pkts	RO	yang: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-pkts	RO	yang: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-pkts	RO	yang: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-discards	RO	yang: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-errors	RO	yang: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

Tree Diagrams

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

Table of Properties

N ame****	Required	Type/Range	Description
clear-counters-interface	M		Path-only node, has no configurable value.
RPC for clearing interface counters
data	RO	string	(sub-property of output)
the result of clear counters interface.

Clear counters router interface Tree Diagrams ```plaintext

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

| ------------------ | ------------ | -------------- | ------------------------------------------------------------------------------------------ |
| clear-counters-rif | M            |                | Path-only node, has no configurable value.
 RPC for clearing router interface counters |
| data               | RO           | string         | (sub-property of output)
 the result of clear counters router interface.               |

### Show counters interface** Tree Diagrams **

```plaintext
    +---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

Name	Required	Type/Range	Description
show-counters-interface	M		Path-only node, has no configurable value.
RPC for showing interface counters.
name	O	Ethernet name
Lag Name	(sub-property of input)
The name of the interface.
errors-only	O	”true"
"false”	(sub-property of input)
Display interface errors.
rates-only	O	”true"
"false”	(sub-property of input)
Display interface rates.
raw-stats	O	”true"
"false”	(sub-property of input)
Raw stats (unmodified output of netstat).
period	O	0..100	(sub-property of input)
Display stats over a specified period (in seconds), default=0.
all	O	”true"
"false”	(sub-property of input)
Display all the stats counters.
detail	O	”true"
"false”	(sub-property of input)
Display detailed statistics.
json	O	”true"
"false”	(sub-property of input)
Display in JSON format.
interface	RO		(sub-property of output)
Path-only node, has no configurable value.
Structured interface counter output for RPC clients.
name	RO	string	(sub-property of interface)

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

Name	Required	Type/Range	Description
show-counters-router-interface	M		Path-only node, has no configurable value.
RPC for showing router interface counters.
name	O	Ethernet 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.
period	O	0..100	(sub-property of input)
Display stats over a specified period (in seconds), default=0.
json	O	”true"
"false”	(sub-property of input)
Display in JSON format.
interface	RO		(sub-property of output)
Path-only node, has no configurable value.
Structured router interface counter output for RPC clients.
name	RO	string	(sub-property of interface)

Clear vlan membership for interface

Tree Diagrams

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

Table of Properties

Name	Required	Type/Range	Description
clear-vlan-membership	M		Path-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.
interface	M	string	(sub-property of input)
The name of the interface.

Clear router interface

Tree Diagrams

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

Table of Properties

Name	Required	Type/Range	Description
clear-router-interface	M		Path-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.
interface	M	string	(sub-property of input)
The name of the interface.

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

Name	Required	Type/Range	Description
show-interface-summary	M		Path-only node, has no configurable value.

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

Name	Required	Type/Range	Description
show-interface	M		Path-only node, has no configurable value.

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

Name	Required	Type/Range	Description
show-sub-interface	M		Path-only node, has no configurable value.

Show interface error down

Tree Diagrams

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

Table of Properties

Name	Required	Type/Range	Description
show-interface-errdown	M		Path-only node, has no configurable value.

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

Name	Required	Type/Range	Description
show-interface-description	M		Path-only node, has no configurable value.

Show interface startup delay

Tree Diagrams

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

Table of Properties

Name	Required	Type/Range	Description
show-interface-startup-delay	M		Path-only node, has no configurable value.
interface	RO		(sub-property of output) Path-only node, has no configurable value.
name	RO	Ethernet name	(sub-property of interface)
startup-delay	RO	0..65535	(sub-property of interface)

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

Name	Required	Type/Range	Description
show-ip-interface	M		Path-only node, has no configurable value.

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

Name	Required	Type/Range	Description
show-ipv6-interface	M		Path-only node, has no configurable value.

Logical Interface

Clear router interface

Clear vlan members for interface

Get interface statistics

Get counters of interface

Get counters of router interface

Get interface summary

Get interface

Get sub-interface

Get interface error down

Get interface description

Get interface startup delay

Get interface ip address

Get interface ipv6 address

Get all interfaces information

Modify an ethernet interface

Delete a loopback interface

Create IPv4 address for interface

Delete IPv4 address from interface

Create an IPv6 address for interface

Properties Descriptions

Interfaces configurable fields

Interfaces read-only fields

Clear counters interface

Clear counters router interface** Tree Diagrams **```plaintext

Show counters router interface

Clear vlan membership for interface

Clear router interface

Show interface summary

Show interface detail information

Show sub interface

Show interface error down

Show interface description

Show interface startup delay

Show interface IPv4 address

Show interface IPv6 address

Clear counters router interface Tree Diagrams ```plaintext