SR-TE ODN template - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"SR-TE ODN template","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-TE ODN template","description":"SR-TE ODN template","operationId":"data_cisco_sr_te_cfp_sr_te_cisco_sr_te_cfp_sr_odn_odn_cisco_sr_te_cfp_sr_odn_odn_template_cisco_sr_te_cfp_sr_odn_odn_template_name_put","parameters":[{"name":"cisco-sr-te-cfp-sr-odn_odn-template-name","in":"path","description":"Unique identifier for a ODN template","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-TE ODN template","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:odn-template":{"type":"array","description":"SR-TE ODN template (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:head-end":{"type":"array","description":"List of headend routers (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"(leaf)","format":"leafref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-odn:bandwidth":{"type":"integer","description":"\u003c1-4294967295\u003e Requested Bandwidth value in kbps (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:pce-group":{"type":"string","description":"(leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-sr-te-cfp-sr-odn:dynamic":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:metric-type":{"type":"string","description":"Metric type configuration (leaf)","format":"enumeration","default":"igp","enum":["igp","te","latency","hopcount"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:affinity":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:rule":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn: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-odn: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-odn:segments":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn: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"}},"cisco-sr-te-cfp-sr-odn:flex-alg":{"type":"integer","description":"\u003c128-255\u003e - Prefix-SID algorithm (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:pce":{"type":"object","properties":{},"description":"Delegate dynamic path computation to PCE (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-odn:metric-margin":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:absolute":{"type":"integer","description":"\u003c0-2147483647\u003e Absolute metric margin value (leaf)","format":"uint32","x-yang":{"type":"leaf"}}},"description":"Metric-margin (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-odn:disjoint-path":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:type":{"type":"string","description":"(leaf)","format":"enumeration","default":"link","enum":["link","node","srlg","srlg-node"],"x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:sub-id":{"type":"integer","description":"\u003c1-65535\u003e Subgroup ID number (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn: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"}},"cisco-sr-te-cfp-sr-odn:group-id":{"type":"integer","description":"\u003c1-65535\u003e - Group ID (leaf)","format":"uint16","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"}}},"description":"Use dynamic path computation (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-sr-te-cfp-sr-odn:performance-measurement":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:delay-measurement":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:profile":{"type":"string","description":"Delay profile name (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:logging":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn: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-odn: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-odn:srv6":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn:locator":{"type":"object","properties":{"cisco-sr-te-cfp-sr-odn: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-odn: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-odn: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"}},"cisco-sr-te-cfp-sr-odn:color":{"type":"integer","description":"\u003c1-4294967295\u003e - SR policy color (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn:name":{"type":"string","description":"Unique identifier for a ODN template (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-sr-te-cfp-sr-odn: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-odn:maximum-sid-depth":{"type":"integer","description":"\u003c1-255\u003e - Maximum SID Depth (leaf)","format":"byte","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"$$ref":"#/components/schemas/data_cisco-sr-te-cfp_sr-te_cisco-sr-te-cfp-sr-odn_odn_cisco-sr-te-cfp-sr-odn_odn-template_cisco-sr-te-cfp-sr-odn_odn-template-name"}}},"required":true},"responses":{"201":{"description":"list odn-template 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":"odn-template","__originalOperationId":"data_cisco_sr_te_cfp_sr_te_cisco_sr_te_cfp_sr_odn_odn_cisco_sr_te_cfp_sr_odn_odn_template_cisco_sr_te_cfp_sr_odn_odn_template_name_put","method":"put","path":"/data/cisco-sr-te-cfp:sr-te/cisco-sr-te-cfp-sr-odn:odn/cisco-sr-te-cfp-sr-odn:odn-template={cisco-sr-te-cfp-sr-odn_odn-template-name}"}}