vxlan

The list of VxLAN interfaces on the device.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
<vxlan> An interface name.

mtu

Set the max transmission unit size in octets.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># mtu <uint32>

promiscuous

Set promiscuous mode.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># promiscuous true|false

description

A textual description of the interface.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># description <string>

enabled

The desired (administrative) state of the interface.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># enabled true|false
Default value
true

vni (mandatory)

Interface VXLAN Network ID. This ID must be unique.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># vni VNI
VNI Type definition representing VXLAN Segment ID / VXLAN Network Identifier value.

group

The group multicast IP address.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># group GROUP
GROUP values Description
<A.B.C.D> An IPv4 multicast group address, which is in the range of 224.0.0.0 to 239.255.255.255.
<X:X::X:X> An IPv6 multicast group address, which is in the range of ff00::/8.

local

The source address that should be used for the Vxlan tunnel. If none is specified an address of the link interface will be used.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># local LOCAL
LOCAL values Description
<A.B.C.D> An IPv4 address.
<X:X::X:X> An IPv6 address.

ttl

The time-to-live (or hop limit) that should be utilised for the IP packets used for the tunnel transport.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># ttl <uint8>

tos

Set the DSCP bits in the Type of Service field.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># tos <uint8>

learning

Enable the registration of unknown source link layer addresses and IP addresses into the VxLAN forwarding database.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># learning true|false
Default value
true

gbp

Enable the Group Policy extension.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># gbp true|false
Default value
false

dst

UDP destination port.

vrouter running config# vrf <vrf> interface vxlan <vxlan>
vrouter running vxlan <vxlan># dst <uint16>
Default value
4789

name (state only)

The name of the interface.

vrouter> show state vrf <vrf> interface vxlan <vxlan> name

ifindex (state only)

System assigned number for each interface. Corresponds to ifIndex object in SNMP Interface MIB.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ifindex

admin-status (state only)

The desired state of the interface. In RFC 7223 this leaf has the same read semantics as ifAdminStatus. Here, it reflects the administrative state as set by enabling or disabling the interface.

vrouter> show state vrf <vrf> interface vxlan <vxlan> admin-status

oper-status (state only)

The current operational state of the interface. This leaf has the same semantics as ifOperStatus.

vrouter> show state vrf <vrf> interface vxlan <vxlan> oper-status

last-change (state only)

This timestamp indicates the time of the last state change of the interface (e.g., up-to-down transition). This corresponds to the ifLastChange object in the standard interface MIB. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

vrouter> show state vrf <vrf> interface vxlan <vxlan> last-change

ethernet

Top-level container for Ethernet configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ethernet

mac-address

Assigns a MAC address to the Ethernet interface. If not specified, the corresponding operational state leaf is expected to show the system-assigned MAC address.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ethernet
vrouter running ethernet# mac-address MAC-ADDRESS
MAC-ADDRESS An IEEE 802 unicast MAC address i.e. the second digit is an even number. Moreover the mac address must not be 00:00:00:00:00:00.

ipv4

Parameters for the IPv4 address family.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4

enabled

Controls whether IPv4 is enabled or disabled on this interface. When IPv4 is enabled, this interface is connected to an IPv4 stack, and the interface can send and receive IPv4 packets.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4
vrouter running ipv4# enabled true|false
Default value
true

address

The list of configured IPv4 addresses on the interface.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4
vrouter running ipv4# address <address> peer PEER
<address> values Description
<A.B.C.D> An IPv4 address.
<A.B.C.D/M> An IPv4 prefix: address and CIDR mask.

peer

The IPv4 address of the remote endpoint for point to point interfaces.

peer PEER
PEER An IPv4 address.

ip (state only)

The IPv4 address on the interface and optionally its prefix.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 address <address> ip

origin (state only)

The origin of this address, e.g., statically configured, assigned by DHCP, etc..

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 address <address> origin

neighbor

A list of mappings from IPv4 addresses to link-layer addresses. Entries in this list are used as static entries in the ARP Cache.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4
vrouter running ipv4# neighbor <neighbor> link-layer-address LINK-LAYER-ADDRESS
<neighbor> An IPv4 address.

ip (state only)

The IPv4 address of the neighbor node.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 neighbor <neighbor> ip

state (state only)

The state of this neighbor entry.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 neighbor <neighbor> state

dhcp

DHCP client configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp

enabled

Enable or disable DHCP.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# enabled true|false
Default value
true

timeout

Time before deciding that it’s not going to be able to contact a server.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# timeout <uint32>
Default value
60

retry

Time before trying again to contact a DHCP server.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# retry <uint32>
Default value
300

select-timeout

Time at which the client stops waiting for other offers from servers.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# select-timeout <uint32>
Default value
0

reboot

Time after trying to reacquire its old address before trying to discover a new address.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# reboot <uint32>
Default value
10

initial-interval

Time between the first attempt to reach a server and the second attempt to reach a server.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# initial-interval <uint32>
Default value
10

dhcp-lease-time

Requested lease time.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# dhcp-lease-time <uint32>
Default value
7200

dhcp-client-identifier-ascii

DHCP client identifier (ASCII).

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# dhcp-client-identifier-ascii <string>

dhcp-client-identifier-hexa

DHCP client identifier (hexadecimal).

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# dhcp-client-identifier-hexa <string>

host-name

DHCP client name.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# host-name <string>

request

DHCP requests.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv4 dhcp
vrouter running dhcp# request REQUEST
REQUEST values Description
subnet-mask Client’s subnet mask.
broadcast-address Broadcast address in use on the client’s subnet.
time-offset Offset of the client’s subnet in seconds from UTC.
routers List of IP addresses for routers on the client’s subnet.
domain-name Domain name used when resolving hostnames with DNS.
domain-search Domain search list used when resolving hostnames with DNS.
domain-name-servers List of DNS name servers available to the client.
host-name Name of the client.
nis-domain Name of the client’s NIS (Sun Network Information Services) domain.
nis-servers List of IP addresses indicating NIS servers available to the client.
ntp-servers List of IP addresses indicating NTP servers available to the client.
interface-mtu MTU to use on this interface.
netbios-name-servers List of RFC 1001/1002 NBNS name servers.
netbios-scope NetBIOS over TCP/IP scope parameter for the client.
Default value
subnet-mask
broadcast-address
time-offset
routers
domain-name
domain-search
domain-name-servers
host-name
nis-domain
nis-servers
ntp-servers
interface-mtu

current-lease (state only)

Current lease.

fixed-address (state only)

The IPv4 address on the interface.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 dhcp current-lease fixed-address
renew (state only)

Time at which the client should begin trying to contact its server to renew its lease.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 dhcp current-lease renew
rebind (state only)

Time at which the client should begin to try to contact any dhcp server to renew its lease.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 dhcp current-lease rebind
expire (state only)

Time at which the client must stop using a lease if it has not been able to renew it.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv4 dhcp current-lease expire

ipv6

Parameters for the IPv6 address family.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv6

enabled

Controls whether IPv6 is enabled or disabled on this interface. When IPv6 is enabled, this interface is connected to an IPv6 stack, and the interface can send and receive IPv6 packets.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv6
vrouter running ipv6# enabled true|false
Default value
true

address

The list of configured IPv6 addresses on the interface.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv6
vrouter running ipv6# address <address> peer PEER
<address> values Description
<X:X::X:X> An IPv6 address.
<X:X::X:X/M> An IPv6 prefix: address and CIDR mask.

peer

The IPv6 address of the remote endpoint for point to point interfaces.

peer PEER
PEER An IPv6 address.

ip (state only)

The IPv6 address on the interface.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv6 address <address> ip

origin (state only)

The origin of this address, e.g., static, dhcp, etc.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv6 address <address> origin

status (state only)

The status of an address. Most of the states correspond to states from the IPv6 Stateless Address Autoconfiguration protocol.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv6 address <address> status

neighbor

List of IPv6 neighbors.

vrouter running config# vrf <vrf> interface vxlan <vxlan> ipv6
vrouter running ipv6# neighbor <neighbor> link-layer-address LINK-LAYER-ADDRESS
<neighbor> An IPv6 address.

ip (state only)

The IPv6 address of the neighbor node.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv6 neighbor <neighbor> ip

router (state only)

Indicates that the neighbor node acts as a router.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv6 neighbor <neighbor> router

state (state only)

The state of this neighbor entry.

vrouter> show state vrf <vrf> interface vxlan <vxlan> ipv6 neighbor <neighbor> state

src-range

Range of UDP source ports.

vrouter running config# vrf <vrf> interface vxlan <vxlan> src-range

<uint16>

Minimal value of source port range.

vrouter running config# vrf <vrf> interface vxlan <vxlan> src-range
vrouter running src-range# <uint16>
Default value
49152

<uint16>

Maximal value of source port range.

vrouter running config# vrf <vrf> interface vxlan <vxlan> src-range
vrouter running src-range# <uint16>
Default value
65535

qos

QoS configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos

ingress

Ingress QoS configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos ingress

rate-limit

Ingress rate limit configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit
policer (config only)

Traffic policer defined in the QoS context.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit
vrouter running rate-limit# policer <leafref>
policer (state only)

Traffic policer.

bandwidth (state only)

Maximum bandwidth of regular traffic, a.k.a. CIR (Committed Information Rate), in bps. 0 allows no regular traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer bandwidth
burst (state only)

Maximum burst size of regular traffic, a.k.a. CBS (Committed Burst Size), in bytes. 0 allows no regular traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer burst
excess-bandwidth (state only)

Maximum bandwidth of excess traffic, a.k.a. EIR (Excess Information Rate), in bps. 0 allows no excess traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer excess-bandwidth
excess-burst (state only)

Maximum burst size of excess traffic, a.k.a. EBS (Excess Burst Size), in bytes. 0 allows no excess traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer excess-burst
stats (state only)

Traffic policer statistics.

pass-packets (state only)

Number of packets passed (regular traffic that conforms to (bandwidth, burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer stats pass-packets
pass-bytes (state only)

Number of bytes passed (regular traffic that conforms to (bandwidth, burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer stats pass-bytes
pass-excess-packets (state only)

Number of excess packets passed (excess traffic that conforms to (excess-bandwidth, excess-burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer stats pass-excess-packets
pass-excess-bytes (state only)

Number of excess bytes passed (excess traffic that conforms to (excess-bandwidth, excess-burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer stats pass-excess-bytes
drop-packets (state only)

Number of packets dropped (traffic that does not conform to bandwidth or excess-bandwidth).

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer stats drop-packets
drop-bytes (state only)

Number of bytes dropped (traffic that does not conform to bandwidth or excess-bandwidth).

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos ingress rate-limit policer stats drop-bytes

egress

Egress QoS configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos egress

rate-limit

Egress rate limit configuration.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos egress rate-limit
policer (config only)

Traffic policer defined in the QoS context.

vrouter running config# vrf <vrf> interface vxlan <vxlan> qos egress rate-limit
vrouter running rate-limit# policer <leafref>
policer (state only)

Traffic policer.

bandwidth (state only)

Maximum bandwidth of regular traffic, a.k.a. CIR (Committed Information Rate), in bps. 0 allows no regular traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer bandwidth
burst (state only)

Maximum burst size of regular traffic, a.k.a. CBS (Committed Burst Size), in bytes. 0 allows no regular traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer burst
excess-bandwidth (state only)

Maximum bandwidth of excess traffic, a.k.a. EIR (Excess Information Rate), in bps. 0 allows no excess traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer excess-bandwidth
excess-burst (state only)

Maximum burst size of excess traffic, a.k.a. EBS (Excess Burst Size), in bytes. 0 allows no excess traffic.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer excess-burst
stats (state only)

Traffic policer statistics.

pass-packets (state only)

Number of packets passed (regular traffic that conforms to (bandwidth, burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer stats pass-packets
pass-bytes (state only)

Number of bytes passed (regular traffic that conforms to (bandwidth, burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer stats pass-bytes
pass-excess-packets (state only)

Number of excess packets passed (excess traffic that conforms to (excess-bandwidth, excess-burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer stats pass-excess-packets
pass-excess-bytes (state only)

Number of excess bytes passed (excess traffic that conforms to (excess-bandwidth, excess-burst) specification.

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer stats pass-excess-bytes
drop-packets (state only)

Number of packets dropped (traffic that does not conform to bandwidth or excess-bandwidth).

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer stats drop-packets
drop-bytes (state only)

Number of bytes dropped (traffic that does not conform to bandwidth or excess-bandwidth).

vrouter> show state vrf <vrf> interface vxlan <vxlan> qos egress rate-limit policer stats drop-bytes

counters (state only)

A collection of interface-related statistics objects.

in-octets (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters in-octets

in-unicast-pkts (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters in-unicast-pkts

in-discards (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters in-discards

in-errors (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters in-errors

out-octets (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters out-octets

out-unicast-pkts (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters out-unicast-pkts

out-discards (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters out-discards

out-errors (state only)

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 ‘last-clear’.

vrouter> show state vrf <vrf> interface vxlan <vxlan> counters out-errors