Operational data for single SR P2MP policy - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Operational data for single SR P2MP policy","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/91ff009f-6378-3047-afd3-57ccfb6d37ef","info":{"title":"Segment Routing Point to Multi-point (Tree-SID) Policy Details","description":"This module defines a Data Model for reporting operational state of Segment Routing Point to Multi-point (P2MP) Policies (also known as Tree SID Policies).","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"}],"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","Since 5.0"],"summary":"Operational data for single SR P2MP policy","description":"Retrieve a single SR P2MP policy by name","operationId":"data_cisco_crosswork_segment_routing_p2mp_policy_p2mp_policies_p2mp_policy_p2mp_policy_name_get","parameters":[{"name":"p2mp-policy-name","in":"path","description":"The unique name of the P2MP policy","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-crosswork-segment-routing-p2mp-policy:p2mp-policy":{"type":"array","description":"(list)","items":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the P2MP policy (leaf)","format":"string"},"root-address":{"type":"string","description":"The root address of this P2MP policy (leaf)","format":"union"},"pcc-address":{"type":"string","description":"IP address of the Path Compute Client (PCC) (leaf)","format":"union"},"pce-address":{"type":"string","description":"The IP address of the PCE that computes the tree of the P2MP policy (leaf)","format":"union"},"initiation-type":{"type":"string","description":"Describes how the P2MP policy was initiated (leaf)","format":"string"},"admin-state":{"type":"string","description":"Administrative state of the P2MP policy (leaf)","format":"enumeration","default":"UP","enum":["UP","DOWN"]},"oper-state":{"type":"string","description":"Operational state of the P2MP policy (leaf)","format":"enumeration","default":"UP","enum":["UP","DOWN"]},"tree-id":{"type":"integer","description":"The Tree-ID for this P2MP policy.\nThis will be set to 0 for static policies. (leaf)","format":"uint32"},"destination":{"type":"array","description":"List of destinations (list)","items":{"type":"object","properties":{"destination-address":{"type":"string","description":"One of possibly many destination addresses of the this P2MP policy (leaf)","format":"union"}}}},"candidate-path":{"type":"array","description":"List of candidate paths associated with this P2MP policy.\nCurrently, Crosswork only supports a single candidate path. (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this P2MP path.\nThis will not be set at the path level until Crosswork support multiple candidate paths. (leaf)","format":"string"},"oper-state":{"type":"string","description":"Operational state of the P2MP policy (leaf)","format":"enumeration","default":"UP","enum":["UP","DOWN"]},"path-type":{"type":"string","description":"The path computation type of the P2MP policy (leaf)","format":"enumeration","default":"EXPLICIT","enum":["EXPLICIT","DYNAMIC"]},"label":{"type":"integer","description":"MPLS label associated with the P2MP policy (leaf)","format":"uint32"},"metric-type":{"type":"string","description":"Metric type to optimize for this path (leaf)","format":"enumeration","default":"IGP-METRIC","enum":["IGP-METRIC","TE-METRIC","DELAY","HOP-COUNT"]},"preference":{"type":"integer","description":"Preference for this path.\nThis will not be set until Crosswork support multiple candidate paths. (leaf)","format":"uint16"},"programming-state":{"type":"string","description":"The PCE defined state of this P2MP path.\nNONE indicates a steady state. (leaf)","format":"enumeration","default":"NONE","enum":["NONE","PROGRAMMING","PROGRAMMING-ROOT","PRUNING","PRUNING-ROOT","DELETING"]},"path-constraints":{"type":"object","properties":{"affinity":{"type":"object","properties":{"exclude-any":{"type":"integer","description":"Exclude-any attribute flags (leaf)","format":"uint32"},"include-any":{"type":"integer","description":"Include-any attribute flags (leaf)","format":"uint32"},"include-all":{"type":"integer","description":"Include-all attribute flags (leaf)","format":"uint32"}},"description":"Affinity information (non-presence)"},"frr-protected":{"type":"string","description":"Indicates if fast re-route is enabled (leaf)","format":"boolean"}},"description":"Path constraints (non-presence)"},"p2mp-node":{"type":"array","description":"The list of downstream nodes and their corresponding hops for this P2MP policy path. (list)","items":{"type":"object","properties":{"hostname":{"type":"string","description":"The hostname of this node. (leaf)","format":"string"},"node-ip-address":{"type":"string","description":"The IP prefix associated with this node in the tree.\nThis is generally the router ID of the node, but doesn't have to be. (leaf)","format":"union"},"role":{"type":"string","description":"The role of this node in the P2MP path (leaf)","format":"enumeration","default":"NONE","enum":["NONE","INGRESS","EGRESS","TRANSIT","BUD"]},"next-hop":{"type":"array","description":"List of all downstream nodes along with their next-hop information for this candidate path (list)","items":{"type":"object","properties":{"local-address":{"type":"string","description":"Local IP address of this hop (leaf)","format":"union"},"remote-address":{"type":"string","description":"Remote IP address of this hop (leaf)","format":"union"},"label":{"type":"integer","description":"Next hop outgoing label (leaf)","format":"uint32"},"next-hop-node-name":{"type":"string","description":"Next hop node hostname (leaf)","format":"string"},"next-hop-node-address":{"type":"string","description":"Next hop node IP address (leaf)","format":"union"}}}}}}}}}}}}}}}}}},"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_cisco_crosswork_segment_routing_p2mp_policy_p2mp_policies_p2mp_policy_p2mp_policy_name_get","method":"get","path":"/data/cisco-crosswork-segment-routing-p2mp-policy:p2mp-policies/p2mp-policy={p2mp-policy-name}"}}