Vyatta Network OS Documentation

Learn how to install, configure and operate the Vyatta NOS, which helps drive our virtual networking & physical platforms portfolio.

Show Page Sections

API calls

New and modified API calls have been introduced in this release​​​.

New API calls

A range of new API calls have been added to this release.

The following operational state commands have been added to the NetConf API:
interfaces bonding <interface-name> vif <number> admin-status down
  interfaces bonding <interface-name> vif <number> admin-status testing
  interfaces bonding <interface-name> vif <number> admin-status up
  interfaces bonding <interface-name> vif <number> oper-status dormant
  interfaces bonding <interface-name> vif <number> oper-status down
  interfaces bonding <interface-name> vif <number> oper-status lowerlayerdown
  interfaces bonding <interface-name> vif <number> oper-status notpresent
  interfaces bonding <interface-name> vif <number> oper-status testing
  interfaces bonding <interface-name> vif <number> oper-status unknown
  interfaces bonding <interface-name> vif <number> oper-status up

  interfaces dataplane <interface-name> admin-status down
  interfaces dataplane <interface-name> admin-status testing
  interfaces dataplane <interface-name> admin-status up
  interfaces dataplane <interface-name> oper-status dormant
  interfaces dataplane <interface-name> oper-status down
  interfaces dataplane <interface-name> oper-status lowerlayerdown
  interfaces dataplane <interface-name> oper-status notpresent
  interfaces dataplane <interface-name> oper-status testing
  interfaces dataplane <interface-name> oper-status unknown
  interfaces dataplane <interface-name> oper-status up
  interfaces dataplane <interface-name> vif <number> admin-status down
  interfaces dataplane <interface-name> vif <number> admin-status testing
  interfaces dataplane <interface-name> vif <number> admin-status up
  interfaces dataplane <interface-name> vif <number> oper-status dormant
  interfaces dataplane <interface-name> vif <number> oper-status down
  interfaces dataplane <interface-name> vif <number> oper-status lowerlayerdown
  interfaces dataplane <interface-name> vif <number> oper-status notpresent
  interfaces dataplane <interface-name> vif <number> oper-status testing
  interfaces dataplane <interface-name> vif <number> oper-status unknown
  interfaces dataplane <interface-name> vif <number> oper-status up

  interfaces poe-ports-state ports <name>
  interfaces poe-ports-state ports <name> admin-status <value>
  interfaces poe-ports-state ports <name> available-power <value>
  interfaces poe-ports-state ports <name> class Type1-Class0
  interfaces poe-ports-state ports <name> class Type1-Class1
  interfaces poe-ports-state ports <name> class Type1-Class2
  interfaces poe-ports-state ports <name> class Type1-Class3
  interfaces poe-ports-state ports <name> class Type2-Class0
  interfaces poe-ports-state ports <name> class Type2-Class1
  interfaces poe-ports-state ports <name> class Type2-Class2
  interfaces poe-ports-state ports <name> class Type2-Class3
  interfaces poe-ports-state ports <name> class Type2-Class4
  interfaces poe-ports-state ports <name> consumed-power <value>
  interfaces poe-ports-state ports <name> oper-status <value>

  interfaces switch <name> vif <number> admin-status down
  interfaces switch <name> vif <number> admin-status testing
  interfaces switch <name> vif <number> admin-status up
  interfaces switch <name> vif <number> firewall state in name <group-name>
  interfaces switch <name> vif <number> firewall state in name <group-name> rule <rule-number>
  interfaces switch <name> vif <number> firewall state in name <group-name> rule <rule-number> bytes <value>
  interfaces switch <name> vif <number> firewall state in name <group-name> rule <rule-number> packets <value>
  interfaces switch <name> vif <number> firewall state local name <group-name>
  interfaces switch <name> vif <number> firewall state local name <group-name> rule <rule-number>
  interfaces switch <name> vif <number> firewall state local name <group-name> rule <rule-number> bytes <value>
  interfaces switch <name> vif <number> firewall state local name <group-name> rule <rule-number> packets <value>
  interfaces switch <name> vif <number> firewall state out name <group-name>
  interfaces switch <name> vif <number> firewall state out name <group-name> rule <rule-number>
  interfaces switch <name> vif <number> firewall state out name <group-name> rule <rule-number> bytes <value>
  interfaces switch <name> vif <number> firewall state out name <group-name> rule <rule-number> packets <value>
  interfaces switch <name> vif <number> oper-status dormant
  interfaces switch <name> vif <number> oper-status down
  interfaces switch <name> vif <number> oper-status lowerlayerdown
  interfaces switch <name> vif <number> oper-status notpresent
  interfaces switch <name> vif <number> oper-status testing
  interfaces switch <name> vif <number> oper-status unknown
  interfaces switch <name> vif <number> oper-status up

  interfaces switch-state switches <bridge-name>
  interfaces switch-state switches <bridge-name> ageing-time <value>
  interfaces switch-state switches <bridge-name> bridge-forward-delay <value>
  interfaces switch-state switches <bridge-name> bridge-id <value>
  interfaces switch-state switches <bridge-name> bridge-max-age <value>
  interfaces switch-state switches <bridge-name> designated-root <value>
  interfaces switch-state switches <bridge-name> enabled <value>
  interfaces switch-state switches <bridge-name> forward-delay <value>
  interfaces switch-state switches <bridge-name> hello-time <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name>
  interfaces switch-state switches <bridge-name> interfaces <port-name> admin-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> admin-edge-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> admin-internal-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> admin-point-to-point <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> auto-edge-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> blocking-transitions <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> bpdu-guard-error <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> bpdu-guard-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> bridge-assurance-inconsistent <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> designated-bridge <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> designated-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> designated-internal-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> designated-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> designated-regional-root <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> designated-root <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> disputed <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> edge-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> enabled <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index>
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> mac <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> state permanent
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> state reachable
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> state stale
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> state static
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> updated <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> used <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-database <index> vlan-id <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> forwarding-transitions <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> hello-time <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> internal-port-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> admin-internal-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> designated-bridge <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> designated-internal-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> designated-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> designated-regional-root <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> disputed <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> internal-port-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> port-id <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Alternate
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Backup
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Designated
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Disabled
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Master
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Root
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> role Unknown
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> state blocking
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> state disabled
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> state discarding
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> state forwarding
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> state learning
  interfaces switch-state switches <bridge-name> interfaces <port-name> mstp instance <mstid> state listening
  interfaces switch-state switches <bridge-name> interfaces <port-name> network-port <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> point-to-point <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-cost <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-id <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-no <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-state blocking
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-state disabled
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-state discarding
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-state forwarding
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-state learning
  interfaces switch-state switches <bridge-name> interfaces <port-name> port-state listening
  interfaces switch-state switches <bridge-name> interfaces <port-name> priority <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> received-bridge-pdus <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> received-rstp <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> received-stp <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> received-topology-changes <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Alternate
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Backup
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Designated
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Disabled
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Master
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Root
  interfaces switch-state switches <bridge-name> interfaces <port-name> role Unknown
  interfaces switch-state switches <bridge-name> interfaces <port-name> root-block <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> sent-rstp <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> speed <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> topology-change-ack <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> topology-change-restricted <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> transmitted-bridge-pdus <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> transmitted-topology-changes <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> vlans <vlan-id>
  interfaces switch-state switches <bridge-name> interfaces <port-name> vlans <vlan-id> egress-untagged <value>
  interfaces switch-state switches <bridge-name> interfaces <port-name> vlans <vlan-id> primary-vlan-id <value>
  interfaces switch-state switches <bridge-name> internal-path-cost <value>
  interfaces switch-state switches <bridge-name> last-topology-change-port <value>
  interfaces switch-state switches <bridge-name> max-age <value>
  interfaces switch-state switches <bridge-name> max-hops <value>
  interfaces switch-state switches <bridge-name> mstp default-vlans <value>
  interfaces switch-state switches <bridge-name> mstp digest <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> bridge-id <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> internal-path-cost <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> last-topology-change-port <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> regional-root <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> root-port <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> topology-change-count <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> topology-change-port <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> topology-change-time <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> topology-change <value>
  interfaces switch-state switches <bridge-name> mstp instance <mstid> vlans <value>
  interfaces switch-state switches <bridge-name> mstp name <value>
  interfaces switch-state switches <bridge-name> mstp revision <value>
  interfaces switch-state switches <bridge-name> path-cost <value>
  interfaces switch-state switches <bridge-name> priority <value>
  interfaces switch-state switches <bridge-name> regional-root <value>
  interfaces switch-state switches <bridge-name> root-port <value>
  interfaces switch-state switches <bridge-name> stp-state <value>
  interfaces switch-state switches <bridge-name> stp-version <value>
  interfaces switch-state switches <bridge-name> topology-change-count <value>
  interfaces switch-state switches <bridge-name> topology-change-port <value>
  interfaces switch-state switches <bridge-name> topology-change-time <value>
  interfaces switch-state switches <bridge-name> topology-change <value>
  interfaces switch-state switches <bridge-name> tx-hold-count <value>

  interfaces tunnel <interface-name> admin-status down
  interfaces tunnel <interface-name> admin-status testing
  interfaces tunnel <interface-name> admin-status up
  interfaces tunnel <interface-name> oper-status dormant
  interfaces tunnel <interface-name> oper-status down
  interfaces tunnel <interface-name> oper-status lowerlayerdown
  interfaces tunnel <interface-name> oper-status notpresent
  interfaces tunnel <interface-name> oper-status testing
  interfaces tunnel <interface-name> oper-status unknown
  interfaces tunnel <interface-name> oper-status up

  policy qos state if-list <ifname> shaper subport-list <subport> pipe-list <pipe> traffic-class-queues-list <traffic-class> queue-statistics <queue> priority-local <value>
  policy qos state if-list <ifname> shaper subport-list <subport> pipe-list <pipe> traffic-class-queues-list <traffic-class> queue-statistics <queue> wred-map <res-grp>
  policy qos state if-list <ifname> shaper subport-list <subport> pipe-list <pipe> traffic-class-queues-list <traffic-class> queue-statistics <queue> wred-map <res-grp> random-dscp-drop <value>
  policy qos state if-list <ifname> shaper subport-list <subport> traffic-class-list <traffic-class> wred-map <res-grp>
  policy qos state if-list <ifname> shaper subport-list <subport> traffic-class-list <traffic-class> wred-map <res-grp> random-dscp-drop <value>

  system hardware sensor <name>
  system hardware sensor <name> id <value>
  system hardware sensor <name> oper-status nonoperational
  system hardware sensor <name> oper-status ok
  system hardware sensor <name> oper-status unavailable
  system hardware sensor <name> units-display <value>
  system hardware sensor <name> value-precision <value>
  system hardware sensor <name> value-scale kilo
  system hardware sensor <name> value-scale mega
  system hardware sensor <name> value-scale milli
  system hardware sensor <name> value-scale units
  system hardware sensor <name> value-timestamp <value>
  system hardware sensor <name> value-type celsius
  system hardware sensor <name> value-type other
  system hardware sensor <name> value-type rpm
  system hardware sensor <name> value-type volts
  system hardware sensor <name> value-update-rate <value>
  system hardware sensor <name> value <value>
  system poe-power-state pses <name>
  system poe-power-state pses <name> available-power <value>
  system poe-power-state pses <name> consumed-power <value>
  system poe-power-state pses <name> total-power <value>

Modified API calls

NetConf RPC calls have been modified in this release.

  call input unit <value>
hangup input unit <value>

Deprecated API calls

There are no deprecated API calls in this release.