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

New API calls

API calls have been added to this release.

The following NetConf RPC calls have been added:
  urn:vyatta.com:mgmt:ephemerad
  activate input component <value>
  deactivate input component <value>

urn:vyatta.com:mgmt:notifyd
  done input module <value>
  done input notification <value>
  done input script <value>
  list-handlers output collapsed handlers <id>
  list-handlers output collapsed handlers <id> module <value>
  list-handlers output collapsed handlers <id> notification <value>
  list-handlers output collapsed handlers <id> script <value>
  list-handlers output static handlers <id>
  list-handlers output static handlers <id> module <value>
  list-handlers output static handlers <id> notification <value>
  list-handlers output static handlers <id> script <value>
  list-handlers output transient handlers <id>
  list-handlers output transient handlers <id> module <value>
  list-handlers output transient handlers <id> notification <value>
  list-handlers output transient handlers <id> script <value>
  when input module <value>
  when input notification <value>
  when input script <value>

urn:vyatta.com:mgmt:vyatta-service-nat-cgnat
  clear-policy-statistics input policyname <value>
  clear-session-statistics input destination-ip-address-prefix <value>
  clear-session-statistics input destination-port <value>
  clear-session-statistics input interface <value>
  clear-session-statistics input pool-name <value>
  clear-session-statistics input public-ip-address-prefix <value>
  clear-session-statistics input public-port <value>
  clear-session-statistics input session-id <value>
  clear-session-statistics input sub-session-id <value>
  clear-session-statistics input subscriber-ip-address-prefix <value>
  clear-session-statistics input subscriber-port <value>
  clear-sessions input destination-ip-address-prefix <value>
  clear-sessions input destination-port <value>
  clear-subscriber-statistics input ip-address-prefix <value>
  get-session-information input destination-ip-address-prefix <value>
  get-session-information input destination-port <value>
  get-session-information output sessions <id> state-history <value>
  get-session-information output sessions <id> unknown-source <value>
  get-subscriber-information output subscribers <subscriber> assigned-ports <value>
  get-subscriber-information output subscribers <subscriber> bytes-in <value>
  get-subscriber-information output subscribers <subscriber> bytes-out <value>
  get-subscriber-information output subscribers <subscriber> expired <value>
  get-subscriber-information output subscribers <subscriber> packets-in <value>
  get-subscriber-information output subscribers <subscriber> packets-out <value>
  get-subscriber-information output subscribers <subscriber> paired-address <value>
  get-subscriber-information output subscribers <subscriber> session-rate-1m <value>
  get-subscriber-information output subscribers <subscriber> session-rate-1m-max <value>
  get-subscriber-information output subscribers <subscriber> session-rate-1m-max-time <value>
  get-subscriber-information output subscribers <subscriber> session-rate-20s <value>
  get-subscriber-information output subscribers <subscriber> session-rate-5m <value>
  get-subscriber-information output subscribers <subscriber> session-rate-max <value>
  get-subscriber-information output subscribers <subscriber> session-rate-max-time <value>
  get-subscriber-information output subscribers <subscriber> sessions-created <value>
  get-subscriber-information output subscribers <subscriber> sessions-destroyed <value>
  get-subscriber-information output subscribers <subscriber> unknown-source <value>

The following operation state commands have been added to the NetConf API:
  urn:vyatta.com:mgmt:notifyd
  notifyd state concurrency-limit <value>
  notifyd state registered-handlers <value>
  notifyd state scripts-executed <value>

urn:vyatta.com:mgmt:vyatta-service-nat-cgnat
  service nat cgnat policy <policyname> state max-rate-rate <value>
  service nat cgnat policy <policyname> state max-rate-subs <value>
  service nat cgnat policy <policyname> state max-rate-time <value>
  service nat cgnat policy <policyname> state unknown-source <value>
  service nat cgnat state summary packets-hairpinned <value>
  service nat cgnat state summary packets-not-cgnat <value>
  service nat cgnat state summary pcp-fail <value>
  service nat cgnat state summary pcp-ok <value>
  service nat cgnat state summary public-address-mappings-max <value>
  service nat cgnat state summary sessions-3-tuple-active <value>
  service nat cgnat state summary sessions-5-tuple-active <value>
  service nat cgnat state summary sessions-table-full <value>
  service nat cgnat state summary sessions-table-max-size <value>
  service nat cgnat state summary subscribers-max <value>
  service nat cgnat state summary unknown-source <value>

urn:vyatta.com:mgmt:vyatta-service-ptp-broadptp
  service ptp state instance-list <instance-number> servo-ds delay-req-packet-rate <value>
  service ptp state instance-list <instance-number> servo-ds forward-interpacket-jitter <value>
  service ptp state instance-list <instance-number> servo-ds forward-maximum-ipdv <value>
  service ptp state instance-list <instance-number> servo-ds frequency-correction <value>
  service ptp state instance-list <instance-number> servo-ds phase-correction <value>
  service ptp state instance-list <instance-number> servo-ds reverse-interpacket-jitter <value>
  service ptp state instance-list <instance-number> servo-ds reverse-maximum-ipdv <value>
  service ptp state instance-list <instance-number> servo-ds servo-history <index>
  service ptp state instance-list <instance-number> servo-ds servo-history <index> frequency-correction <value>
  service ptp state instance-list <instance-number> servo-ds servo-history <index> phase-correction <value>
  service ptp state instance-list <instance-number> servo-ds servo-history <index> timestamp <value>
  service ptp state instance-list <instance-number> servo-ds sync-packet-rate <value>

Modified API calls

There are no modified API calls in this release.

Obsoleted API calls

API calls have been obsoleted in this release.

 urn:vyatta.com:mgmt:vyatta-system-syslog
  system syslog global
  system syslog global archive files <value>
  system syslog global archive size <value>
  system syslog global facility <tagnode>
  system syslog global facility <tagnode> level <value>
  system syslog global msg regex <value>

Deprecated API calls

API calls have been deprecated in this release.

  urn:vyatta.com:mgmt:vyatta-security-vpn-ipsec
  security vpn ipsec esp-group <tagnode> compression <value>
urn:vyatta.com:mgmt:vyatta-service-nat-cgnat
  service nat cgnat policy <policyname> log session address-group <value>
  service nat cgnat policy <policyname> log session all-subscribers
  service nat cgnat policy <policyname> log session creation
  service nat cgnat policy <policyname> log session deletion
  service nat cgnat policy <policyname> log session periodic <value>
  service nat cgnat policy <policyname> log subscriber
urn:vyatta.com:mgmt:vyatta-service-nat-pool
  service nat pool <poolname> log block-allocation