{"type":"api","title":"SR-Policy","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/a0b7c44f-3ff4-3b45-9b54-5659c8a28eb0","info":{"title":"cisco-sr-te-cfp","description":"SR-TE core function pack","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":"data resources"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/cisco-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":"SR-Policy","description":"SR-Policy","operationId":"data_cisco_sr_te_cfp_sr_te_cisco_sr_te_cfp_sr_policies_policies_cisco_sr_te_cfp_sr_policies_policy_cisco_sr_te_cfp_sr_policies_policy_name_put","parameters":[{"name":"cisco-sr-te-cfp-sr-policies_policy-name","in":"path","description":"Unique identifier for a SR-Policy","required":true,"schema":{"type":"string","format":"string"}},{"name":"insert","in":"query","description":"controlling the order when adding new list elements","schema":{"type":"string","format":"enumeration","default":"first","enum":["first","last","before","after"]}},{"name":"point","in":"query","description":"used to specify the insertion point","schema":{"type":"string","format":"string"}}],"requestBody":{"description":"SR-Policy","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:policy":{"type":"array","description":"SR-Policy (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:circuit-style":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:restore-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:revertive":{"type":"string","description":"Revertive protect path. Default = false (non-revertive) (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:explicit":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:forward-sid-list-name":{"type":"string","description":"Use a predefined forward explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:constraints":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:affinity":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:segments":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:reverse-sid-list-name":{"type":"string","description":"Use a predefined reverse explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:steering":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:protect-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:revertive":{"type":"string","description":"Revertive protect path. Default = false (non-revertive) (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:explicit":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:forward-sid-list-name":{"type":"string","description":"Use a predefined forward explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:constraints":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:disjoint-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:sub-id":{"type":"integer","description":"\u003c1-65535\u003e Subgroup ID number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:group-id":{"type":"integer","description":"\u003c1-65535\u003e - Group ID (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:type":{"type":"string","description":"(leaf)","format":"enumeration","default":"link","enum":["link","node","srlg","srlg-node"],"x-yang":{"type":"leaf"}}},"description":"Compute a path that is disjoint from another path in the same disjoint-group (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:affinity":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:segments":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:reverse-sid-list-name":{"type":"string","description":"Use a predefined reverse explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:path-protection":{"type":"object","properties":{},"description":"Path Protection (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:working-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:explicit":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:forward-sid-list-name":{"type":"string","description":"Use a predefined forward explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:constraints":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:disjoint-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:sub-id":{"type":"integer","description":"\u003c1-65535\u003e Subgroup ID number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:group-id":{"type":"integer","description":"\u003c1-65535\u003e - Group ID (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:type":{"type":"string","description":"(leaf)","format":"enumeration","default":"link","enum":["link","node","srlg","srlg-node"],"x-yang":{"type":"leaf"}}},"description":"Compute a path that is disjoint from another path in the same disjoint-group (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:affinity":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:segments":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:reverse-sid-list-name":{"type":"string","description":"Use a predefined reverse explicit path (leaf)","format":"leafref","x-yang":{"type":"leaf"}}},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Working path (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"This is service to configure a SR Circuit Style policy (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-policies:variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-policies:path":{"type":"array","description":"SR-Policy candidate paths (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:preference":{"type":"integer","description":"\u003c1-65535\u003e - Path preference - Higher value indicates higher preference (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:explicit":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:sid-list":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:weight":{"type":"integer","description":"\u003c1-4294967295\u003e - SID-List weight (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:name":{"type":"string","description":"(leaf)","format":"leafref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-policies:constraints":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:disjoint-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:sub-id":{"type":"integer","description":"\u003c1-65535\u003e;;Subgroup ID number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:group-id":{"type":"integer","description":"\u003c1-65535\u003e - Group ID (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:type":{"type":"string","description":"(leaf)","format":"enumeration","default":"link","enum":["link","node","srlg","srlg-node"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:source":{"type":"string","description":"\u003cA.B.C.D\u003e - Association source, applicable only on XE device\nThis config is mandatory when setting association-group. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"Compute a path that is disjoint from another path in the same disjoint-group (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:affinity":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:action":{"type":"string","description":"(leaf)","format":"enumeration","default":"include-any","enum":["include-any","include-all","exclude-any"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:color":{"type":"array","items":{"type":"string","description":"One of affinity-map color names (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}}},"x-yang":{"type":"list"}}},"description":"Compute paths with link color constraint (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:segments":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies: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":"Use a predefine explicit path (presence)","x-yang":{"is_presence":"true","type":"container"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-policies:bandwidth":{"type":"integer","description":"\u003c1-4294967295\u003e Requested Bandwidth value in kbps (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:color":{"type":"integer","description":"\u003c1-4294967295\u003e - SR policy color (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies:name":{"type":"string","description":"Unique identifier for a SR-Policy (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:binding-sid":{"type":"integer","description":"\u003c16-1048575\u003e - Binding SID of the SR-Policy applied at the headend (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:performance-measurement":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:delay-measurement":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:profile":{"type":"string","description":"Delay profile name (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:logging":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies: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"}},"cisco-sr-te-cfp-sr-policies: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"}}},"description":"Enable performance measurement (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:auto-route":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:force-sr-include":{"type":"string","description":"Force autoroute policy to be safe for carrying SR labelled traffic (leaf)","format":"[null]","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:forward-class":{"type":"integer","description":"\u003c0-7\u003e Specify forward class for policy based routing (leaf)","format":"byte","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:auto-route-metric":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:metric-relative-value":{"type":"string","description":"\u003c(-10)-10\u003e - Autoroute relative metric (leaf)","format":"int32","x-yang":{"type":"leaf"}}},"description":"Autoroute metric (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:include-prefixes":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:include-prefix":{"type":"array","description":"\u003cA.B.C.D/prefix\u003e Autoroute IP prefix to include (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:prefix-address":{"type":"string","description":"\u003cA.B.C.D/prefix\u003e - Autoroute IP prefix to include (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Autoroute include prefix table configuration (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Enable Autoroute on this SR-policy (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-policies:action":{"type":"object","properties":{},"description":"(non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-sr-te-cfp-sr-policies:head-end":{"type":"array","description":"Policy headend router. Only one headend can be given for a policy service (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:name":{"type":"string","description":"(leaf)","format":"leafref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-policies:tail-end":{"type":"string","description":"\u003cA.B.C.D or X:X::X\u003e - Router-Id of the tail-end device of the SR policy (leaf)","format":"union","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:srv6":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:locator":{"type":"object","properties":{"cisco-sr-te-cfp-sr-policies:behavior":{"type":"string","description":"SRv6 USID Behavior (leaf)","format":"enumeration","default":"ub6-insert-reduced","enum":["ub6-insert-reduced"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:binding-sid-type":{"type":"string","description":"Binding Segment ID type (leaf)","format":"enumeration","default":"srv6-dynamic","enum":["srv6-dynamic"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-policies:locator-name":{"type":"string","description":"SRv6 locator name,\nshould match locators configured at a node-global level on each router (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"SRv6 Locator options, settings under this container will override\n the settings at SR-TE or at a Global level in the headend node. (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"SRv6 Options (presence)","x-yang":{"is_presence":"true","type":"container"}}}},"x-yang":{"type":"list"}}},"$$ref":"#/components/schemas/data_cisco-sr-te-cfp_sr-te_cisco-sr-te-cfp-sr-policies_policies_cisco-sr-te-cfp-sr-policies_policy_cisco-sr-te-cfp-sr-policies_policy-name"}}},"required":true},"responses":{"201":{"description":"list policy created or replaced","content":{}},"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":[{"bearerAuth":[]}],"x-codegen-request-body-name":"policy","__originalOperationId":"data_cisco_sr_te_cfp_sr_te_cisco_sr_te_cfp_sr_policies_policies_cisco_sr_te_cfp_sr_policies_policy_cisco_sr_te_cfp_sr_policies_policy_name_put","method":"put","path":"/data/cisco-sr-te-cfp:sr-te/cisco-sr-te-cfp-sr-policies:policies/cisco-sr-te-cfp-sr-policies:policy={cisco-sr-te-cfp-sr-policies_policy-name}"}}