This document describes the YANG data models supported by OcNOS, including the command reference and XML snippets, and provides information on where to find all the documents and YANG files.

The datamodels can be retrieved from the following locations:

• Github

• OcNOS installed devices.

Users can access the YANG data models on GitHub through the following link: GitHub - IPInfusion/OcNOS: OcNOS™ Network Operating System

Note: This link directs to the 'master' branch, which we do not update. To access specific YANG models based on OcNOS release version, follow these steps:

• Click on ‘master’.

• From the dropdown menu, enter a search string, such as "5.1," "6.0.0," or "6.3.0," corresponding to the OcNOS release version for which the YANG models are needed.

• Select the desired version from the dropdown and click to switch the branch.

Before proceeding, refer to the snapshot below to understand how to choose the branch version:

The Yang models are available inside the “yang-files” folder. OcNOS supports two types of Datamodels:

1. IPI Datamodels

2. OpenConfig datamodels

Here is a snapshot for reference:

OcNOS supports the IPI Datamodels, which are considered the 'native' datamodels. These models are used to represent all configurations and operational attributes of OcNOS. The IPI Datamodels adhere to OpenConfig style guidelines, ensuring a clear separation of 'config' and 'state' attributes. User can find these datamodels inside the "yang-files/ipi" folder on GitHub. Here is a snapshot for reference:

To access the Pyang Trees, follow these steps:

1. Scroll down to the bottom of the page and click on “pyang.html”.

2. On the Pyang page, right-click on 'view raw' and choose 'Save link as...' Do not select ‘Download’.

Refer to the snapshot below:

3. After saving the pyang HTML page, user can access the Pyang tree. Once the page is open, scroll down to find the individual datamodel pyang trees. Refer to the snapshot below:

OcNOS supports both native IPI models and OpenConfig standard-defined datamodels. Not all attributes of OpenConfig are supported. Some additional attributes are added in OpenConfig for operational purposes, which are defined in the IPI OpenConfig deviation yang files.

To use OpenConfig datamodels, users must combine IPI deviation files with OpenConfig yang files. Here's how to do it:

• Obtain the deviation files from the "yang-files/openconfig" folder on the IPInfusion GitHub.

• In this folder, a README file contains the OpenConfig SHA1 or version to be used.

• Retrieve the Yang files from the OpenConfig GitHub repository for the version specified in the IPInfusion README.

• After performing the git checkout, find the yang files in the "openconfig/release/models" folder.

Note: If a version is provided (starting in OcNOS 6.4.0), users can directly download the files using the version tag from the GitHub page.

Not all attributes of the OpenConfig datamodels are supported, and there are some variations in the ones that are supported. Detailed information is tabulated in the 'yang deviation' files located within the "yang-files/openconfig" folder.

The Pyang Tree for OpenConfig can also be found on GitHub under "yang-files/openconfig/openconfig.html.

To download the HTML file and open it, follow the same instructions provided in section 2.1.2.1 for IPI Pyang Tree.

This provides a consolidated view of OpenConfig support in OcNOS, including only the attributes that are supported, by incorporating the yang deviations. Refer to the snapshot below for guidance.

After the installation of OcNOS, all Yang models are loaded onto the device and can be found in the following location:

Use the "find" command to explore the available models further.

Document name: OcNOS-[SKU]-NetConf_CmdRef

This document provides detailed information on the XML payload for NetConf, the corresponding CLI, and descriptions of each attribute.

Document name: OpenConfig Command Reference

This document offers insights into the XML payload for OpenConfig, the corresponding OcNOS CLI, and the OcNOS NetConf payload for each attribute.

OcNOS has three different types of Yang datamodels:

• NetConf datamodels

• IPI datamodels

• OpenConfig datamodels

The NetConf datamodels define the functionality of the NetConf protocol itself, along with other utilities required for its functioning.

Here is a list of the Yang files in the NetConf datamodels:

o  ietf-netconf-monitoring.yang

o  ietf-yang-smiv2.yang

o  ietf-interfaces.yang

o  ietf-yang-types.yang

o  ietf-netconf-partial-lock.yang

o  yang-smi.yang

o  iana-if-type.yang

o  ietf-system.yang

o  ietf-inet-types.yang

o  ietf-netconf.yang

o  ietf-netconf-with-defaults.yang

o  iana-crypt-hash.yang

o  nc-notifications.yang

o  ietf-netconf-notifications.yang

o  ietf-netconf-acm.yang

o  yuma-ncx.yang

o  yuma-time-filter.yang

o  yuma-mysession.yang

o  yuma-nacm.yang

o  yuma-netconf.yang

o  yuma-types.yang

o  yuma-xsd.yang

o  yuma-proc.yang

o  yuma-system.yang

o  yuma-app-common.yang

o  netconfd.yang

o  notifications.yang

o  yangcli.yang

The IPI datamodels represent the "native" yang datamodels used in OcNOS. While these datamodels adhere to the OpenConfig style, they have a distinct structure and hierarchy that reflects how data is modeled within OcNOS.

Starting with OcNOS 6.2.0, the OcNOS datamodels are available for ALL features within OcNOS. Depending on user specific OcNOS SKU, use the corresponding feature datamodels. NetConf support is provided for all these datamodels. Additionally, all features developed in OcNOS in future versions will come with built-in datamodels and NetConf support.

Here is a list of the supported Yang files in the IPI OcNOS datamodels:

  ipi-aaa.yang

  ipi-aaa-types.yang

  ipi-acl.yang

  ipi-acl-arp.yang

  ipi-acl-common.yang

  ipi-acl-ipv6.yang

  ipi-acl-mac.yang

  ipi-acl-ports.yang

  ipi-acl-types.yang

  ipi-alarms.yang

  ipi-alarms-types.yang

  ipi-arp.yang

  ipi-arp-types.yang

  ipi-nsm-arp.yang

  ipi-authentication.yang

  ipi-authentication-dot1x-interface.yang

  ipi-authentication-mac-interface.yang

  ipi-authentication-radius.yang

  ipi-authentication-types.yang

  ipi-bfd.yang

  ipi-bfd-common.yang

  ipi-bfd-interface.yang

  ipi-bfd-session.yang

  ipi-bfd-types.yang

  ipi-mpls-bfd-session.yang

  ipi-bgp.yang

  ipi-bgp-address-family.yang

  ipi-bgp-address-family-vrf.yang

  ipi-bgp-common.yang

  ipi-bgp-epe.yang

  ipi-bgp-evpn-rib.yang

 ipi-bgp-flowspec.yang

 ipi-bgp-flowspec-types.yang

  ipi-bgp-instance.yang

  ipi-bgp-link-state.yang

  ipi-bgp-peer.yang

  ipi-bgp-peer-group.yang

  ipi-bgp-types.yang

  ipi-bgp-vrf.yang

  ipi-bridge.yang

  ipi-bridge-types.yang

 ipi-bridge-domain.yang

  ipi-cfm.yang

  ipi-cfm-common.yang

  ipi-cfm-data-types.yang

  ipi-cfm-nvo3-oam.yang

  ipi-cfm-y1731.yang

  cml-data-types.yang

  feature-list.yang

  zebm-cli.yang

  ipi-cross-connect.yang

  ipi-cross-connect-types.yang

  ipi-vlan-xc.yang

  ipi-vlan-xc-types.yang

  ipi-crypto.yang

  ipi-customstats.yang

 ipi-dcb.yang

 ipi-dcb-common.yang

 ipi-dcb-interface.yang

 ipi-dcb-types.yang

  ipi-delay-profile.yang

  ipi-dhcp.yang

  ipi-dhcp-client.yang

  ipi-dhcp-relay.yang

  ipi-dhcp-relay-types.yang

  ipi-dhcp-server.yang

  ipi-dhcp-snooping.yang

  ipi-dhcp-snooping-interface.yang

  ipi-dhcp-snooping-types.yang

  ipi-dns-relay.yang

  ipi-efm.yang

  ipi-efm-types.yang

  ipi-elk.yang

 ipi-enhanced-pbr.yang

 ipi-enhanced-pbr-types.yang

  ipi-erpsv2.yang

  ipi-erpsv2-types.yang

  ipi-ethernet-vpn.yang

 ipi-ethernet-vpn-types.yang

  ipi-event-manager.yang

  ipi-event-manager-types.yang

  ipi-evpn-mpls.yang

  ipi-evpn-mpls-types.yang

  ipi-evpn-srv6.yang

  ipi-g8031.yang

  ipi-g8031-elps.yang

  ipi-g8031-elps-types.yang

  ipi-vm.yang

  ipi-vm-types.yang

 ipi-if-flowspec.yang

  ipi-igp-te.yang

  ipi-if-ethernet.yang

  ipi-if-extended.yang

  ipi-if-ip.yang

  ipi-if-lbd.yang

  ipi-if-types.yang

  ipi-interface.yang

  ipi-ipsec.yang

  ipi-ipsec-interface.yang

  ipi-ipsec-types.yang

  ipi-ip-sla.yang

  ipi-isis.yang

  ipi-isis-cspf.yang

  ipi-isis-extended.yang

  ipi-isis-interface.yang

  ipi-isis-lsp.yang

  ipi-isis-sr.yang

  ipi-isis-types.yang

  ipi-keychain.yang

  ipi-l2vpn-vpls.yang

  ipi-l2vpn-vpws.yang

  ipi-vpls-types.yang

  ipi-vpws-types.yang

  ipi-if-aggregate.yang

  ipi-lacp.yang

  ipi-lacp-types.yang

  ipi-lag-types.yang

  ipi-lb.yang

  ipi-lb-group.yang

  ipi-lb-modem.yang

  ipi-lb-types.yang

  ipi-ldp.yang

  ipi-ldp-interface.yang

  ipi-ldp-l2vpn.yang

  ipi-ldp-peer.yang

  ipi-ldp-types.yang

  ipi-license.yang

  ipi-license-types.yang

  ipi-lldp-types.yang

  ipi-lldpv2.yang

 ipi-macsec.yang

 ipi-macsec-interface.yang

 ipi-macsec-types.yang

  ipi-management-server.yang

  ipi-management-server-notification.yang

  ipi-management-server-notification-types.yang

 ipi-management-server-types.yang

  ipi-mcec.yang

  ipi-mcec-types.yang

  ipi-mlag.yang

  ipi-mlag-types.yang

  ipi-mpls.yang

  ipi-mpls-bfd.yang

  ipi-mpls-rib.yang

  ipi-mpls-types.yang

  ipi-igmp.yang

  ipi-igmp-groups.yang

  ipi-igmp-interface.yang

  ipi-igmp-snooping.yang

  ipi-igmp-snooping-types.yang

  ipi-igmp-types.yang

  ipi-mld.yang

  ipi-mld-groups.yang

  ipi-mld-interface.yang

  ipi-mld-snooping.yang

  ipi-mld-snooping-types.yang

  ipi-mld-types.yang

  ipi-mrib.yang

  ipi-mrib-common.yang

  ipi-mrib-ipv4.yang

  ipi-mrib-ipv6.yang

  ipi-mrib-types.yang

  ipi-network-address-translation.yang

  ipi-network-address-translation-interface.yang

  ipi-network-address-translation-types.yang

  ipi-nd-types.yang

  ipi-neighbor-discovery.yang

  ipi-nsm-neighbor-discovery.yang

  ipi-network-instance.yang

  ipi-network-instance-types.yang

  ipi-ntp.yang

  ipi-ntp-types.yang

  ipi-object-tracking.yang

  ipi-object-tracking-types.yang

  ipi-ospf.yang

 ipi-ospf-area.yang

  ipi-ospf-authentication.yang

  ipi-ospf-debug.yang

  ipi-ospf-distribute-lists.yang

  ipi-ospf-global.yang

  ipi-ospf-interface.yang

 ipi-ospf-interface-common.yang

  ipi-ospf-interface-tracking.yang

  ipi-ospf-interface-tracking-types.yang

  ipi-ospf-multi-area-interface.yang

  ipi-ospf-processes-state.yang

  ipi-ospf-redistribute.yang

  ipi-ospf-te-link.yang

  ipi-ospf-timers.yang

  ipi-ospf-types.yang

  ipi-ospfv3.yang

  ipi-ospfv3-address-family.yang

  ipi-ospfv3-area.yang

  ipi-ospfv3-area-state.yang

  ipi-ospfv3-debug.yang

  ipi-ospfv3-distribute-list.yang

  ipi-ospfv3-global.yang

  ipi-ospfv3-interface.yang

  ipi-ospfv3-interface-state.yang

  ipi-ospfv3-process-state.yang

  ipi-ospfv3-redistribute.yang

  ipi-ospfv3-types.yang

  ipi-pbr.yang

  ipi-pcep.yang

  ipi-pcep-lsp.yang

 ipi-pcep-peer.yang

  ipi-pcep-stats.yang

  ipi-pcep-types.yang

 ipi-pim.yang

 ipi-pim-debug.yang

 ipi-pim-ipv4.yang

 ipi-pim-ipv4-bidir.yang

 ipi-pim-ipv4-debug.yang

 ipi-pim-ipv4-interface.yang

 ipi-pim-ipv4-msdp.yang

 ipi-pim-ipv4-redundancy.yang

 ipi-pim-ipv4-types.yang

 ipi-pim-ipv6.yang

 ipi-pim-ipv6-debug.yang

 ipi-pim-ipv6-interface.yang

 ipi-pim-ipv6-state.yang

 ipi-pim-ipv6-types.yang

  ipi-ping.yang

  ipi-ping-types.yang

  ipi-platform.yang

  ipi-platform-ceragon.yang

 ipi-platform-ceragon-types.yang

  ipi-platform-chassis.yang

  ipi-platform-cmis.yang

  ipi-platform-cmis-types.yang

  ipi-platform-cpu.yang

 ipi-platform-edfa.yang

  ipi-platform-fan.yang

  ipi-platform-fan-tray.yang

  ipi-platform-linecard.yang

  ipi-platform-port.yang

  ipi-platform-power-rail.yang

  ipi-platform-power-supply.yang

  ipi-platform-profile.yang

  ipi-platform-profile-extended.yang

  ipi-platform-ram.yang

  ipi-platform-sff8024-types.yang

 ipi-platform-smart-sfp.yang

  ipi-platform-storage.yang

  ipi-platform-temperature.yang

  ipi-platform-terminal-device.yang

  ipi-platform-terminal-device-types.yang

  ipi-platform-transceiver.yang

 ipi-platform-transceiver-smart-sfp.yang

  ipi-platform-transceiver-tibit.yang

  ipi-platform-transceiver-tibit-types.yang

  ipi-platform-transceiver-types.yang

  ipi-platform-types.yang

  ipi-transport-line-common.yang

  ipi-pon.yang

  ipi-pon-flow.yang

  ipi-pon-olt.yang

  ipi-pon-onu.yang

  ipi-pon-onu-software-upgrade.yang

  ipi-pon-profile.yang

  ipi-pon-profile-onu.yang

  ipi-pon-profile-translation.yang

  ipi-pon-types.yang

  ipi-port-breakout.yang

  ipi-port-breakout-interface.yang

  ipi-port-breakout-types.yang

  ipi-port-mirror.yang

  ipi-port-mirror-types.yang

  ipi-prefix-list.yang

  ipi-prefix-list-types.yang

  ipi-ptp.yang

  ipi-ptp-notifications.yang

  ipi-ptp-types.yang

 ipi-hwtable.yang

  ipi-qos.yang

  ipi-qos-if.yang

  ipi-qos-types.yang

  ipi-radius.yang

  ipi-radius-types.yang

  ipi-ras.yang

  ipi-rib.yang

  ipi-rib-common.yang

  ipi-rib-types.yang

  ipi-rib-vrf.yang

  ipi-rip.yang

  ipi-rip-common.yang

  ipi-rip-types.yang

  ipi-rip-vrf.yang

  ipi-ripng.yang

  ipi-ripng-common.yang

  ipi-ripng-types.yang

  ipi-ripng-vrf.yang

  ipi-routemap.yang

  ipi-routemap-types.yang

  ipi-rsvp.yang

  ipi-rsvp-interface.yang

  ipi-rsvp-session.yang

  ipi-rsvp-trunk.yang

  ipi-rsvp-types.yang

  ipi-ipv6-router-adv.yang

  ipi-sbfd-types.yang

  ipi-seamless-bfd.yang

  ipi-segment-routing.yang

 ipi-segment-routing-odn.yang

  ipi-sr-types.yang

  ipi-service-map.yang

  ipi-service-map-types.yang

  ipi-sflow.yang

  ipi-sflow-interface.yang

  ipi-sflow-types.yang

  ipi-source-interface.yang

  ipi-source-interface-types.yang

 ipi-streaming-telemetry.yang

  ipi-synce.yang

  ipi-synce-types.yang

  ipi-dns-client.yang

 ipi-host.yang

  ipi-logging.yang

  ipi-logging-cli.yang

  ipi-logging-fault-management.yang

  ipi-logging-remote.yang

  ipi-logging-types.yang

  ipi-network-services-manager.yang

  ipi-network-services-manager-types.yang

  ipi-snmp.yang

  ipi-snmp-server.yang

  ipi-snmp-server-extended.yang

  ipi-snmp-server-extended-types.yang

  ipi-snmp-types.yang

  ipi-ssh.yang

  ipi-ssh-types.yang

  ipi-sys-mgmt.yang

  ipi-sys-notifications.yang

  ipi-system.yang

  ipi-sys-update.yang

  ipi-sys-update-types.yang

  ipi-telnet.yang

  ipi-user-session.yang

  ipi-user-session-management.yang

  ipi-user-session-management-types.yang

  ipi-user-session-types.yang

  ipi-watchdog.yang

  ipi-watchdog-types.yang

  ipi-tacacs.yang

  ipi-tacacs-types.yang

  ipi-global-te.yang

  ipi-tfo.yang

  ipi-tfo-types.yang

  ipi-time-range.yang

  ipi-delay-profile-types.yang

  ipi-twamp.yang

 ipi-twamp-client.yang

  ipi-twamp-types.yang

  ipi-udld.yang

  ipi-udld-interface.yang

  ipi-udld-types.yang

  ipi-unicast-rpf.yang

  ipi-unicast-rpf-types.yang

  ipi-role-based-access-control.yang

  ipi-role-based-access-control-types.yang

  ipi-user-management.yang

  ipi-user-management-types.yang

  ipi-port-vlan.yang

  ipi-port-vlan-types.yang

  ipi-vlan.yang

  ipi-vlan-types.yang

  ipi-vrf.yang

  ipi-vrrp.yang

  ipi-vrrp-common.yang

  ipi-vrrp-debug.yang

  ipi-vrrp-global.yang

  ipi-vrrp-ipv4.yang

  ipi-vrrp-ipv6.yang

  ipi-vrrp-types.yang

  ipi-vxlan.yang

  ipi-vxlan-types.yang

  ipi-xstp.yang

  ipi-xstp-types.yang

OpenConfig support is available in OcNOS for the following modules.

Notes:

o acl

 openconfig-acl@2023-01-29

 openconfig-icmpv4-types@2023-01-26

 openconfig-icmpv6-types@2023-01-26

 openconfig-packet-match@2023-03-01

 openconfig-packet-match-types@2023-01-29

 ipi-oc-acl-deviations

o interfaces

 openconfig-if-8021x@2020-01-28

 openconfig-if-aggregate@2022-06-28

 openconfig-if-ethernet@2023-03-10

 openconfig-if-ethernet-ext@2018-11-21

 openconfig-if-ip@2023-02-06

 openconfig-if-ip-ext@2018-11-21

 openconfig-if-poe@2018-11-21

 openconfig-if-sdn-ext@2021-03-30

 openconfig-if-tunnel@2018-11-21

 openconfig-interfaces@2022-10-25

 ipi-oc-if-deviations.yang

o isis

 openconfig-isis@2023-03-20

 openconfig-isis-lsdb-types@2018-11-21

 openconfig-isis-lsp@2023-03-20

 openconfig-isis-policy@2023-02-27

 openconfig-isis-routing@2023-03-20

 openconfig-isis-types@2022-02-11

o lacp

 openconfig-lacp@2021-07-20

 ipi-oc-lacp-deviations.yang

o lldp

 openconfig-lldp@2018-11-21

 openconfig-lldp-types@2018-11-21

 ipi-oc-lldp-deviations.yang

o mpls

 openconfig-mpls@2022-02-11

 openconfig-mpls-igp@2022-02-11

 openconfig-mpls-ldp@2022-02-21

 openconfig-mpls-rsvp@2022-03-27

 openconfig-mpls-sr@2018-11-21

 openconfig-mpls-static@2022-02-11

 openconfig-mpls-te@2022-02-11

 openconfig-mpls-types@2021-12-01

o network-instance

 openconfig-evpn@2023-01-24

 openconfig-evpn-types@2021-06-21

 openconfig-network-instance@2023-02-07

 openconfig-network-instance-l2@2023-02-07

 openconfig-network-instance-l3@2022-11-08

 openconfig-network-instance-policy@2018-11-21

 openconfig-network-instance-types@2021-07-14

 openconfig-programming-errors@2022-10-11

 ipi-oc-ni-augments.yang

 ipi-oc-ni-deviations.yang

o optical-transport

 openconfig-channel-monitor@2019-10-24

 openconfig-optical-amplifier@2019-12-06

 openconfig-optical-attenuator@2019-07-19

 openconfig-terminal-device@2021-07-29

 openconfig-transport-line-common@2019-06-03

 openconfig-transport-line-connectivity@2019-06-27

 openconfig-transport-line-protection@2018-11-21

 openconfig-transport-types@2023-02-08

 openconfig-wavelength-router@2021-07-26

 ipi-oc-transport-types-deviations.yang

 ipi-oc-terminal-device-deviations.yang

o ospf

 openconfig-ospf-policy@2018-11-21

 openconfig-ospf-types@2018-11-21

 openconfig-ospfv2@2022-02-10

 openconfig-ospfv2-area@2022-02-10

 openconfig-ospfv2-area-interface@2022-02-10

 openconfig-ospfv2-common@2022-02-10

 openconfig-ospfv2-global@2022-02-10

 openconfig-ospfv2-lsdb@2022-02-10

  ipi-oc-ospf-deviations.yang

o platform

 openconfig-platform@2022-12-20

 openconfig-platform-common@2022-12-20

 openconfig-platform-controller-card@2022-07-28

 openconfig-platform-cpu@2018-11-21

 openconfig-platform-ext@2018-11-21

 openconfig-platform-fabric@2022-07-28

 openconfig-platform-fan@2018-11-21

 openconfig-platform-healthz@2023-01-23

 openconfig-platform-integrated-circuit@2022-04-20

 openconfig-platform-linecard@2022-07-28

 openconfig-platform-pipeline-counters@2023-02-03

 openconfig-platform-port@2023-01-19

 openconfig-platform-psu@2018-11-21

 openconfig-platform-software@2021-06-16

 openconfig-platform-transceiver@2023-02-10

 openconfig-platform-types@2022-07-28

 ipi-oc-platform-types-deviations.yang

 ipi-oc-platform-deviations.yang

 ipi-oc-platform-transceiver-deviations.yang

o policy

 openconfig-policy-types@2022-11-08

 openconfig-routing-policy@2022-05-24

 ipi-oc-rpol-deviations.yang

o qos

 openconfig-qos@2023-02-17

 openconfig-qos-elements@2023-02-17

 openconfig-qos-interfaces@2023-02-17

 openconfig-qos-mem-mgmt@2023-02-17

 openconfig-qos-types@2018-11-21

  ipi-oc-qos-deviations.yang

o rib

 openconfig-rib-bgp@2022-12-20

 openconfig-rib-bgp-attributes@2022-12-20

 openconfig-rib-bgp-ext@2019-04-25

 openconfig-rib-bgp-shared-attributes@2022-12-20

 openconfig-rib-bgp-table-attributes@2022-12-20

 openconfig-rib-bgp-tables@2022-12-20

 openconfig-rib-bgp-types@2019-03-14

o system

 openconfig-aaa@2022-07-29

 openconfig-aaa-radius@2022-07-29

 openconfig-aaa-tacacs@2022-07-29

 openconfig-aaa-types@2018-11-21

 openconfig-alarms@2019-07-09

 openconfig-alarm-types@2018-11-21

 openconfig-license@2020-04-22

 openconfig-messages@2018-08-13

 openconfig-procmon@2019-03-15

 openconfig-system@2022-12-20

 openconfig-system-controlplane@2023-03-03

 openconfig-system-grpc@2022-04-19

 openconfig-system-logging@2022-12-29

 openconfig-system-terminal@2018-11-21

 ipi-oc-sys-deviations.yang

 ipi-oc-messages-deviations.yang

o types

 openconfig-inet-types@2023-02-06

 openconfig-types@2019-04-16

 openconfig-yang-types@2021-07-14

o vlan

 openconfig-vlan@2023-02-07

 openconfig-vlan-types@2022-05-24