CS SR-TE Policy Configuration - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"CS SR-TE Policy Configuration","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/ad560a77-52ad-3da8-8a24-767d1114ca74","info":{"title":"cisco-cs-sr-te-cfp","description":"CS SR-TE Policies Module","termsOfService":"http://www.cisco.com/web/siteassets/legal/terms_condition.html","contact":{"name":"Cisco Systems","url":"https://www.cisco.com","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"tags":[{"name":"data","description":"service configuration data resources"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/cisco-cs-sr-te-cfp-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/proxy/nso/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":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"tags":["data"],"summary":"CS SR-TE Policy Configuration","description":"CS SR-TE Policy Configuration","operationId":"data_cisco_cs_sr_te_cfp_cs_sr_te_policy_cs_sr_te_policy_name_patch","parameters":[{"name":"cs-sr-te-policy-name","in":"path","description":"Name of CS SR-TE Policy","required":true,"schema":{"type":"string","format":"string"}}],"requestBody":{"description":"CS SR-TE Policy Configuration","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-cs-sr-te-cfp:cs-sr-te-policy":{"type":"array","description":"CS SR-TE Policy Configuration (list)","items":{"type":"object","properties":{"head-end":{"type":"object","properties":{"ip-address":{"type":"string","description":"Policy router IPv4/IPv6 (leaf)","format":"union","x-yang":{"type":"leaf"}},"custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"device":{"type":"string","description":"Policy router (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"source-address":{"type":"string","description":"Source address of policy. The value set on a per-policy basis\n will override the value set globally on the device. (leaf)","format":"union","x-yang":{"type":"leaf"}}},"description":"Policy Head-end router (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"auto-color":{"type":"string","description":"Auto allocate color. Previously used explicit color values must be excluded from color Resource pool to avoid duplication. (leaf)","format":"[null]","x-yang":{"type":"leaf"}},"restore-path":{"type":"object","properties":{"explicit":{"type":"object","properties":{"reverse-sid-list-name":{"type":"string","description":"Use a predefined reverse explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"forward-sid-list-name":{"type":"string","description":"Use a predefined forward explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"constraints":{"type":"object","properties":{"affinity":{"type":"object","properties":{"rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}},"action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"segments":{"type":"object","properties":{"sid-algorithm":{"type":"integer","description":"\u003c128-255\u003e - Specify the path computation metric options (leaf)","format":"uint16","x-yang":{"type":"leaf"}}},"description":"Path segments constraints (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}},"revertive":{"type":"string","description":"Revertive protect path. Default = false (non-revertive) (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"wait-to-revert-timer":{"type":"integer","description":"\u003c0 - 3000\u003e -- seconds to wait before reverting. Default = 300 (leaf)","format":"uint32","x-yang":{"type":"leaf"}}},"description":"Restore path (presence)","x-yang":{"is_presence":"true","type":"container"}},"bandwidth":{"type":"integer","description":"\u003c1-4294967295\u003e Requested Bandwidth value in kbps (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"tail-end":{"type":"object","properties":{"ip-address":{"type":"string","description":"Policy router IPv4/IPv6 (leaf)","format":"union","x-yang":{"type":"leaf"}},"custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"device":{"type":"string","description":"Policy router (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"source-address":{"type":"string","description":"Source address of policy. The value set on a per-policy basis\n will override the value set globally on the device. (leaf)","format":"union","x-yang":{"type":"leaf"}}},"description":"Policy Tail-end router (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"working-path":{"type":"object","properties":{"explicit":{"type":"object","properties":{"reverse-sid-list-name":{"type":"string","description":"Use a predefined reverse explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"forward-sid-list-name":{"type":"string","description":"Use a predefined forward explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"constraints":{"type":"object","properties":{"affinity":{"type":"object","properties":{"rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}},"action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"segments":{"type":"object","properties":{"sid-algorithm":{"type":"integer","description":"\u003c128-255\u003e - Specify the path computation metric options (leaf)","format":"uint16","x-yang":{"type":"leaf"}}},"description":"Path segments constraints (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Working path (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"steering":{"type":"object","properties":{"drop-traffic-on-invalid-path":{"type":"string","description":"Drop traffic when all paths are invalid. Default = false (leaf)","format":"boolean","x-yang":{"type":"leaf"}}},"description":"Steering (presence)","x-yang":{"is_presence":"true","type":"container"}},"protect-path":{"type":"object","properties":{"explicit":{"type":"object","properties":{"reverse-sid-list-name":{"type":"string","description":"Use a predefined reverse explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"forward-sid-list-name":{"type":"string","description":"Use a predefined forward explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"constraints":{"type":"object","properties":{"affinity":{"type":"object","properties":{"rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}},"action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"segments":{"type":"object","properties":{"sid-algorithm":{"type":"integer","description":"\u003c128-255\u003e - Specify the path computation metric options (leaf)","format":"uint16","x-yang":{"type":"leaf"}}},"description":"Path segments constraints (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}},"revertive":{"type":"string","description":"Revertive protect path. Default = false (non-revertive) (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"wait-to-revert-timer":{"type":"integer","description":"\u003c0 - 3000\u003e -- seconds to wait before reverting. Default = 300 (leaf)","format":"uint32","x-yang":{"type":"leaf"}}},"description":"Protect path (presence)","x-yang":{"is_presence":"true","type":"container"}},"disjoint-path":{"type":"object","properties":{"reverse-path":{"type":"object","properties":{"sub-id":{"type":"integer","description":"\u003c1-65535\u003e - Subgroup ID number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"group-id":{"type":"integer","description":"\u003c1-65535\u003e - Group ID (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"type":{"type":"string","description":"(leaf)","format":"enumeration","default":"link","enum":["link","node","srlg","srlg-node"],"x-yang":{"type":"leaf"}}},"description":"Compute a reverse path that is disjoint from another path in the same disjoint-group.\nApplies to working and protect paths. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"forward-path":{"type":"object","properties":{"sub-id":{"type":"integer","description":"\u003c1-65535\u003e - Subgroup ID number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"group-id":{"type":"integer","description":"\u003c1-65535\u003e - Group ID (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"type":{"type":"string","description":"(leaf)","format":"enumeration","default":"link","enum":["link","node","srlg","srlg-node"],"x-yang":{"type":"leaf"}}},"description":"Compute a forward path that is disjoint from another path in the same disjoint-group.\nApplies to working and protect paths. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Compute a path that is disjoint from another path in the same disjoint-group.\n Applies to working and protect paths. (presence)","x-yang":{"is_presence":"true","type":"container"}},"custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"performance-measurement":{"type":"object","properties":{"reverse-path-label":{"type":"integer","description":"\u003c16-1048575\u003e - PM packets return to head-end using a label (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"delay-measurement":{"type":"object","properties":{"profile":{"type":"string","description":"Delay profile name (leaf)","format":"string","x-yang":{"type":"leaf"}},"logging":{"type":"object","properties":{"delay-exceeded":{"type":"string","description":"Emit syslog when the delay exceeds the threshold (leaf)","format":"[null]","x-yang":{"type":"leaf"}}},"description":"Syslog configuration options (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Delay measurement (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Enable performance measurement (presence)","x-yang":{"is_presence":"true","type":"container"}},"name":{"type":"string","description":"Name of CS SR-TE Policy (leaf)","format":"string","x-yang":{"type":"leaf"}},"path-protection":{"type":"object","properties":{},"description":"Path Protection (presence)","x-yang":{"is_presence":"true","type":"container"}}}},"x-yang":{"type":"list"}}},"$$ref":"#/components/schemas/data_cisco-cs-sr-te-cfp_cs-sr-te-policy_cs-sr-te-policy-name"}}},"required":true},"responses":{"204":{"description":"list cs-sr-te-policy updated","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":[{"bearerAuth":[]}],"x-codegen-request-body-name":"cs-sr-te-policy","__originalOperationId":"data_cisco_cs_sr_te_cfp_cs_sr_te_policy_cs_sr_te_policy_name_patch","method":"patch","path":"/data/cisco-cs-sr-te-cfp:cs-sr-te-policy={cs-sr-te-policy-name}"}}