Retrieve a termination-point operational data - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Retrieve a termination-point operational data","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":{"tags":["Operational data","Topology","Since 3.0"],"summary":"Retrieve a termination-point operational data","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.","operationId":"data_ietf_network_state_networks_network_network_network_id_node_node_node_id_ietf_network_topology_state_termination_point_ietf_network_topology_state_termination_point_tp_id_get","parameters":[{"name":"network-id","in":"path","description":"Identifies a network.","required":true,"schema":{"type":"string","format":"string"}},{"name":"node-id","in":"path","description":"Uniquely identifies a node within the containing\nnetwork.","required":true,"schema":{"type":"string","format":"string"}},{"name":"termination-point-id","in":"path","description":"Termination point identifier.","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"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.","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"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)"}}}}}}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Not Found","content":{}},"405":{"description":"Method Not Allowed","content":{}},"409":{"description":"Conflict","content":{}}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_ietf_network_state_networks_network_network_network_id_node_node_node_id_ietf_network_topology_state_termination_point_ietf_network_topology_state_termination_point_tp_id_get","method":"get","path":"/data/ietf-network-state:networks/network={network-id}/node={node-id}/ietf-network-topology-state:termination-point={termination-point-id}"}}