YANG API Reference
aaa
AsterNOS Model for Authentication, Accounting, Authorization Path /aaa Node Type container Access Read-Write Path /aaa/accounting Node Type container Description AAA accounting Access Read-Write Path /aaa/accounting/protocol Node Type leaf-list Description AAA accounting protocol. Access Read-Write Data Type \<YANG type enumeration> Constraints Enumeration with options tacacs+ local radius Path /aaa/authentication Node Type container Description AAA authentication Access Read-Write Path /aaa/authentication/protocol Node Type leaf-list Description AAA authentication login mode.
acl
AsterNOS Model for Access Control List Path /access-lists Node Type container Access Read-Write Path /access-lists/access-list Node Type list Access Read-Write Constraints Has local type Path /access-lists/access-list/name Node Type leaf Access Read-Write Data Type \<YANG type string> Constraints String with length 1 to 64 Path /access-lists/access-list/type Node Type leaf Access Read-Write Data Type \<YANG type identityref> Constraints IdentityRef with options CTRLPLANE L3 L3V6 CTRLPLANEV6 Mandatory Yes Path /access-lists/access-list/stage Node Type leaf Access Read-Write Data Type \<YANG type acl-stage> Constraints Enumeration with options ingress egress Path /access-lists/access-list/services Node Type leaf-list Description Only supported on tables where type is ctrlplane. Access Read-Write Data Type \<YANG type identityref> Constraints IdentityRef with options SNMP TELNET SSH NTP Path /access-lists/access-list/description Node Type leaf Access Read-Write Data Type \<YANG type string> Path /access-lists/access-list/bind-intfs Node Type leaf-list Description The acl rule can be bound to either the aggregation port or the Ethernet port to take effect.
arp
AsterNOS YANG Model for Address Resolution Protocol. Path /arp-global Node Type container Access Read-Write Path /arp-global/arp-dynamic-learning Node Type container Description global ARP dynamic learning configuration.
copp
COPP yang module for sonic-mgmt-asterfusion Path /copps Node Type container Description COPP group configuration Access Read-Write Path /copps/copp Node Type list Description List of COPP group Access Read-Write Path /copps/copp/name Node Type leaf Description COPP group class name Access Read-Write Data Type \<YANG type copp-packet-type> Constraints Enumeration with options acl arp bfd bfdv6 bgp default dhcp dhcpv6 eapol ftp iccp icmp igmp ip2me isis mtu error lacp ldp lldp mld ndp ospf ospfv6 pim ptp sample packet snmp snp ssh stp telnet tftp ttl error vrrp vrrpv6 lbdt Path /copps/copp/trap-ids Node Type leaf-list Description Name of trap ids Access Read-Only Data Type \<YANG type identityref> Constraints IdentityRef with options bgp iccp vrrpv6 ospfv6 icmp echo mld v2 report eapol dhcpv6 ssh ip2me lacp mld v1 report arp resp lldp telnet bgpv6 acl igmp query neigh discovery stp snp dhcp sample packet arp req igmp v1 report igmp v3 report bfd isis pim vrrp snmp l3 mtu error ospf ttl error ftp mld v1 done ptp bfdv6 igmp leave ldp mld v1 v2 igmp v2 report tftp lbdt Path /copps/copp/trap-action Node Type leaf Description COPP trap action refers to how a network device responds when it detects traffic that exceeds the configured limits or matches specific policies Access Read-Write Data Type \<YANG type copp-packet-action> Constraints Enumeration with options drop trap copy forward Mandatory Yes Path /copps/copp/trap-priority Node Type leaf Description Trap priority Access Read-Only Data Type \<YANG type uint8> Path /copps/copp/queue Node Type leaf Description CPU Rx queue Access Read-Only Data Type \<YANG type uint8> Constraints Valid range 0 to 7 Path /copps/copp/mode Node Type leaf Description Policer mode Access Read-Only Data Type \<YANG type policy-mode> Constraints Enumeration with options sr-tcm tr-tcm Path /copps/copp/meter-type Node Type leaf Description Policer meter type Access Read-Only Data Type \<YANG type meter-type> Constraints Enumeration with options packets bytes Path /copps/copp/cbs Node Type leaf Description Committed burst size for the dual-rate token bucket policer. This value represents the depth of the token bucket.
crm
AsterNOS YANG Model for Critical Resource Monitoring. Path /crm Node Type container Access Read-Write Path /crm/crm-config Node Type container Description Critical Resource Monitoring for devices.
dai
AsterNOS YANG Model for SAVI. Path /dai Node Type container Description Container for DAI configurations.
datastores
AsterNOS datastore operations Path /copy-config/input Node Type container Access Read-Write Path /copy-config/input/source Node Type leaf Access Read-Write Data Type \<YANG type union> Constraints Multiple constraints The uri type represents a Uniform Resource Identifier (URI) as defined by the rule 'URI' in RFC 3986. Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.
dhcp-relay
AsterNOS YANG Model for dhcp relay. Path /dhcp-relay Node Type container Description DHCP relay.
dhcp-server
AsterNOS YANG Model for dhcp server. Path /dhcp-server Node Type container Access Read-Write Path /dhcp-server/class Node Type list Description class of dhcp server Access Read-Write Path /dhcp-server/class/name Node Type leaf Access Read-Write Data Type \<YANG type string> Path /dhcp-server/class/rule Node Type list Access Read-Write Path /dhcp-server/class/rule/id Node Type leaf Description DHCP server class rule id.
dhcp-snooping
AsterNOS YANG Model for dhcp snooping. Path /dhcp-snooping Node Type container Description dhcp snooping configuration.
disagnosis
This module provides some diagnostic tools for debugging. Path /sdk-shell-enable/input Node Type container Access Read-Write Path /sdk-shell-enable/input/enable Node Type leaf Description If true, enable SDK shell.
fdb
AsterNOS Model for Forwarding Data Base Path /fdb Node Type container Access Read-Write Path /fdb/fdb-entry Node Type list Access Read-Write Constraints Has local type Path /fdb/fdb-entry/mac-address Node Type leaf Description MAC address for the fdb entry Access Read-Write Data Type \<YANG type mac-address> Constraints The mac-address type represents an IEEE 802 MAC address. The canonical representation uses lowercase characters.
hash
AsterNOS YANG Model for HASH. Path /hash Node Type container Description Hash configuration Access Read-Write Path /hash/global Node Type container Description Global hash configuration Access Read-Write Path /hash/global/lag Node Type container Description LAG hash configuration Access Read-Write Path /hash/global/lag/algorithm Node Type leaf Description Hash algorithm for LAG Access Read-Write Data Type \<YANG type identityref> Constraints IdentityRef with options XOR CRC 32LO CRC CRC 32HI Path /hash/global/lag/seed Node Type leaf Description Seed for LAG hash Access Read-Write Data Type \<YANG type uint32> Constraints Multiple constraints Valid range When condition ..
igmp-mld-snooping
Path /igmp-mld-snooping Node Type container Description Config the igmp-snooping and mld-snooping function of the system. Access Read-Write Path /igmp-mld-snooping/global Node Type container Access Read-Write Path /igmp-mld-snooping/global/enabled Node Type leaf Description Enable l2 multicast functionality on system level.
interfaces
AsterNOS YANG Model for interfaces. Path /interfaces Node Type container Description Interface parameters.
ipsg
AsterNOS YANG Model for IPSG. Path /ipsg Node Type container Description Container for IPSG configurations.
isolation-group
AsterNOS YANG Model for Aster NOS Isolation Group. Define a group of ports that are isolated from each other.
kdump
AsterNOS YANG Model for Aster NOS Kdump tools. Path /kdump Node Type container Description Kdump tools configurations.
l2pt
AsterNOS YANG Model for Layer 2 Protocol Tunneling on Ports. Path /l2pts Node Type container Description Configuration of the Layer 2 Protocol Tunneling.
lldp
AsterNOS YANG Model for LLDP(Link Layer Discovery Protocol). Path /lldp-ports Node Type container Description LLDP port MED policy configuration.
local-user
AsterNOS Model for Local user Path /users Node Type container Description Local user. Access Read-Write Path /users/user Node Type list Description The list of user in local.
loopback-detect
AsterNOS Model for loopback-detect Path /loopback-detect Node Type container Access Read-Write Path /loopback-detect/global Node Type container Description Global loop-detect configuration Access Read-Write Path /loopback-detect/global/log-interval Node Type leaf Description The interface loopback detection alarm message transmission interval. Specifies the period at which the information of disabled interfaces is printed.
mgmt-interface
AsterNOS Model for mgmt interface groups Path /mgmt-interfaces Node Type container Description The mgmt-interfaces struct containing all attributes of mgmt-interfaces data set. Access Read-Write Path /mgmt-interfaces/mgmt-interface Node Type list Access Read-Write Path /mgmt-interfaces/mgmt-interface/name Node Type leaf Access Read-Write Data Type \<YANG type string> Path /mgmt-interfaces/mgmt-interface/address Node Type list Description The type of ip-prefix must be same as the type of gw.
mirror
AsterNOS YANG Model for the mirror Path /mirror Node Type container Description Top-level configuration for the mirror. Access Read-Write Path /mirror/session Node Type list Access Read-Write Path /mirror/session/id Node Type leaf Description Identify mirror sessions.
monitor-link
AsterNOS Model for monitor link configuration. Path /monitor-link Node Type container Description Container for monitor link configuration Access Read-Write Path /monitor-link/monitor-link-group Node Type list Description List of monitor link groups Access Read-Write Path /monitor-link/monitor-link-group/name Node Type leaf Description Name of the monitor link group Access Read-Write Data Type \<YANG type string> Path /monitor-link/monitor-link-group/delay Node Type leaf Description Delay in seconds when uplink is up Access Read-Write Data Type \<YANG type uint16> Constraints Valid range 0 to 300 Path /monitor-link/monitor-link-group/members Node Type container Description Container for monitor link group members Access Read-Write Path /monitor-link/monitor-link-group/members/member Node Type list Description List of monitor link group members Access Read-Write Path /monitor-link/monitor-link-group/members/member/port Node Type leaf Description Port or lag name of the monitor link group member Access Read-Write Data Type \<YANG type union> Path /monitor-link/monitor-link-group/members/member/mode Node Type leaf Description Physical ports can be added to the Monitor link group in the uplink or downlink mode.
nd-snooping
AsterNOS YANG Model for ND Snooping. Path /nd-snooping Node Type container Description nd snooping configuration.
ndp
AsterNOS YANG Model for Neighbor Discovery Protocol. Path /ndp-global Node Type container Access Read-Write Path /ndp-global/log-enable Node Type leaf Description Indicates if the ND log is enabled Access Read-Write Data Type \<YANG type boolean> Constraints Valid in \[true, false] Path /nd-mac-check Node Type container Description IPv6 ND MAC check configuration.
nexthop
AsterNOS Model for static routes nexthops Path /nexthop-group Node Type container Description A nexthop-group, represented as a list of nexthop objects. Access Read-Write Path /nexthop-group/nexthop Node Type choice Access Read-Write Mandatory Yes Path /nexthop-group/nexthop/blackhole Node Type choice-case Access Read-Write Path /nexthop-group/nexthop/blackhole/blackhole-nexthop Node Type container Description For blackhole type nexthops, there is only one configurable.
ntp
AsterNOS Model for NTP(Network Time Protocol) Path /ntp-global Node Type container Description Global configuration of ntp Access Read-Write Path /ntp-global/vrf Node Type leaf Description NTP can be enabled only in one VRF at a time. In this revision, it is either default VRF or Management VRF.
pbr
This module describes a YANG model for Policy Based Routing configuration Path /pbr-maps Node Type container Access Read-Write Path /pbr-maps/pbr-map Node Type list Access Read-Write Path /pbr-maps/pbr-map/name Node Type leaf Description Name of pbr map. Access Read-Write Data Type \<YANG type string> Path /pbr-maps/pbr-map/seq Node Type leaf Description Sequence of pbr map entry.
poe
AsterNOS YANG Model for Power Over Ethernet(POE). Path /poe Node Type container Description Config the global POE setting for device Access Read-Write Path /poe/poe max power Node Type leaf Description Set max poe power supply of the system.
portchannels
AsterNOS Model for port-channel groups Path /portchannels Node Type container Access Read-Write Path /portchannels/portchannel Node Type list Description The list of interfaces on the device. Access Read-Write Path /portchannels/portchannel/name Node Type leaf Description The name of the PortChannel and PortChannel sub interface.
ports
AsterNOS YANG Model for ports. Path /ports-global Node Type container Access Read-Write Path /ports-global/link-delay Node Type leaf Description When the physical state of an interface changes from down to up, wait for a period of time before reporting the interface up event to prevent frequent network status changes caused by interface status oscillations Access Read-Write Data Type \<YANG type uint16> Constraints Valid range 2 to 100 Path /?
ptp
AsterNOS Model for ptp groups Path /ptp Node Type container Description The PTP struct containing all attributes of PTP data set, other optional PTP attributes can be augmented as well. Access Read-Write Path /ptp/global Node Type container Access Read-Write Path /ptp/global/enabled Node Type leaf Description PTP status, true means PTP is enabled, false means PTP is disabled Access Read-Write Data Type \<YANG type boolean> Constraints Valid in \[true, false] Path /ptp/global/log-level Node Type leaf Description The log level of the ptp4l level, default is info.
qos
AsterNOS Model for Quality of Service. Path /qos Node Type container Description Top-level container for QoS data.
radius
AsterNOS Model for radius Path /radius Node Type container Description Radius configuration Access Read-Write Path /radius/global Node Type container Description Global radius configuration Access Read-Write Path /radius/global/shared-secret Node Type leaf Description RADIUS global shared secret (Valid chars are ASCII printable except SPACE, "#", and ",") Access Read-Write Data Type \<YANG type string> Constraints String with length 1 to 65 Path /radius/global/auth-type Node Type leaf Description RADIUS global method used for authenticating the comm. mesg.
radv
AsterNOS YANG Model for IPv6 Router Advertisement. Path /global-router-advertisement Node Type container Access Read-Write Path /global-router-advertisement/enabled Node Type leaf Description A flag indicating whether or not the router sends periodic Router Advertisements and responds to Router Solicitations.
raguard
AsterNOS YANG Model for ND Snooping. Path /raguard Node Type container Description raguard configuration.
savi
AsterNOS YANG Model for SAVI. Path /savi Node Type container Description Container for SAVI configurations.
sflow
AsterNOS YANG Model for SAVI. Path /savi Node Type container Description Container for SAVI configurations.
snmp
AsterNOS Model for snmp-agent Path /snmp Node Type container Description SNMP(Simple Network Management Protocol) container support to set snmp-agent Access Read-Write Path /snmp/global Node Type container Description SNMP global configuration. Access Read-Write Path /snmp/global/enabled Node Type leaf Description startup or stop SNMP docker container.
static-route
AsterNOS Model for static routes Path /static-routes Node Type container Access Read-Write Path /static-routes/static-route Node Type list Description List of staticd IP routes. Access Read-Write Path /static-routes/static-route/vrf Node Type leaf Description VRF of staticd IP route.
storm-suppress
This module defines the YANG model for storm suppression configuration. Path /storm-suppress-policies Node Type container Description This container defines the storm suppression configuration.
stp
AsterNOS Model for Multiple Spanning Tree Protocol Path /stp Node Type container Description Top-level grouping for Multi spanning-tree model Access Read-Write Path /stp/global Node Type container Description Global configuration Access Read-Write Path /stp/global/enabled Node Type leaf Description MSTP status, true means MSTP is enabled, false means MSTP is disabled Access Read-Write Data Type \<YANG type boolean> Constraints Valid in \[true, false] Path /stp/global/protocol Node Type leaf Description List of the spanning tree protocols enabled on the device Access Read-Write Data Type \<YANG type stp-protocol-enumeration> Constraints Enumeration with options stp rstp mstp Path /stp/stp Node Type container Description Global configuration Access Read-Write Constraints When condition .. /global/protocol = 'stp' Path /stp/stp/config Node Type container Description Configuration data for STP Access Read-Write Path /stp/stp/config/forward-delay Node Type leaf Description Delay time for device state migration, in seconds, must meet 2 (forward-delay - 1 second) >= max-age Access Read-Write Data Type \<YANG type uint16> Constraints Valid range 4 to 30 Path /stp/stp/config/hello-time Node Type leaf Description MSTP hello time, in seconds Access Read-Write Data Typ \<YANG type uint16> Constraints Valid range 1 to 10 Path /stp/stp/config/max-age Node Type leaf Description A parameter used to determine whether a configuration message has been stored in the device for an out-of-date period of time, and the device will discard the out-of-date configuration message, in seconds, must meet 2 (max-age - 1 second) >= forward-delay Access Read-Write Data Type \<YANG type uint32> Constraints Valid range 6 to 40 Path /stp/stp/config/priority Node Type leaf Description MSTP Region priority, once mstp is enabled the value is set to 8 by default.
syncE
AsterNOS YANG Model for syncE. Path /syncE Node Type container Access Read-Write Path /syncE/syncE Node Type list Description List of syncE data sets of the port.
syslog
AsterNOS Model for syslog Path /syslog Node Type container Description Configuration for the syslog service. Access Read-Write Path /syslog/remote-server Node Type list Access Read-Write Path /syslog/remote-server/ip Node Type leaf Description Remote syslog server ip Access Read-Write Data Type \<YANG type ip-address-no-zone> Constraints Multiple constraints An IPv6 address without a zone index.
system-config
AsterNOS YANG Model for Aster NOS system config. Include DNS server setting.
system-information
AsterNOS YANG Model for the System Information Path /system-info Node Type container Description System information. Access Read-Only Path /system-info/fan-info Node Type list Access Read-Only Path /system-info/fan-info/id Node Type leaf Description Fan ID.
system
Internal configurations of the AsterNOS system. This module is available in the 'meta' datastore.
tacacs
AsterNOS Model for TACACS+ Path /tacacs Node Type container Description Tacacs+ configuration Access Read-Write Path /tacacs/servers Node Type container Access Read-Write Path /tacacs/servers/server Node Type list Access Read-Write Path /tacacs/servers/server/ip Node Type leaf Description TACACS+ server ip Access Read-Write Data Type \<YANG type ip-address-no-zone> Constraints Multiple constraints An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.
time-range
AsterNOS YANG Model for Aster NOS Time Range. Define a period of time, which is in absolute or cyclic type.
traffic-behavior
AsterNOS YANG Model for Transceiver Information. Path /?
user-bind
AsterNOS YANG Model for user-bind. Path /user-bind Node Type container Description Container for user-bind configurations.
vlan-translation
AsterNOS vlan translation module, including VLAN Stack and VLAN mapping. Path /?
vlan
AsterNOS Model for Virtual LAN Path /vlans Node Type container Access Read-Write Path /vlans/vlan Node Type list Access Read-Write Path /vlans/vlan/vlanid Node Type leaf Description VLAN identity Access Read-Write Data Type \<YANG type vlan-id> Constraints Valid range 1 to 4094 Path /vlans/vlan/name Node Type leaf Access Read-Only Data Type \<YANG type string> Path /vlans/vlan/mac-limit Node Type leaf Description Limit the number of dynamic MAC addresses to be learned when the mac number reaches the threshold, dynamic MAC addresses are no longer learned. 0 means no limit.
ietf-netconf-monitoring
NETCONF Monitoring Module. All elements in this module are read-only.