data_ietf-network-state_networks - Crosswork Network Controller 7.1 APIs

{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/a8cb9323-8a97-3868-9520-4a46931fff65","info":{"title":"Layer 3 & Layer 2 Topology Details","description":"The APIs and Models defined here are used to read the Crosswork Optimization Engine discovered topology. The models here can report both L2 and L3 topology details. The models also have support for SR MPLS, SRv6, and Flex Algo related attributes for nodes and links.\n\nThe models (and resulting APIs) listed here are an aggregation of various Topology YANG models. The basis of these Topology models are formed from IETF models that are then augmented by Cisco propreitary models, for extra details.\n\nThe base IETF models are linked below.\n\nhttps://datatracker.ietf.org/doc/html/rfc8345\nietf-network-state\nietf-network-topology-state\n\nhttps://datatracker.ietf.org/doc/html/rfc8346/\nietf-l3-unicast-topology-state\n\nhttps://datatracker.ietf.org/doc/html/rfc8944/\nietf-l2-topology-state\n\nhttps://datatracker.ietf.org/doc/html/draft-ietf-teas-yang-sr-te-topo\nietf-sr-mpls-topology-state\n\nhttps://datatracker.ietf.org/doc/html/draft-ietf-spring-srv6-yang\nietf-srv6-types","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"tags":[{"name":"Operational data","description":"Operational data resources for Networks, Nodes, Termination Points, and Links"}],"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/nbi/topology/v3/restconf","variables":{"cnc-host":{"default":"127.0.0.1","description":"host name or ip address of the target CNC Cluster"},"cnc-port":{"default":"30603","description":"port number of the target CNC Cluster"}}}],"securitySchemes":{"basicAuth":{"type":"http","description":"basic authentication","scheme":"basic"}}},"spec":{"description":"networks","type":"object","properties":{"ietf-network-state:networks":{"type":"object","properties":{"network":{"type":"array","description":"Describes a network.\nA network typically contains an inventory of nodes,\ntopological information (augmented through the\nnetwork-topology data model), and layering information. (list)","items":{"type":"object","properties":{"network-id":{"type":"string","description":"Identifies a network. (leaf)","format":"string"},"network-types":{"type":"object","properties":{"ietf-l3-unicast-topology-state:l3-unicast-topology":{"type":"object","properties":{"cisco-crosswork-isis-topology:isis":{"type":"object","properties":{},"description":"Presence of this node identifies the ISIS topology type. (presence)"},"cisco-crosswork-ospf-topology:ospf":{"type":"object","properties":{},"description":"Presence of this node identifies the OSPF topology type. (presence)"},"ietf-sr-mpls-topology-state:sr-mpls":{"type":"object","properties":{},"description":"Its presence identifies the SR topology type. (presence)"},"cisco-crosswork-srv6-topology-state:srv6":{"type":"object","properties":{},"description":"Its presence identifies the SRv6 topology type. (presence)"}},"description":"The presence of the container node indicates L3 Unicast\ntopology (presence)"},"ietf-l2-topology-state:l2-topology":{"type":"object","properties":{},"description":"The presence of the container node indicates\nL2 Network Topology. (presence)"}},"description":"Serves as an augmentation target.\nThe network type is indicated through corresponding\npresence containers augmented into this container. (non-presence)"},"node":{"type":"array","description":"The inventory of nodes of this network. (list)","items":{"type":"object","properties":{"node-id":{"type":"string","description":"Uniquely identifies a node within the containing\nnetwork. (leaf)","format":"string"},"ietf-network-topology-state:termination-point":{"type":"array","description":"A termination point can terminate a link.\nDepending on the type of topology, a termination point\ncould, for example, refer to a port or an interface. (list)","items":{"type":"object","properties":{"ietf-network-topology-state:tp-id":{"type":"string","description":"Termination point identifier. (leaf)","format":"string"},"ietf-l3-unicast-topology-state:l3-termination-point-attributes":{"type":"object","properties":{"ietf-l3-unicast-topology-state:ip-address":{"description":"ip address","type":"array","items":{"type":"string","description":"IPv4 or IPv6 address. (leaf-list)","format":"union"}}},"description":"Contains termination point attributes (non-presence)"},"ietf-l2-topology-state:l2-termination-point-attributes":{"type":"object","properties":{"ietf-l2-topology-state:interface-name":{"type":"string","description":"Name of the interface. The name can (but does not\nhave to) correspond to an interface reference of a\ncontaining node's interface, i.e., the path name of a\ncorresponding interface data node on the containing\nnode is reminiscent of data type interface-ref defined\nin RFC 8343. It should be noted that data type\ninterface-ref of RFC 8343 cannot be used directly,\nas this data type is used to reference an interface\nin a datastore of a single node in the network, not\nto uniquely reference interfaces across a network. (leaf)","format":"string"},"ietf-l2-topology-state:mac-address":{"type":"string","description":"Interface MAC address for logical link control. (leaf)","format":"string"},"ietf-l2-topology-state:port-number":{"description":"port number","type":"array","items":{"type":"integer","description":"List of port numbers of the bridge ports for which each\nentry contains bridge management information. (leaf-list)\n","format":"uint32"}},"ietf-l2-topology-state:unnumbered-id":{"description":"unnumbered id","type":"array","items":{"type":"integer","description":"List of unnumbered interface identifiers.\nThe unnumbered interface identifier will correspond to\nthe ifIndex value of the interface, i.e., the ifIndex\nvalue of the ifEntry that represents the interface in\nimplementations where the Interfaces Group MIB\n(RFC 2863) is supported. (leaf-list)","format":"uint32"}},"ietf-l2-topology-state:encapsulation-type":{"type":"string","description":"Encapsulation type of this\ntermination point. (leaf)","format":"identityref"},"ietf-l2-topology-state:outer-tag":{"type":"string","description":"The outermost VLAN tag. It may include a list of VLAN\nIds or nonoverlapping VLAN ranges. (leaf)","format":"string"},"ietf-l2-topology-state:outer-tpid":{"type":"string","description":"Identifies a specific 802.1Q tag type of outermost VLAN\ntag. (leaf)","format":"identityref"},"ietf-l2-topology-state:inner-tag":{"type":"string","description":"The inner VLAN tag. It may include a list of VLAN\nIds or nonoverlapping VLAN ranges. (leaf)","format":"string"},"ietf-l2-topology-state:inner-tpid":{"type":"string","description":"Identifies a specific 802.1Q tag type of inner VLAN tag. (leaf)","format":"identityref"},"ietf-l2-topology-state:lag":{"type":"string","description":"Defines whether lag is supported or not.\nWhen it is set to true, the lag is supported. (leaf)","format":"boolean"},"ietf-l2-topology-state:member-link-tp":{"description":"member link tp","type":"array","items":{"type":"string","description":"List of member link termination points associated with\nspecific L2 termination point. (leaf-list)","format":"leafref"}},"ietf-l2-topology-state:vxlan":{"type":"object","properties":{"ietf-l2-topology-state:vni-id":{"type":"integer","description":"VXLAN Network Identifier (VNI). (leaf)","format":"uint32"}},"description":"Vxlan encapsulation type. (non-presence)"}},"description":"Containing L2 termination point attributes. (non-presence)"},"cisco-crosswork-topology-state:termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:l2-termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:interface-name":{"type":"string","description":"Name of the interface. The name can (but does not\nhave to) correspond to an interface reference of a\ncontaining node's interface, i.e., the path name of a\ncorresponding interface data node on the containing\nnode is reminiscent of data type interface-ref defined\nin RFC 8343. It should be noted that data type\ninterface-ref of RFC 8343 cannot be used directly,\nas this data type is used to reference an interface\nin a datastore of a single node in the network, not\nto uniquely reference interfaces across a network. (leaf)","format":"string"},"cisco-crosswork-topology-state:mac-address":{"type":"string","description":"Interface MAC address for logical link control. (leaf)","format":"string"},"cisco-crosswork-topology-state:port-number":{"description":"port number","type":"array","items":{"type":"integer","description":"List of port numbers of the bridge ports for which each\nentry contains bridge management information. (leaf-list)\n","format":"uint32"}},"cisco-crosswork-topology-state:unnumbered-id":{"description":"unnumbered id","type":"array","items":{"type":"integer","description":"List of unnumbered interface identifiers.\nThe unnumbered interface identifier will correspond to\nthe ifIndex value of the interface, i.e., the ifIndex\nvalue of the ifEntry that represents the interface in\nimplementations where the Interfaces Group MIB\n(RFC 2863) is supported. (leaf-list)","format":"uint32"}},"cisco-crosswork-topology-state:encapsulation-type":{"type":"string","description":"Encapsulation type of this\ntermination point. (leaf)","format":"identityref"},"cisco-crosswork-topology-state:outer-tag":{"type":"string","description":"The outermost VLAN tag. It may include a list of VLAN\nIds or nonoverlapping VLAN ranges. (leaf)","format":"string"},"cisco-crosswork-topology-state:outer-tpid":{"type":"string","description":"Identifies a specific 802.1Q tag type of outermost VLAN\ntag. (leaf)","format":"identityref"},"cisco-crosswork-topology-state:inner-tag":{"type":"string","description":"The inner VLAN tag. It may include a list of VLAN\nIds or nonoverlapping VLAN ranges. (leaf)","format":"string"},"cisco-crosswork-topology-state:inner-tpid":{"type":"string","description":"Identifies a specific 802.1Q tag type of inner VLAN tag. (leaf)","format":"identityref"},"cisco-crosswork-topology-state:lag":{"type":"string","description":"Defines whether lag is supported or not.\nWhen it is set to true, the lag is supported. (leaf)","format":"boolean"},"cisco-crosswork-topology-state:member-link-tp":{"description":"member link tp","type":"array","items":{"type":"string","description":"List of member link termination points associated with\nspecific L2 termination point. (leaf-list)","format":"leafref"}},"cisco-crosswork-topology-state:vxlan":{"type":"object","properties":{"cisco-crosswork-topology-state:vni-id":{"type":"integer","description":"VXLAN Network Identifier (VNI). (leaf)","format":"uint32"}},"description":"Vxlan encapsulation type. (non-presence)"}},"description":"Containing L2 termination point attributes. (non-presence)"},"cisco-crosswork-topology-state:l3-termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:ip-address":{"description":"ip address","type":"array","items":{"type":"string","description":"IPv4 or IPv6 address. (leaf-list)","format":"union"}}},"description":"Contains termination point attributes (non-presence)"},"cisco-crosswork-topology-state:ipv4-termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:l3-termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:ip-address":{"description":"ip address","type":"array","items":{"type":"string","description":"IPv4 or IPv6 address. (leaf-list)","format":"union"}}},"description":"Contains termination point attributes (non-presence)"}},"description":"(non-presence)"},"cisco-crosswork-topology-state:ipv6-termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:l3-termination-point-attributes":{"type":"object","properties":{"cisco-crosswork-topology-state:ip-address":{"description":"ip address","type":"array","items":{"type":"string","description":"IPv4 or IPv6 address. (leaf-list)","format":"union"}}},"description":"Contains termination point attributes (non-presence)"}},"description":"(non-presence)"}},"description":"Termination point has both L2 and L3 attributes. (non-presence)"}}}},"ietf-l3-unicast-topology-state:l3-node-attributes":{"type":"object","properties":{"ietf-l3-unicast-topology-state:name":{"type":"string","description":"Node name (leaf)","format":"string"},"ietf-l3-unicast-topology-state:flag":{"description":"flag","type":"array","items":{"type":"string","description":"Node flags (leaf-list)","format":"identityref"}},"ietf-l3-unicast-topology-state:router-id":{"description":"router id","type":"array","items":{"type":"string","description":"Router-id for the node (leaf-list)","format":"string"}},"ietf-l3-unicast-topology-state:prefix":{"type":"array","description":"A list of prefixes along with their attributes (list)","items":{"type":"object","properties":{"ietf-l3-unicast-topology-state:prefix":{"type":"string","description":"IP prefix value (leaf)","format":"union"},"ietf-l3-unicast-topology-state:metric":{"type":"integer","description":"Prefix metric (leaf)","format":"uint32"},"ietf-l3-unicast-topology-state:flag":{"description":"flag","type":"array","items":{"type":"string","description":"Prefix flags (leaf-list)","format":"identityref"}},"cisco-crosswork-l3-te-topology:prefix-attributes":{"type":"object","properties":{"cisco-crosswork-l3-te-topology:domain-id":{"type":"integer","description":"Identifier of IGP domain to which prefix belongs. (leaf)","format":"uint64"}},"description":"Additional prefix info not supported by standard IETF topology model (non-presence)"},"ietf-sr-mpls-topology-state:sr-mpls":{"type":"array","description":"Containing SR attributes for a prefix. (list)","items":{"type":"object","properties":{"ietf-sr-mpls-topology-state:value-type":{"type":"string","description":"This leaf defines how value must be interpreted. (leaf)","format":"enumeration","default":"index","enum":["index","absolute"]},"ietf-sr-mpls-topology-state:start-sid":{"type":"integer","description":"Value associated with prefix. The value must be\ninterpreted in the context of value-type. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:range":{"type":"integer","description":"Indicates how many SIDs can be allocated. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:algorithm":{"type":"string","description":"Prefix-sid algorithm. (leaf)","format":"identityref"},"ietf-sr-mpls-topology-state:algorithm-value":{"type":"integer","description":"Prefix-sid algorithm value. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:last-hop-behavior":{"type":"string","description":"Configure last hop behavior. (leaf)","format":"enumeration","default":"explicit-null","enum":["explicit-null","no-php","php"]},"ietf-sr-mpls-topology-state:is-local":{"type":"string","description":"''true'' if the SID is local. (leaf)","format":"boolean"},"ietf-sr-mpls-topology-state:is-node":{"type":"string","description":"'true' if the Prefix-SID refers to the router identified\nby the prefix. Typically, the leaf 'is-node' (N-Flag)\nis set on Prefix-SIDs attached to a router loopback\naddress. (leaf)","format":"boolean"},"ietf-sr-mpls-topology-state:is-readvertisment":{"type":"string","description":"'true' if the prefix to which this Prefix-SID is attached,\nhas been propagated by the router from another\ntopology by redistribution. (leaf)","format":"boolean"}}}}}}},"cisco-crosswork-l3-te-topology:ipv6-router-id":{"description":"ipv6 router id","type":"array","items":{"type":"string","description":"IPv6 Router-id for the node (leaf-list)","format":"string"}},"cisco-crosswork-l3-te-topology:node-pcep-sessions":{"type":"array","description":"A list of PCEP Sessions, along with their attributes (list)","items":{"type":"object","properties":{"cisco-crosswork-l3-te-topology:pcc-address":{"type":"string","description":"Local IP address of the PCEP connection. (leaf)","format":"union"},"cisco-crosswork-l3-te-topology:pce-address":{"type":"string","description":"The IP address of the PCE for this PCEP session. (leaf)","format":"union"},"cisco-crosswork-l3-te-topology:stateful":{"type":"string","description":"Indicates this node has a stateful PCEP session. (leaf)","format":"boolean"},"cisco-crosswork-l3-te-topology:capability-instantiate":{"type":"string","description":"Indicates that this node is capable of instantiating PCE init LSPs. (leaf)","format":"boolean"},"cisco-crosswork-l3-te-topology:capability-update":{"type":"string","description":"Indicates that this node is capable of receiving and handling PCEP update messages. (leaf)","format":"boolean"},"cisco-crosswork-l3-te-topology:capability-sr":{"type":"string","description":"Indicates that this node is capable of Segment Routing technologies. (leaf)","format":"boolean"},"cisco-crosswork-l3-te-topology:msd":{"type":"integer","description":"The Maximum SID Depth, as reported on this PCEP session. (leaf)","format":"uint32"}}}},"cisco-crosswork-isis-topology:isis-node-attributes":{"type":"array","description":"ISIS attributes for a specific node (non-presence)","items":{"type":"object","properties":{"cisco-crosswork-isis-topology:system-id":{"type":"string","description":"ISIS System ID, a 6 octet numerical value (leaf)","format":"string"},"cisco-crosswork-isis-topology:area":{"description":"area","type":"array","items":{"type":"string","description":"List of Area addresses.\n*** Should we return only a single Area address corresponding\nto the current network?? (leaf-list)","format":"string"}},"cisco-crosswork-isis-topology:level":{"type":"string","description":"Level 1, Level 2 or Level 1 & 2 (leaf)","format":"enumeration","default":"level-1","enum":["level-1","level-2","level-all"]},"cisco-crosswork-srv6-topology-state:srv6-node-sid":{"type":"array","description":"SRv6 node sids (list)","items":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:sid":{"type":"string","description":"SRV6 sid value. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:endpoint-behavior":{"type":"string","description":"The endpoint function. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:algorithm":{"type":"integer","description":"Associated algorithm. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:srv6-sid-structure":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:lb-length":{"type":"integer","description":"SRv6 SID Locator Block length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:ln-length":{"type":"integer","description":"SRv6 SID Locator Node length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:func-length":{"type":"integer","description":"SRv6 SID Function length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:arg-length":{"type":"integer","description":"SRv6 SID Argument length in bits. (leaf)","format":"uint32"}},"description":"SRv6 SID Structure is used to advertise\nthe length of each individual part of the SRv6 SID (non-presence)"}}}},"cisco-crosswork-flex-algo:flex-algo":{"type":"array","description":"Flex Algorithm (list)","items":{"type":"object","properties":{"cisco-crosswork-flex-algo:flex-algo-id":{"type":"integer","description":"Flex Algorithm Identifier (leaf)","format":"byte"},"cisco-crosswork-flex-algo:metric-type":{"type":"string","description":"Indicates which is the corresponding metric type for\nthis algorithm, default is IGP (leaf)","format":"identityref"},"cisco-crosswork-flex-algo:priority":{"type":"integer","description":"Indicates the priority for this algorithm (leaf)","format":"byte"},"cisco-crosswork-flex-algo:exclude-any":{"type":"string","description":"Affinity exclude any (leaf)","format":"string"},"cisco-crosswork-flex-algo:include-any":{"type":"string","description":"Affinity include any (leaf)","format":"string"},"cisco-crosswork-flex-algo:include-all":{"type":"string","description":"Affinity include all (leaf)","format":"string"},"cisco-crosswork-flex-algo:elected":{"type":"string","description":"Elected (leaf)","format":"boolean"},"cisco-crosswork-flex-algo:participated":{"type":"string","description":"Participated (leaf)","format":"boolean"}}}}}}},"cisco-crosswork-ospf-topology:ospf-node-attributes":{"type":"array","description":"Contains node's OSPF attributes (non-presence)","items":{"type":"object","properties":{"cisco-crosswork-ospf-topology:ospf-router-id":{"type":"string","description":"OSPF router ID, which is an IPv4 address.\n*** Note, only one router-ID is reported, corresponwing\nto the IGP domain of the current network (leaf)","format":"string"},"cisco-crosswork-ospf-topology:area-id":{"description":"area id","type":"array","items":{"type":"string","description":"List of OSPF area IDs, each represented as an IPv4 address value\n*** Should we report all Areas or just the one corresponwing to\nthe network?? (leaf-list)","format":"string"}},"cisco-crosswork-srv6-topology-state:srv6-node-sid":{"type":"array","description":"SRv6 node sids (list)","items":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:sid":{"type":"string","description":"SRV6 sid value. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:endpoint-behavior":{"type":"string","description":"The endpoint function. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:algorithm":{"type":"integer","description":"Associated algorithm. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:srv6-sid-structure":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:lb-length":{"type":"integer","description":"SRv6 SID Locator Block length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:ln-length":{"type":"integer","description":"SRv6 SID Locator Node length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:func-length":{"type":"integer","description":"SRv6 SID Function length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:arg-length":{"type":"integer","description":"SRv6 SID Argument length in bits. (leaf)","format":"uint32"}},"description":"SRv6 SID Structure is used to advertise\nthe length of each individual part of the SRv6 SID (non-presence)"}}}},"cisco-crosswork-flex-algo:flex-algo":{"type":"array","description":"Flex Algorithm (list)","items":{"type":"object","properties":{"cisco-crosswork-flex-algo:flex-algo-id":{"type":"integer","description":"Flex Algorithm Identifier (leaf)","format":"byte"},"cisco-crosswork-flex-algo:metric-type":{"type":"string","description":"Indicates which is the corresponding metric type for\nthis algorithm, default is IGP (leaf)","format":"identityref"},"cisco-crosswork-flex-algo:priority":{"type":"integer","description":"Indicates the priority for this algorithm (leaf)","format":"byte"},"cisco-crosswork-flex-algo:exclude-any":{"type":"string","description":"Affinity exclude any (leaf)","format":"string"},"cisco-crosswork-flex-algo:include-any":{"type":"string","description":"Affinity include any (leaf)","format":"string"},"cisco-crosswork-flex-algo:include-all":{"type":"string","description":"Affinity include all (leaf)","format":"string"},"cisco-crosswork-flex-algo:elected":{"type":"string","description":"Elected (leaf)","format":"boolean"},"cisco-crosswork-flex-algo:participated":{"type":"string","description":"Participated (leaf)","format":"boolean"}}}}}}},"ietf-sr-mpls-topology-state:sr-mpls":{"type":"object","properties":{"ietf-sr-mpls-topology-state:srgb":{"type":"array","description":"List of global blocks to be advertised. (list)","items":{"type":"object","properties":{"ietf-sr-mpls-topology-state:lower-bound":{"type":"integer","description":"Lower value in the label range. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:upper-bound":{"type":"integer","description":"Upper value in the label range. (leaf)","format":"uint32"}}}},"ietf-sr-mpls-topology-state:srlb":{"type":"array","description":"List of SRLBs. (list)","items":{"type":"object","properties":{"ietf-sr-mpls-topology-state:lower-bound":{"type":"integer","description":"Lower value in the label range. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:upper-bound":{"type":"integer","description":"Upper value in the label range. (leaf)","format":"uint32"}}}},"ietf-sr-mpls-topology-state:node-capabilities":{"type":"object","properties":{"ietf-sr-mpls-topology-state:transport-planes":{"type":"array","description":"List of supported transport planes. (list)","items":{"type":"object","properties":{"ietf-sr-mpls-topology-state:transport-plane":{"type":"string","description":"Transport plane supported (leaf)","format":"identityref"}}}},"ietf-sr-mpls-topology-state:entropy-readable-label-depth":{"type":"integer","description":"Maximum label stack depth that a router can read. (leaf)","format":"byte"}},"description":"Shows the SR capability of the node. (non-presence)"},"ietf-sr-mpls-topology-state:msd":{"type":"integer","description":"Node MSD is the lowest MSD supported by the node. (leaf)","format":"byte"},"ietf-sr-mpls-topology-state:information-source":{"type":"string","description":"Indicates the type of the information source. (leaf)","format":"enumeration","default":"unknown","enum":["unknown","locally-configured","ospfv2","ospfv3","isis","bgp-ls","system-processed","other"]},"ietf-sr-mpls-topology-state:information-source-instance":{"type":"string","description":"The name indicating the instance of the information\nsource. (leaf)","format":"string"},"ietf-sr-mpls-topology-state:information-source-state":{"type":"object","properties":{"ietf-sr-mpls-topology-state:credibility-preference":{"type":"integer","description":"The preference value to calculate the traffic\nengineering database credibility value used for\ntie-break selection between different\ninformation-source values.\nHigher value is more preferable. (leaf)","format":"uint16"}},"description":"The container contains state attributes related to\nthe information source. (non-presence)"}},"description":"Containing SR attributes. (presence)"}},"description":"Contains node attributes (non-presence)"},"ietf-l2-topology-state:l2-node-attributes":{"type":"object","properties":{"ietf-l2-topology-state:name":{"type":"string","description":"Node name. (leaf)","format":"string"},"ietf-l2-topology-state:flags":{"description":"flags","type":"array","items":{"type":"string","description":"Node flags. It can be used to indicate\nnode flag attributes. (leaf-list)","format":"identityref"}},"ietf-l2-topology-state:bridge-id":{"description":"bridge id","type":"array","items":{"type":"string","description":"This is the bridge identifier represented as a\nhexadecimal 8-octet string. It has 4 bits of\npriority, 12 bits of Multiple Spanning Tree\nInstance Identifier (MSTI-ID), and the base bridge\nidentifier. There may be multiple for each\nspanning tree instance. (leaf-list)","format":"string"}},"ietf-l2-topology-state:management-address":{"description":"management address","type":"array","items":{"type":"string","description":"IP address used for management purpose. (leaf-list)","format":"union"}},"ietf-l2-topology-state:management-mac":{"type":"string","description":"This is a MAC address used for the bridge management.\nIt can be the Bridge Base VLAN ID (VID), interface\nMAC address, or other. (leaf)","format":"string"},"ietf-l2-topology-state:management-vlan":{"type":"string","description":"This is a VLAN that supports the management address.\nThe actual VLAN ID type and value would be a member of\nthis VLAN. (leaf)","format":"string"}},"description":"Contains L2 node attributes. (non-presence)"}}}},"ietf-network-topology-state:link":{"type":"array","description":"A network link connects a local (source) node and\na remote (destination) node via a set of the respective\nnode's termination points. It is possible to have several\nlinks between the same source and destination nodes.\nLikewise, a link could potentially be re-homed between\ntermination points. Therefore, in order to ensure that we\nwould always know to distinguish between links, every link\nis identified by a dedicated link identifier. Note that a\nlink models a point-to-point link, not a multipoint link. (list)","items":{"type":"object","properties":{"ietf-network-topology-state:link-id":{"type":"string","description":"The identifier of a link in the topology.\nA link is specific to a topology to which it belongs. (leaf)","format":"string"},"ietf-network-topology-state:source":{"type":"object","properties":{"ietf-network-topology-state:source-node":{"type":"string","description":"Source node identifier. Must be in the same topology. (leaf)","format":"leafref"},"ietf-network-topology-state:source-tp":{"type":"string","description":"This termination point is located within the source node\nand terminates the link. (leaf)","format":"leafref"}},"description":"This container holds the logical source of a particular\nlink. (non-presence)"},"ietf-network-topology-state:destination":{"type":"object","properties":{"ietf-network-topology-state:dest-node":{"type":"string","description":"Destination node identifier. Must be in the same\nnetwork. (leaf)","format":"leafref"},"ietf-network-topology-state:dest-tp":{"type":"string","description":"This termination point is located within the\ndestination node and terminates the link. (leaf)","format":"leafref"}},"description":"This container holds the logical destination of a\nparticular link. (non-presence)"},"ietf-l3-unicast-topology-state:l3-link-attributes":{"type":"object","properties":{"ietf-l3-unicast-topology-state:name":{"type":"string","description":"Link Name (leaf)","format":"string"},"ietf-l3-unicast-topology-state:flag":{"description":"flag","type":"array","items":{"type":"string","description":"Link flags (leaf-list)","format":"identityref"}},"ietf-l3-unicast-topology-state:metric1":{"type":"integer","description":"Link Metric 1, reports IGP metric value (leaf)","format":"uint64"},"ietf-l3-unicast-topology-state:metric2":{"type":"integer","description":"Link Metric 2, reports TE metric value (leaf)","format":"uint64"},"cisco-crosswork-l3-te-topology:l3-link-attributes":{"type":"object","properties":{"cisco-crosswork-l3-te-topology:administrative-group":{"type":"integer","description":"Link administrative-group, also known as TE affinity (leaf)","format":"uint32"},"cisco-crosswork-l3-te-topology:srlg":{"type":"array","description":"Shared Risk Link Groups (SRLGs) are list of numeric identifiers that are assigned/associated with groups of links.","items":{"type":"integer","description":"SRLG","format":"uint32"}},"cisco-crosswork-l3-te-topology:domain-id":{"type":"integer","description":"Link state domain identifier (leaf)","format":"uint64"},"cisco-crosswork-l3-te-topology:max-bandwidth-kbps":{"type":"integer","description":"Max bandwidth for this link, in kilobytes per second. (leaf)","format":"uint64"}},"description":"link attributes (non-presence)"},"cisco-crosswork-isis-topology:isis-link-attributes":{"type":"object","properties":{"cisco-crosswork-isis-topology:net":{"type":"object","properties":{"cisco-crosswork-isis-topology:system-id":{"type":"string","description":"ISIS System ID which is a 6 octet numerical value (leaf)","format":"string"},"cisco-crosswork-isis-topology:area":{"type":"string","description":"ISIS Area address. Numerical value of 1 to 13 octets (leaf)","format":"string"}},"description":"ISIS Network Entity Title which identifies an instance of ISIS (non-presence)"},"cisco-crosswork-isis-topology:level":{"type":"integer","description":"ISIS level of the link/ adjacency (leaf)","format":"byte"},"cisco-crosswork-srv6-topology-state:srv6-adjacency-sid":{"type":"array","description":"SRv6 sids (list)","items":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:sid":{"type":"string","description":"SRV6 sid value. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:endpoint-behavior":{"type":"string","description":"The endpoint function. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:protected":{"type":"string","description":"Is Adj-SID protected? (leaf)","format":"boolean"},"cisco-crosswork-srv6-topology-state:flags":{"type":"integer","description":"Flags for srv6 end x sid. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:algorithm":{"type":"integer","description":"Associated algorithm. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:weight":{"type":"integer","description":"The value represents the weight of the End.X sid\nfor the purpose of load balancing. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:srv6-sid-structure":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:lb-length":{"type":"integer","description":"SRv6 SID Locator Block length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:ln-length":{"type":"integer","description":"SRv6 SID Locator Node length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:func-length":{"type":"integer","description":"SRv6 SID Function length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:arg-length":{"type":"integer","description":"SRv6 SID Argument length in bits. (leaf)","format":"uint32"}},"description":"SRv6 SID Structure is used to advertise\nthe length of each individual part of the SRv6 SID (non-presence)"}}}},"cisco-crosswork-flex-algo:link-attributes":{"type":"object","properties":{"cisco-crosswork-flex-algo:flex-algo-admin-group":{"type":"string","description":"Link flex-algo-admin-group, link affinity (leaf)","format":"string"}},"description":"link attributes (non-presence)"}},"description":"ISIS link/ adjacency attributes (non-presence)"},"cisco-crosswork-ospf-topology:ospf-link-attributes":{"type":"object","properties":{"cisco-crosswork-ospf-topology:ospf-router-id":{"type":"string","description":"OSPF router ID, which is an IPv4 address,\nof the local host (leaf)","format":"string"},"cisco-crosswork-ospf-topology:area-id":{"type":"string","description":"OSPF area ID, represented as an IPv4 address value (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:srv6-adjacency-sid":{"type":"array","description":"SRv6 sids (list)","items":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:sid":{"type":"string","description":"SRV6 sid value. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:endpoint-behavior":{"type":"string","description":"The endpoint function. (leaf)","format":"string"},"cisco-crosswork-srv6-topology-state:protected":{"type":"string","description":"Is Adj-SID protected? (leaf)","format":"boolean"},"cisco-crosswork-srv6-topology-state:flags":{"type":"integer","description":"Flags for srv6 end x sid. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:algorithm":{"type":"integer","description":"Associated algorithm. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:weight":{"type":"integer","description":"The value represents the weight of the End.X sid\nfor the purpose of load balancing. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:srv6-sid-structure":{"type":"object","properties":{"cisco-crosswork-srv6-topology-state:lb-length":{"type":"integer","description":"SRv6 SID Locator Block length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:ln-length":{"type":"integer","description":"SRv6 SID Locator Node length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:func-length":{"type":"integer","description":"SRv6 SID Function length in bits. (leaf)","format":"uint32"},"cisco-crosswork-srv6-topology-state:arg-length":{"type":"integer","description":"SRv6 SID Argument length in bits. (leaf)","format":"uint32"}},"description":"SRv6 SID Structure is used to advertise\nthe length of each individual part of the SRv6 SID (non-presence)"}}}},"cisco-crosswork-flex-algo:link-attributes":{"type":"object","properties":{"cisco-crosswork-flex-algo:flex-algo-admin-group":{"type":"string","description":"Link flex-algo-admin-group, link affinity (leaf)","format":"string"}},"description":"link attributes (non-presence)"}},"description":"Containing OSPF link attributes (non-presence)"},"ietf-sr-mpls-topology-state:sr-mpls":{"type":"object","properties":{"ietf-sr-mpls-topology-state:advertise-protection":{"type":"string","description":"If set, the Adj-SID refers to an\nadjacency being protected. (leaf)","format":"enumeration","default":"single","enum":["single","dual"]},"ietf-sr-mpls-topology-state:msd":{"type":"integer","description":"SID depth of the interface associated with the link. (leaf)","format":"byte"},"ietf-sr-mpls-topology-state:sids":{"type":"array","description":"List of SIDs. (list)","items":{"type":"object","properties":{"ietf-sr-mpls-topology-state:value-type":{"type":"string","description":"This leaf defines how value must be interpreted. (leaf)","format":"enumeration","default":"index","enum":["index","absolute"]},"ietf-sr-mpls-topology-state:sid":{"type":"integer","description":"Adjacency SID, which can be either IGP-Adjacency SID\nor BGP PeerAdj SID, depending on the context. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:is-local":{"type":"string","description":"''true'' if the SID is local. (leaf)","format":"boolean"},"ietf-sr-mpls-topology-state:address-family":{"type":"string","description":"This leaf defines the F-Flag (Address-Family flag) of the\nSID. (leaf)","format":"enumeration","default":"ipv4","enum":["ipv4","ipv6"]},"ietf-sr-mpls-topology-state:is-backup":{"type":"string","description":"''true'' if the SID is a backup. (leaf)","format":"boolean"},"ietf-sr-mpls-topology-state:is-part-of-set":{"type":"string","description":"''true'' if the SID is part of a set. (leaf)","format":"boolean"},"ietf-sr-mpls-topology-state:is-persistent":{"type":"string","description":"''true'' if the SID is persistently allocated. (leaf)","format":"boolean"},"ietf-sr-mpls-topology-state:is-on-lan":{"type":"string","description":"''true'' if on a lan. (leaf)","format":"boolean"}}}},"ietf-sr-mpls-topology-state:information-source":{"type":"string","description":"Indicates the type of the information source. (leaf)","format":"enumeration","default":"unknown","enum":["unknown","locally-configured","ospfv2","ospfv3","isis","bgp-ls","system-processed","other"]},"ietf-sr-mpls-topology-state:information-source-instance":{"type":"string","description":"The name indicating the instance of the information\nsource. (leaf)","format":"string"},"ietf-sr-mpls-topology-state:information-source-state":{"type":"object","properties":{"ietf-sr-mpls-topology-state:credibility-preference":{"type":"integer","description":"The preference value to calculate the traffic\nengineering database credibility value used for\ntie-break selection between different\ninformation-source values.\nHigher value is more preferable. (leaf)","format":"uint16"}},"description":"The container contains state attributes related to\nthe information source. (non-presence)"}},"description":"Containing SR attributes. (presence)"}},"description":"Contains link attributes (non-presence)"},"ietf-l2-topology-state:l2-link-attributes":{"type":"object","properties":{"ietf-l2-topology-state:name":{"type":"string","description":"Link name. (leaf)","format":"string"},"ietf-l2-topology-state:flags":{"description":"flags","type":"array","items":{"type":"string","description":"Link flags. It can be used to indicate\nlink flag attributes. (leaf-list)","format":"identityref"}},"ietf-l2-topology-state:rate":{"type":"integer","description":"Link rate. It specifies bandwidth requirements\nassociated with the specific link. The link\ncontains a source and a destination. (leaf)","format":"uint64"},"ietf-l2-topology-state:delay":{"type":"integer","description":"Unidirectional link delay in\nmicroseconds. (leaf)","format":"uint32"},"ietf-l2-topology-state:auto-nego":{"type":"string","description":"Set to true if auto-negotiation is supported.\nSet to false if auto-negotiation is not supported. (leaf)","format":"boolean"},"ietf-l2-topology-state:duplex":{"type":"string","description":"Exposes the duplex mode, full-duplex or half-duplex. (leaf)","format":"enumeration","default":"full-duplex","enum":["full-duplex","half-duplex"]}},"description":"Contains L2 link attributes. (non-presence)"}}}},"ietf-l3-unicast-topology-state:l3-topology-attributes":{"type":"object","properties":{"ietf-l3-unicast-topology-state:name":{"type":"string","description":"Name of the topology (leaf)","format":"string"},"ietf-l3-unicast-topology-state:flag":{"description":"flag","type":"array","items":{"type":"string","description":"Topology flags (leaf-list)","format":"identityref"}},"cisco-crosswork-isis-topology:isis-topology-attributes":{"type":"object","properties":{"cisco-crosswork-isis-topology:area":{"type":"string","description":"ISIS Area address. Numerical value of 1 to 13 octets (leaf)","format":"string"}},"description":"Contains ISIS topology attributes.\n*** Contains a single Area address, which means each nw:ietf-network\nmust contain a single ISIS Area. is this what we want??\n*** How do we identify areas from different ISIS domains??\n*** What would the behavior be for a query asking for all ietf-networks?? (non-presence)"},"cisco-crosswork-ospf-topology:ospf-topology-attributes":{"type":"object","properties":{"cisco-crosswork-ospf-topology:area-id":{"type":"string","description":"OSPF area ID, represented as an IPv4 address value.\n*** Contains a single Area ID, which means each ietf-network\nmust contain a single OSPF Area. is this what we want??\n*** How do we identify areas from different OSPF domains?? (leaf)","format":"string"}},"description":"OSPF topology attributes (non-presence)"},"ietf-sr-mpls-topology-state:sr-mpls":{"type":"object","properties":{"ietf-sr-mpls-topology-state:srgb":{"type":"array","description":"List of global blocks to be advertised. (list)","items":{"type":"object","properties":{"ietf-sr-mpls-topology-state:lower-bound":{"type":"integer","description":"Lower value in the label range. (leaf)","format":"uint32"},"ietf-sr-mpls-topology-state:upper-bound":{"type":"integer","description":"Upper value in the label range. (leaf)","format":"uint32"}}}}},"description":"Containing SR attributes. (non-presence)"}},"description":"Contains topology attributes (non-presence)"},"ietf-l2-topology-state:l2-topology-attributes":{"type":"object","properties":{"ietf-l2-topology-state:name":{"type":"string","description":"Name of the topology. (leaf)","format":"string"},"ietf-l2-topology-state:flags":{"description":"flags","type":"array","items":{"type":"string","description":"Topology flags. (leaf-list)","format":"identityref"}}},"description":"Contains L2 topology attributes. (non-presence)"}}}}},"description":"Serves as a top-level container for a list of networks. (non-presence)"}},"title":"data_ietf-network-state_networks"}}