Operational data of VPN services in batch - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Operational data of VPN services in batch","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6219a6a9-5e83-3308-b0e7-b31e69b09493","info":{"title":"ietf-l3vpn-ntw - operational data","description":"This YANG module defines a generic network-oriented model\nfor the configuration of Layer 3 Virtual Private Networks.\n\nCopyright (c) 2022 IETF Trust and the persons identified as\nauthors of the code. All rights reserved.\n\nRedistribution and use in source and binary forms, with or\nwithout modification, is permitted pursuant to, and subject\nto the license terms contained in, the Revised BSD License\nset forth in Section 4.c of the IETF Trust's Legal Provisions\nRelating to IETF Documents\n(https://trustee.ietf.org/license-info).\n\nThis version of this YANG module is part of RFC 9182; see the\nRFC itself for full legal notices.","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":"Operational data","description":"Operational data resources"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/ietf-l3vpn-ntw-oper-data-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/nbi/cat-inventory/v1/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":["Operational data","Since 7.1.0"],"summary":"Operational data of VPN services in batch.","description":"Operational data that includs service health status and discovered underlay references of VPN services in a batch using offset and limit query params.","operationId":"data_ietf_l3vpn_ntw_l3vpn_ntw_vpn_services_vpn_service_vpn_service_list_get","parameters":[{"name":"content","in":"query","description":"required to return the operational(non config) data under the vpn service container","schema":{"type":"string","format":"enumeration","enum":["nonconfig"]}},{"name":"offset","in":"query","description":"Used by the client to specify the number of list elements to skip before returning the requested set of list entries. The value is an integer greater than or equal to 0.","schema":{"type":"integer","format":"uint32"}},{"name":"limit","in":"query","description":"Used by the client to specify a limited set of list entries to retrieve. The value is an integer greater than or equal to 1","schema":{"type":"integer","format":"uint16"}}],"responses":{"200":{"description":"List of VPN service Containers with Oper data.","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"ietf-l3vpn-ntw:vpn-service":{"type":"array","description":"List of VPN services. (list)","items":{"type":"object","properties":{"vpn-id":{"type":"string","description":"A VPN identifier that uniquely identifies a VPN.\nThis identifier has a local meaning, e.g., within\na service provider network. (leaf)","format":"string","x-yang":{"type":"leaf"}},"underlay-transport":{"type":"object","properties":{"cisco-l3vpn-ntw:discovered-underlay-transport":{"type":"object","properties":{"cisco-l3vpn-ntw:sr-policy-ref":{"type":"array","description":"List of sr-policies (static or dynamically created) (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:headend":{"type":"string","description":"SR policy Headend Device ID (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:endpoint":{"type":"string","description":"SR policy Endopint IP (leaf)","format":"union","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:color":{"type":"integer","description":"\u003c1-4294967295\u003e - SR policy color (leaf)","format":"uint32","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:te-tunnel-ref":{"type":"array","description":"List of rsvp-te tunnels (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:tunnel-id":{"type":"string","description":"TE tunnel Identifier (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:destination":{"type":"string","description":"TE tunnel Destination IP (leaf)","format":"union","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:source":{"type":"string","description":"TE tunnel Source IP (leaf)","format":"union","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"HCO service to underlay transport mapping (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Container for the underlay transport. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"status":{"type":"object","properties":{"oper-status":{"type":"object","properties":{"last-change":{"type":"string","description":"Indicates the actual date and time of the service status\nchange. (leaf)","format":"string","x-yang":{"type":"leaf"}},"status":{"type":"string","description":"Operational status. (leaf)","format":"identityref","x-yang":{"type":"leaf"}}},"description":"Operational service status. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Service status. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}}},"x-yang":{"type":"list"}}},"$$ref":"#/components/schemas/data_ietf-l3vpn-ntw_l3vpn-ntw_vpn-services_vpn-service_vpn-service-vpn-id"}}}},"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":[]}],"__originalOperationId":"data_ietf_l3vpn_ntw_l3vpn_ntw_vpn_services_vpn_service_vpn_service_list_get","method":"get","path":"/data/ietf-l3vpn-ntw:l3vpn-ntw/vpn-services/vpn-service"}}