VPN Service intent - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"VPN Service intent","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/95ba1613-2d4e-38da-ab28-e8079478bb37","info":{"title":"ietf-l3vpn-ntw","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":"data","description":"data resources"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/ietf-l3vpn-ntw-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":"VPN Service intent.","description":"VPN Service intent.","operationId":"data_ietf_l3vpn_ntw_l3vpn_ntw_vpn_services_vpn_service_vpn_service_vpn_id_get","parameters":[{"name":"vpn-service-vpn-id","in":"path","description":"A VPN identifier that uniquely identifies a VPN.\nThis identifier has a local meaning, e.g., within\na service provider network.","required":true,"schema":{"type":"string","format":"string"}},{"name":"content","in":"query","description":"controlling descendant nodes in response","schema":{"type":"string","format":"enumeration","default":"config","enum":["config","nonconfig","all"]}},{"name":"depth","in":"query","description":"limit the depth of nodes in response","schema":{"type":"integer","format":"uint16"}},{"name":"fields","in":"query","description":"optionally identify specific data nodes in response","schema":{"type":"string","format":"string"}},{"name":"filter","in":"query","description":"xpath expression to filter data nodes in response","schema":{"type":"string","format":"string"}},{"name":"with-defaults","in":"query","description":"controlling default values in response","schema":{"type":"string","format":"enumeration","default":"report-all","enum":["report-all","trim","explicit","report-all-tagged"]}}],"responses":{"200":{"description":"VPN Service intent.","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-nodes":{"type":"object","properties":{"vpn-node":{"type":"array","description":"Includes a list of VPN nodes. (list)","items":{"type":"object","properties":{"vpn-node-id":{"type":"string","description":"An identifier of the VPN node. (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"active-vpn-instance-profiles":{"type":"object","properties":{"vpn-instance-profile":{"type":"array","description":"Includes a list of active VPN instance\nprofiles. (list)","items":{"type":"object","properties":{"rd":{"type":"string","description":"Indicates an RD value that is explicitly assigned. (leaf)","format":"string","x-yang":{"type":"leaf"}},"profile-id":{"type":"string","description":"Node's active VPN instance profile. (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:srv6":{"type":"object","properties":{"cisco-l3vpn-ntw:address-family":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:locator-name":{"type":"string","description":"SRv6 locator name, should match locators configured at a node-global level on each router (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:name":{"type":"string","description":"Address Family (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Associate SRv6 Policy (presence)","x-yang":{"is_presence":"true","type":"container"}},"address-family":{"type":"array","description":"Set of parameters per address family. (list)","items":{"type":"object","properties":{"vpn-targets":{"type":"object","properties":{"vpn-policies":{"type":"object","properties":{"import-policy":{"type":"string","description":"Identifies the import policy. (leaf)","format":"string","x-yang":{"type":"leaf"}},"export-policy":{"type":"string","description":"Identifies the export policy. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"VPN service policies. 'vpn-policies' contains references\nto the import and export policies to be associated with\nthe VPN service. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"vpn-target":{"type":"array","description":"RTs. AND/OR operations may be defined based on the\nassigned RTs. (list)","items":{"type":"object","properties":{"route-target-type":{"type":"string","description":"Import/export type of the RT. (leaf)","format":"enumeration","default":"import","enum":["import","export","both"],"x-yang":{"type":"leaf"}},"id":{"type":"integer","description":"Identifies each VPN target. (leaf)","format":"byte","x-yang":{"type":"leaf"}},"route-targets":{"type":"array","description":"List of RTs. (list)","items":{"type":"object","properties":{"route-target":{"type":"string","description":"Conveys an RT value. (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}}},"description":"Set of route targets to match for import and export\nroutes to/from VRF. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"address-family":{"type":"string","description":"Indicates the address family (IPv4 and/or IPv6). (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"local-as":{"type":"integer","description":"Provider's Autonomous System (AS) number. Used if the\ncustomer requests BGP routing. (leaf)","format":"uint32","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Container for active VPN instance profiles. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"vpn-network-accesses":{"type":"object","properties":{"vpn-network-access":{"type":"array","description":"List of network accesses. (list)","items":{"type":"object","properties":{"routing-protocols":{"type":"object","properties":{"routing-protocol":{"type":"array","description":"List of routing protocols used on the\nCE-PE link. This list can be augmented. (list)","items":{"type":"object","properties":{"bgp":{"type":"object","properties":{"cisco-l3vpn-ntw:update-source":{"type":"object","properties":{"cisco-l3vpn-ntw:sub-if-id":{"type":"string","description":"Sub Interface Id (leaf)","format":"int32","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:if-id":{"type":"string","description":"Interface Id (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:if-type":{"type":"string","description":"Interface Type (leaf)","format":"enumeration","default":"Bundle-Ether","enum":["Bundle-Ether","Ethernet","FiftyGigE","FortyGigE","FourHundredGigE","GigabitEthernet","HundredGigE","Loopback","TenGigE","TwentyFiveGigE","TwoHundredGigE"],"x-yang":{"type":"leaf"}}},"description":"Source of routing updates (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-l3vpn-ntw:mpls-deactivation":{"type":"string","description":"Set to true to disable BGP MPLS forwarding. (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"multihop":{"type":"integer","description":"Describes the number of IP hops allowed\nbetween a given BGP neighbor and\nthe PE. (leaf)","format":"byte","x-yang":{"type":"leaf"}},"redistribute-connected":{"type":"array","description":"Indicates, per address family, the\npolicy to follow for connected\nroutes. (list)","items":{"type":"object","properties":{"enable":{"type":"string","description":"Enables the redistribution of\nconnected routes. (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:metric":{"type":"integer","description":"Default metric \u003c0..4294967295\u003e (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"address-family":{"type":"string","description":"Indicates the address family. (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"peer-as":{"type":"integer","description":"Indicates the customer's ASN when\nthe customer requests BGP routing. (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"neighbor":{"type":"array","items":{"type":"string","description":"IP address(es) of the BGP neighbor.\nIPv4 and IPv6 neighbors may be\nindicated if two sessions will be used\nfor IPv4 and IPv6. (leaf-list)","format":"union"},"x-yang":{"type":"leaf-list"}},"address-family":{"type":"string","description":"This node contains the address families\nto be activated. 'dual-stack' means\nthat both IPv4 and IPv6 will be\nactivated. (leaf)","format":"identityref","x-yang":{"type":"leaf"}}},"description":"Configuration specific to BGP. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"id":{"type":"string","description":"Unique identifier for the routing\nprotocol. (leaf)","format":"string","x-yang":{"type":"leaf"}},"type":{"type":"string","description":"Type of routing protocol. (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Defines routing protocols. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"service":{"type":"object","properties":{"qos":{"type":"object","properties":{"qos-profile":{"type":"object","properties":{"qos-profile":{"type":"array","description":"QoS profile.\nCan be a standard profile or\na customized profile. (list)","items":{"type":"object","properties":{"profile":{"type":"string","description":"QoS profile to be used. (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"direction":{"type":"string","description":"The direction to which the QoS\nprofile is applied. (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"QoS profile configuration. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"QoS configuration. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"mtu":{"type":"integer","description":"MTU at the service level. If the service\nis IP, it refers to the IP MTU. If\nCarriers' Carriers (CsC) is enabled, the\nrequested MTU will refer to the MPLS\nmaximum labeled packet size and not to the\nIP MTU. (leaf)","format":"uint32","x-yang":{"type":"leaf"}}},"description":"Service parameters of the attachment. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"ip-connection":{"type":"object","properties":{"ipv4":{"type":"object","properties":{"prefix-length":{"type":"integer","description":"Subnet prefix length expressed in bits.\nIt is applied to both local and customer\naddresses. (leaf)","format":"byte","x-yang":{"type":"leaf"}},"local-address":{"type":"string","description":"The IP address used at the provider's\ninterface. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"IPv4-specific parameters. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"ipv6":{"type":"object","properties":{"prefix-length":{"type":"integer","description":"Subnet prefix length expressed in bits.\nIt is applied to both local and customer\naddresses. (leaf)","format":"byte","x-yang":{"type":"leaf"}},"local-address":{"type":"string","description":"IPv6 address of the provider side. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"IPv6-specific parameters. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Defines IP connection parameters. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"connection":{"type":"object","properties":{"encapsulation":{"type":"object","properties":{"type":{"type":"string","description":"Encapsulation type. By default, the type\nof the tagged interface is\n'priority-tagged'. (leaf)","format":"identityref","x-yang":{"type":"leaf"}},"dot1q":{"type":"object","properties":{"cisco-l3vpn-ntw:BDI":{"type":"integer","description":"\u003c1-4095\u003e BDI interface number. BDI must be unique for each sub-interface on the device. (leaf)","format":"uint16","x-yang":{"type":"leaf"}},"cvlan-id":{"type":"integer","description":"VLAN identifier. (leaf)","format":"uint16","x-yang":{"type":"leaf"}}},"description":"Tagged interface. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Container for Layer 2 encapsulation. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"Defines Layer 2 protocols and parameters that\nare required to enable connectivity between\nthe PE and the CE. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"oam":{"type":"object","properties":{},"description":"Defines the Operations, Administration,\nand Maintenance (OAM) mechanisms used.\n\nBFD is set as a fault detection mechanism,\nbut other mechanisms can be defined in the\nfuture. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"id":{"type":"string","description":"Identifier for the network access. (leaf)","format":"string","x-yang":{"type":"leaf"}},"interface-id":{"type":"string","description":"Identifier for the physical or logical\ninterface.\nThe identification of the sub-interface\nis provided at the connection level and/or\nthe IP connection level. (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"List of network accesses. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-l3vpn-ntw:multicast":{"type":"object","properties":{"cisco-l3vpn-ntw:is-receiver-site-only":{"type":"string","description":"Current PE has only receiver sites. (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:static-sr-mpls-p2mp":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:policy-name":{"type":"string","description":"Name of the SR P2MP Policy (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:role":{"type":"string","description":"(leaf)","format":"enumeration","default":"source","enum":["source","receiver"],"x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:enable-inter-as":{"type":"string","description":"Enable Inter-AS on the vpn-node (leaf)","format":"[null]","x-yang":{"type":"leaf"}}},"description":"Multicast parameters for the vpn node. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"local-as":{"type":"integer","description":"Provider's AS number. Used if the customer\nrequests BGP routing. (leaf)","format":"uint32","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Container for VPN nodes. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-l3vpn-ntw:custom-template":{"type":"array","description":"Custom templates to apply when device is ready (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:name":{"type":"string","description":"Name of template to apply (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:variable":{"type":"array","description":"Variables to bind when applying template one time (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:iteration":{"type":"array","description":"Apply custom template multiple times with iteration (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:variable":{"type":"array","description":"Variables to bind when applying template in iteration (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:name":{"type":"string","description":"Name of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:value":{"type":"string","description":"Value of template variable (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:number":{"type":"integer","description":"\u003c1-65535\u003e;;Iteration number (leaf)","format":"uint16","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}},"cisco-l3vpn-ntw:vpn-target":{"type":"object","properties":{"cisco-l3vpn-ntw:auto-hub-rt":{"type":"string","description":"Auto Hub Route-Target (leaf)","format":"[null]","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:auto-spoke-rt":{"type":"string","description":"Auto Spoke Route-Target (leaf)","format":"[null]","x-yang":{"type":"leaf"}}},"description":"VPN Target (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-mvpn:multicast":{"type":"object","properties":{"cisco-mvpn:ipv4":{"type":"object","properties":{"cisco-mvpn:mvpn-ipmsi-tunnel-ipv4":{"type":"object","properties":{"cisco-mvpn:color":{"type":"integer","description":"On-demand color template (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-mvpn:fast-reroute":{"type":"object","properties":{"cisco-mvpn:lfa":{"type":"object","properties":{},"description":"LFA Fast Re-route (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Enable Fast Re-route protection (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-mvpn:tunnel-type":{"type":"string","description":"I-PMSI tunnel type. (leaf)","format":"enumeration","default":"sr-mpls-p2mp","enum":["sr-mpls-p2mp","static-sr-mpls-p2mp"],"x-yang":{"type":"leaf"}}},"description":"Default mdt or I-PMSI configuration and\noperational state information (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-l3vpn-ntw:static-sr-mpls-p2mp":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:sr-p2mp-policy":{"type":"object","properties":{"cisco-l3vpn-ntw:group-address":{"type":"array","description":"IPv4 static multicast group (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:inc-mask":{"type":"object","properties":{"cisco-l3vpn-ntw:count":{"type":"integer","description":"No. of group addresses to join (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:address":{"type":"string","description":"group address to join (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"Increment mask for group or source address (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-l3vpn-ntw:address":{"type":"string","description":"IPv4 static multicast group (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:source-address":{"type":"array","description":"Source address (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:inc-mask":{"type":"object","properties":{"cisco-l3vpn-ntw:count":{"type":"integer","description":"No. of group addresses to join (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:address":{"type":"string","description":"group address to join (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"Increment mask for group or source address (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-l3vpn-ntw:address":{"type":"string","description":"Source address (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}}},"description":"Segment-routing P2MP policy (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-l3vpn-ntw:policy-name":{"type":"string","description":"Name of the SR P2MP Policy (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"cisco-mvpn:mvpn-spmsi-tunnels-ipv4":{"type":"object","properties":{"cisco-mvpn:mvpn-spmsi-tunnel-ipv4":{"type":"array","description":"S-PMSI tunnel attributes configuration and\noperational state information. (list)","items":{"type":"object","properties":{"cisco-mvpn:immediate-switch":{"type":"string","description":"To enable to switch to Data Mdt immediately (leaf)","format":"boolean","x-yang":{"type":"leaf"}},"cisco-mvpn:color":{"type":"integer","description":"On-demand color template (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-mvpn:group-acl-ipv4":{"type":"string","description":"Specify the (s, g) entry on which the\nS-PMSI tunnel takes effect.\nThe value is an integer ranging from 3000\nto 3999 or a string of 32 case-sensitive\ncharacters. If no value is specified, the\nswitch-group address pool takes effect on\nall (s, g). (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-mvpn:fast-reroute":{"type":"object","properties":{"cisco-mvpn:lfa":{"type":"object","properties":{},"description":"LFA Fast Re-route (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Enable Fast Re-route protection (presence)","x-yang":{"is_presence":"true","type":"container"}},"cisco-mvpn:per-item-tunnel-limit":{"type":"integer","description":"Maximum number of S-PMSI tunnels allowed\nper S-PMSI configuration item per mvpn instance. (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-mvpn:tunnel-type":{"type":"string","description":"S-PMSI tunnel type. (leaf)","format":"enumeration","default":"sr-mpls-p2mp","enum":["sr-mpls-p2mp","static-sr-mpls-p2mp"],"x-yang":{"type":"leaf"}},"cisco-mvpn:route-policy":{"type":"string","description":"Route policy to select data mdt core (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-mvpn:switch-threshold":{"type":"integer","description":"Multicast packet rate threshold for\ntriggering the switching from the\nI-PMSI to the S-PMSI. The value is\nan integer ranging from 0 to 4194304, in\nkbps. The default value is 1. (leaf)","format":"uint32","x-yang":{"type":"leaf"}},"cisco-mvpn:switch-wildcard-mode":{"type":"string","description":"I-PMSI switching to S-PMSI mode for private net\nwildcard mode, which including (*,*), (*,G), (S,*),\n(S,G) four modes. (leaf)","format":"enumeration","default":"source-group","enum":["source-group","star-star"],"x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"S-PMSI tunnel configuration and\noperational state information. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}},"description":"(presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Global multicast parameters. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"vpn-service-topology":{"type":"string","description":"VPN service topology. (leaf)","format":"identityref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:service-assurance":{"type":"object","properties":{"cisco-l3vpn-ntw:profile-name":{"type":"string","description":"Please input profile name in following format: '\u003cprofile-name\u003e (custom|system)'\n The possible profile names for system are: Gold_L2VPN_ConfigProfile, Gold_L3VPN_ConfigProfile, Silver_L2VPN_ConfigProfile, Silver_L3VPN_ConfigProfile. (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:monitoring-state":{"type":"string","description":"To enable, disable or pause the service assurance monitoring (leaf)","format":"enumeration","default":"disable","enum":["disable","enable","pause"],"x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:preservation":{"type":"string","description":"Preserve/Remove all assurance related historical data after stop monitoring (leaf)","format":"enumeration","default":"remove","enum":["remove","preserve"],"x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:rule-name":{"type":"string","description":"Please input rule name in following format: '\u003crule-name\u003e (custom|system)'\n The possible rule names for system are: Rule-L2VPN-NM, Rule-L2VPN-NM-Basic, Rule-L2VPN-NM-P2P, Rule-L2VPN-NM-P2P-Basic, Rule-L2VPN-MP, Rule-L2VPN-MP-Basic, Rule-L3VPN-NM, Rule-L3VPN-NM-Basic. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"Service Assurance configuration (presence)","x-yang":{"is_presence":"true","type":"container"}},"vpn-instance-profiles":{"type":"object","properties":{"vpn-instance-profile":{"type":"array","description":"List of VPN instance profiles. (list)","items":{"type":"object","properties":{"rd":{"type":"string","description":"Indicates an RD value that is explicitly assigned. (leaf)","format":"string","x-yang":{"type":"leaf"}},"role":{"type":"string","description":"Role of the VPN node in the VPN. (leaf)","format":"identityref","x-yang":{"type":"leaf"}},"profile-id":{"type":"string","description":"VPN instance profile identifier. (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:srv6":{"type":"object","properties":{"cisco-l3vpn-ntw:address-family":{"type":"array","description":"(list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:locator-name":{"type":"string","description":"SRv6 locator name, should match locators configured at a node-global level on each router (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:name":{"type":"string","description":"Address Family (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Associate SRv6 Policy (presence)","x-yang":{"is_presence":"true","type":"container"}},"address-family":{"type":"array","description":"Set of parameters per address family. (list)","items":{"type":"object","properties":{"vpn-targets":{"type":"object","properties":{"vpn-policies":{"type":"object","properties":{"import-policy":{"type":"string","description":"Identifies the import policy. (leaf)","format":"string","x-yang":{"type":"leaf"}},"export-policy":{"type":"string","description":"Identifies the export policy. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"VPN service policies. 'vpn-policies' contains references\nto the import and export policies to be associated with\nthe VPN service. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"vpn-target":{"type":"array","description":"RTs. AND/OR operations may be defined based on the\nassigned RTs. (list)","items":{"type":"object","properties":{"route-target-type":{"type":"string","description":"Import/export type of the RT. (leaf)","format":"enumeration","default":"import","enum":["import","export","both"],"x-yang":{"type":"leaf"}},"id":{"type":"integer","description":"Identifies each VPN target. (leaf)","format":"byte","x-yang":{"type":"leaf"}},"route-targets":{"type":"array","description":"List of RTs. (list)","items":{"type":"object","properties":{"route-target":{"type":"string","description":"Conveys an RT value. (leaf)","format":"string","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}}},"x-yang":{"type":"list"}}},"description":"Set of route targets to match for import and export\nroutes to/from VRF. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"address-family":{"type":"string","description":"Indicates the address family (IPv4 and/or IPv6). (leaf)","format":"identityref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}},"local-as":{"type":"integer","description":"Provider's Autonomous System (AS) number. Used if the\ncustomer requests BGP routing. (leaf)","format":"uint32","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Container for a list of VPN instance profiles. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"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"}},"instance-type":{"type":"string","description":"Indicates a transport instance type. For example,\nit can be a VPN+, an IETF network slice, a virtual\nnetwork, etc. (leaf)","format":"identityref","x-yang":{"type":"leaf"}},"transport-instance-id":{"type":"string","description":"An optional identifier of the abstract transport\ninstance. (leaf)","format":"string","x-yang":{"type":"leaf"}}},"description":"Container for the underlay transport. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"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"}},"cisco-l3vpn-ntw:probes":{"type":"object","properties":{"cisco-l3vpn-ntw:point-to-point":{"type":"object","properties":{"cisco-l3vpn-ntw:connection":{"type":"array","description":"List of point to point based connections (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:destination":{"type":"string","description":"Destination identifier (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:source":{"type":"string","description":"Source identifier (leaf)","format":"leafref","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Includes point to point based connections (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"cisco-l3vpn-ntw:endpoint":{"type":"array","description":"List of endpoint (list)","items":{"type":"object","properties":{"cisco-l3vpn-ntw:vpn-network-access":{"type":"string","description":"VPN network access (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:interface-id":{"type":"string","description":"VPN network access interface-id (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:agent-ipv6":{"type":"string","description":"Agent's ipv6 address (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:agent-ipv4":{"type":"string","description":"Agent's ipv4 address (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:id":{"type":"string","description":"Endpoint identifier (leaf)","format":"string","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:vpn-node":{"type":"string","description":"A vpn node (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"cisco-l3vpn-ntw:agent-vlan":{"type":"integer","description":"Agent's vlan (leaf)","format":"uint16","x-yang":{"type":"leaf"}}}},"x-yang":{"type":"list"}}},"description":"Probes container (presence)","x-yang":{"is_presence":"true","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_vpn_id_get","method":"get","path":"/data/ietf-l3vpn-ntw:l3vpn-ntw/vpn-services/vpn-service={vpn-service-vpn-id}"}}