Vyatta NOS documentation

Learn how to install, configure, and operate Vyatta Network Operating System (Vyatta NOS), which helps to drive our virtual networking and 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 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> 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> 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> 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 <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> tx-hold-count <value>

 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 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

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.