openapi: 3.2.0 info: title: Crosswork Network Controller IETF-TE Tunnel IETF-TE Provision API description: This document contains details of the Crosswork Network Controller IETF-TE Tunnel APIs version: '2.0' 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 x-provenance: method: harvested authored_by: Cisco Crosswork harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true note: Published by Cisco. Retrieved unmodified except for this x-provenance block. provider_published: true x-evidence: - type: source url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/CNC/2.0APIs/ietf-te_api.swagger.json - type: raw url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/CNC/2.0APIs/ietf-te_api.swagger.json servers: - url: /crosswork tags: - name: IETF-TE Provision description: '' paths: /proxy/nso/restconf/data/ietf-te:te/tunnels/tunnel={tunnel-name}: post: tags: - IETF-TE Provision summary: '' description: P2P TE tunnels list. operationId: data_ietf_te_te_tunnels_tunnel_tunnel_name_patch parameters: - $ref: '#/components/parameters/tunnel-name' - $ref: '#/components/parameters/data_ietf-te_te_tunnels_tunnel_tunnel-name' responses: '204': description: list tunnel updated '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' security: - basicAuth: [] put: tags: - IETF-TE Provision summary: '' description: P2P TE tunnels list. operationId: data_ietf_te_te_tunnels_tunnel_tunnel_name_put parameters: - $ref: '#/components/parameters/tunnel-name' - $ref: '#/components/parameters/data_ietf-te_te_tunnels_tunnel_tunnel-name' - $ref: '#/components/parameters/insert' - $ref: '#/components/parameters/point' responses: '201': description: list tunnel created or replaced '204': $ref: '#/components/responses/204' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' security: - basicAuth: [] patch: tags: - IETF-TE Provision summary: '' description: P2P TE tunnels list. operationId: data_ietf_te_te_tunnels_tunnel_tunnel_name_patch parameters: - $ref: '#/components/parameters/tunnel-name' - $ref: '#/components/parameters/data_ietf-te_te_tunnels_tunnel_tunnel-name' responses: '204': description: list tunnel updated '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' security: - basicAuth: [] delete: tags: - IETF-TE Provision summary: '' description: P2P TE tunnels list. operationId: data_ietf_te_te_tunnels_tunnel_tunnel_name_delete parameters: - $ref: '#/components/parameters/tunnel-name' responses: '204': $ref: '#/components/responses/204' security: - basicAuth: [] components: parameters: point: name: point in: query description: used to specify the insertion point required: false schema: type: string format: string insert: name: insert in: query description: controlling the order when adding new list elements required: false schema: type: string format: enumeration enum: - first - last - before - after default: first data_ietf-te_te_tunnels_tunnel_tunnel-name: name: tunnel in: body description: P2P TE tunnels list. required: true schema: $ref: '#/components/schemas/data_ietf-te_te_tunnels_tunnel_tunnel-name' tunnel-name: name: tunnel-name in: path description: TE tunnel name. required: true schema: type: string format: string responses: '405': description: Method Not Allowed '404': description: Not Found '204': description: No Content '401': description: Unauthorized '409': description: Conflict '400': description: Bad Request schemas: data_ietf-te_te_tunnels_tunnel_tunnel-name: type: object properties: ietf-te:tunnel: type: array description: P2P TE tunnels list. (list) x-yang: type: list items: type: object properties: modified: description: 'Devices and other services this service has modified directly or indirectly (through another service). (non-presence)' type: object x-yang: type: container is_presence: 'false' properties: devices: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: leafref services: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: instance-identifier lsa-services: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: instance-identifier directly-modified: description: 'Devices and other services this service has explicitly modified. (non-presence)' type: object x-yang: type: container is_presence: 'false' properties: devices: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: leafref services: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: instance-identifier lsa-services: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: instance-identifier device-list: type: array x-yang: type: leaf-list items: description: 'A list of managed devices this service instance has manipulated. This leaf is obsolete. Use ''modified'' instead. (leaf-list)' type: string format: string used-by-customer-service: type: array x-yang: type: leaf-list items: description: (leaf-list) type: string format: leafref commit-queue: description: (non-presence) type: object x-yang: type: container is_presence: 'false' properties: queue-item: type: array description: "When a service is committed through the commit queue, these\nfields act as references regarding the state of this service\ninstance. In the worst case scenario, a service instance is\nin the 'failed' state. This means that parts of the queued\ncommit failed.\n\nIf a service gets committed through the commit queue and the\ncommit fails, the backpointers in the service data are\nfollowed and the affected service instances are updated and\nset to the 'failed' state.\n\nDepending on the nature of the failure, different techniques\nto reconcile the service can be used.\n\n- Make sure the commit queue is blocked to not interfere\n with the error recovery procedure.\n Do a sync-from on the non-completed device(s) and then\n re-deploy the failed service(s) with the\n 'reconcile' option to reconcile original data,\n i.e., take control of that data. This option\n acknowledges other services controlling the same data.\n The reference count will indicate how many services control\n the data. Release any queue lock that was created.\n\n- Make sure the commit queue is blocked to not interfere\n with the error recovery procedure.\n Use un-deploy with the no-networking option on the\n service and then do sync-from on the non-completed\n device(s). Make sure the error is fixed and then\n re-deploy the failed service(s) with the\n 'reconcile' option. Release any queue lock\n that was created.\n\nIn the 'failed' state, these fields are reset if a new\ncommit queue transaction is affecting this service, or\nthe service is re-deployed, or these fields are deleted\nusing the specific purge action.\nIn other cases the 'failed' state will remain. (list)" x-yang: type: list items: type: object properties: id: description: 'If the queue item in the commit queue refers to this service this is the queue number. (leaf)' x-yang: type: leaf type: integer format: uint64 status: description: (leaf) x-yang: type: leaf type: string format: enumeration default: waiting enum: - waiting - executing - blocking - blocked - failed - admin-cleared - commit-queue-failed cleared-by-admin: description: (leaf) x-yang: type: leaf type: string format: '[null]' no-of-impacted-services: description: (leaf) x-yang: type: leaf type: integer format: uint32 failed-device: type: array description: 'If the ''status'' leaf is ''failed'', this list contains detailed information on the devices that were responsible for the error of the commit queue item. (list)' x-yang: type: list items: type: object properties: name: description: (leaf) x-yang: type: leaf type: string format: leafref time: description: Time when the failure occured. (leaf) x-yang: type: leaf type: string format: string config-data: description: 'The configuration data that was rejected by the device in XML format. (leaf)' x-yang: type: leaf type: string format: string error: description: The error returned by the device. (leaf) x-yang: type: leaf type: string format: string private: description: NCS service related internal data stored here. (non-presence) type: object x-yang: type: container is_presence: 'false' properties: diff-set: description: 'Internal node use by NCS service manager to remember the reverse diff for a service instance. This is the data that is used by FastMap (leaf)' x-yang: type: leaf type: string format: binary forward-diff-set: description: 'Internal node use by NCS service manager to remember the forwards diff for a service instance. This data is is used to produce the proper ''get-modifications'' output (leaf)' x-yang: type: leaf type: string format: binary device-list: type: array x-yang: type: leaf-list items: description: A list of managed devices this service instance has manipulated. (leaf-list) type: string format: string ned-id-list: type: array x-yang: type: leaf-list items: description: A list of NED identities this service instance has manipulated. (leaf-list) type: string format: string service-list: type: array x-yang: type: leaf-list items: description: A list of services this service instance has manipulated. (leaf-list) type: string format: instance-identifier lsa-service-list: type: array x-yang: type: leaf-list items: description: A list of LSA services this service instance has manipulated. (leaf-list) type: string format: string property-list: description: FASTMAP service instance data used by the service implementation. (non-presence) type: object x-yang: type: container is_presence: 'false' properties: property: type: array description: (list) x-yang: type: list items: type: object properties: name: description: (leaf) x-yang: type: leaf type: string format: string value: description: (leaf) x-yang: type: leaf type: string format: string re-deploy-counter: description: (leaf) x-yang: type: leaf type: string format: int32 latest-commit-params: description: 'Latest transactions commit parameters are stored there, these are used in reactive-re-deploy actions that must have the same parameters as the original service commit. (leaf)' x-yang: type: leaf type: string format: binary latest-u-info: description: 'Latest transactions user info is stored there, these are used in reactive-re-deploy actions that must be performed by a user with the same user info. (leaf)' x-yang: type: leaf type: string format: binary plan-location: description: Location of the service plan. (leaf) x-yang: type: leaf type: string format: instance-identifier log: description: (non-presence) type: object x-yang: type: container is_presence: 'false' properties: log-entry: type: array description: (list) x-yang: type: list items: type: object properties: when: description: (leaf) x-yang: type: leaf type: string format: string type: description: What type of log entry is this. (leaf) x-yang: type: leaf type: string format: identityref level: description: What level this log entry has. (leaf) x-yang: type: leaf type: string format: enumeration default: all enum: - all - trace - debug - info - warn - error message: description: (leaf) x-yang: type: leaf type: string format: string custom-template: type: array description: Custom templates to apply when device is ready (list) x-yang: type: list items: type: object properties: name: description: Name of template to apply (leaf) x-yang: type: leaf type: string format: leafref variable: type: array description: Variables to bind when applying template one time (list) x-yang: type: list items: type: object properties: name: description: Name of template variable (leaf) x-yang: type: leaf type: string format: leafref value: description: Value of template variable (leaf) x-yang: type: leaf type: string format: string iteration: type: array description: Apply custom template multiple times with iteration (list) x-yang: type: list items: type: object properties: number: description: <1-65535>;;Iteration number (leaf) x-yang: type: leaf type: integer format: uint16 variable: type: array description: Variables to bind when applying template in iteration (list) x-yang: type: list items: type: object properties: name: description: Name of template variable (leaf) x-yang: type: leaf type: string format: leafref value: description: Value of template variable (leaf) x-yang: type: leaf type: string format: string name: description: TE tunnel name. (leaf) x-yang: type: leaf type: string format: string identifier: description: TE tunnel Identifier Range <0-65535> (leaf) x-yang: type: leaf type: integer format: uint16 description: description: Textual description for this TE tunnel (leaf) x-yang: type: leaf type: string format: string source: description: TE tunnel source node ID. (leaf) x-yang: type: leaf type: string format: string destination: description: TE tunnel destination node ID (leaf) x-yang: type: leaf type: string format: string bidirectional: description: TE tunnel bidirectional (leaf) x-yang: type: leaf type: string format: boolean te-bandwidth: description: 'Container that specifies TE bandwidth. The choices can be augmented for specific dataplane technologies. (non-presence)' type: object x-yang: type: container is_presence: 'false' properties: generic: description: Bandwidth specified in a generic format. (leaf) x-yang: type: leaf type: string format: string setup-priority: description: <0-7> - TE LSP requested setup priority (leaf) x-yang: type: leaf type: integer format: byte hold-priority: description: <0-7> - TE LSP requested hold priority (leaf) x-yang: type: leaf type: integer format: byte signaling-type: description: path-setup-rsvp;; TE tunnel path signaling type. (leaf) x-yang: type: leaf type: string format: identityref p2p-primary-paths: description: Set of P2P primary aths container (non-presence) type: object x-yang: type: container is_presence: 'false' properties: p2p-primary-path: type: array description: List of primary paths for this tunnel. (list) x-yang: type: list items: type: object properties: name: description: TE path name (leaf) x-yang: type: leaf type: string format: string path-computation-method: description: 'The method used for computing the path, either locally computed, queried from a server or not computed at all (explicitly configured). (leaf)' x-yang: type: leaf type: string format: identityref optimizations: description: 'The objective function container that includes attributes to impose when computing a TE path (non-presence)' type: object x-yang: type: container is_presence: 'false' properties: optimization-metric: type: array description: TE path metric type. (list) x-yang: type: list items: type: object properties: metric-type: description: 'Identifies an entry in the list of metric-types to optimize the TE path for. (leaf)' x-yang: type: leaf type: string format: identityref preference: description: 'Specifies a preference for this path. The lower the number higher the preference. Range <1-255> (leaf)' x-yang: type: leaf type: integer format: byte explicit-route-objects-always: description: Container for the exclude route object list (non-presence) type: object x-yang: type: container is_presence: 'false' properties: route-object-include-exclude: type: array description: 'List of route objects to include or exclude in path computation (list)' x-yang: type: list items: type: object properties: explicit-route-usage: description: Include or exclude usage. Default is to include (leaf) x-yang: type: leaf type: string format: identityref index: description: 'Route object include-exclude index <0-65535>. The index is used to identify an entry in the list. The order of entries is defined by the user without relying on key values (leaf)' x-yang: type: leaf type: integer format: uint32 numbered-node-hop: description: Numbered node route hop (non-presence) type: object x-yang: type: container is_presence: 'false' properties: node-id: description: The identifier of a node in the TE topology. (leaf) x-yang: type: leaf type: string format: string hop-type: description: strict or loose hop (leaf) x-yang: type: leaf type: string format: enumeration default: loose enum: - loose - strict action: description: (non-presence) type: object x-yang: type: container is_presence: 'false' properties: {} head-end: description: Source device name. (leaf) x-yang: type: leaf type: string format: leafref tail-end: description: Destination device name. (leaf) x-yang: type: leaf type: string format: leafref traffic-steering: description: Steer traffic traffic through the tunnel (non-presence) type: object x-yang: type: container is_presence: 'false' properties: autoroute: description: Parameters for IGP routing over tunnel (non-presence) type: object x-yang: type: container is_presence: 'false' properties: announce: description: Announce tunnel to IGP (non-presence) type: object x-yang: type: container is_presence: 'false' properties: enable: description: Enable autoroute announce (leaf) x-yang: type: leaf type: string format: boolean metric: description: Specify MPLS tunnel metric (presence) type: object x-yang: type: container is_presence: 'true' properties: constant: description: <1-2147483647> - Set constant metric (leaf) x-yang: type: leaf type: integer format: uint32 destination: type: array description: Adds static route address A.B.C.D to destination (list) x-yang: type: list items: type: object properties: address: description: A.B.C.D - IPv4 Address of static route to add (leaf) x-yang: type: leaf type: string format: string securitySchemes: basicAuth: type: http scheme: basic