https://wiki.openstack.org/w/api.php?action=feedcontributions&feedformat=atom&user=Dongfeng
OpenStack - User contributions [en]
2026-06-30T01:19:19Z
User contributions
MediaWiki 1.28.2
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73692
Neutron/sdnapi
2015-02-15T02:40:53Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
<br />
L3VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances.<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}.<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}.<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}.<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}.<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
<br />
L2VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
L2VPN PW Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
L2VPN PW CX Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId || String || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
L2VPN AC Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<instanceType>2PE</instanceType><br />
<pws><br />
<pw><br />
<pwRole>primary</pwRole><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
<backwardPeerID>2.2.2.2</backwardPeerID><br />
<BackwardInLabel>1024</BackwardInLabel><br />
<BackwardOutLabel>1025</BackwardOutLabel><br />
<FPID>2.2.2.2</FPID><br />
<forwardPeerID>1.1.1.1</forwardPeerID><br />
<forwardInLabel>1025</forwardInLabel><br />
<forwardOutLabel>1024</forwardOutLabel><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances.<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}.<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<instanceType>2PE</instanceType><br />
<instanceOperStatus>up</instanceOperStatus><br />
<pws><br />
<pw><br />
<pwRole>primary</pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
<backwardPeerID>2.2.2.2</backwardPeerID><br />
<BackwardInLabel>1024</BackwardInLabel><br />
<BackwardOutLabel>1025</BackwardOutLabel><br />
<FPID>2.2.2.2</FPID><br />
<forwardPeerID>1.1.1.1</forwardPeerID><br />
<forwardInLabel>1025</forwardInLabel><br />
<forwardOutLabel>1024</forwardOutLabel><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface>Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<netL2vpnInstance>vpninstance1</netL2vpnInstance><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface>Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac.<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}.<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73691
Neutron/sdnapi
2015-02-15T02:37:11Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
<br />
L3VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances.<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}.<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}.<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}.<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}.<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
<br />
L2VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
L2VPN PW Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
L2VPN PW CX Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId || String || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
L2VPN AC Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<instanceType>2PE</instanceType><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
<backwardPeerID>2.2.2.2</backwardPeerID><br />
<BackwardInLabel>1024</BackwardInLabel><br />
<BackwardOutLabel>1025</BackwardOutLabel><br />
<FPID>2.2.2.2</FPID><br />
<forwardPeerID>1.1.1.1</forwardPeerID><br />
<forwardInLabel>1025</forwardInLabel><br />
<forwardOutLabel>1024</forwardOutLabel><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances.<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}.<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<instanceType>2PE</instanceType><br />
<instanceOperStatus>up</instanceOperStatus><br />
<pws><br />
<pw><br />
<pwRole>primary</pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
<backwardPeerID>2.2.2.2</backwardPeerID><br />
<BackwardInLabel>1024</BackwardInLabel><br />
<BackwardOutLabel>1025</BackwardOutLabel><br />
<FPID>2.2.2.2</FPID><br />
<forwardPeerID>1.1.1.1</forwardPeerID><br />
<forwardInLabel>1025</forwardInLabel><br />
<forwardOutLabel>1024</forwardOutLabel><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<netL2vpnInstance>vpninstance1</netL2vpnInstance><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac.<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}.<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73690
Neutron/sdnapi
2015-02-15T02:30:22Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
<br />
L3VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
<br />
L2VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
L2VPN PW Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
L2VPN PW CX Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId || String || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
L2VPN AC Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
< netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
< instanceOperStatus >up</ instanceOperStatus ><br />
<pws><br />
<pw><br />
<pwRole >primary</ pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
< netL2vpnInstance >vpninstance1</ netL2vpnInstance ><br />
</ netL2vpnInstance ><br />
< netL2vpnInstance ><br />
……<br />
</ netL2vpnInstance ><br />
</ netL2vpnInstances ><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73632
Neutron/sdnapi
2015-02-13T09:38:28Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
<br />
L3VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
<br />
L2VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
L2VPN PW Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
L2VPN PW CX Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId String || Example || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
L2VPN AC Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
< netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
< instanceOperStatus >up</ instanceOperStatus ><br />
<pws><br />
<pw><br />
<pwRole >primary</ pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
< netL2vpnInstance >vpninstance1</ netL2vpnInstance ><br />
</ netL2vpnInstance ><br />
< netL2vpnInstance ><br />
……<br />
</ netL2vpnInstance ><br />
</ netL2vpnInstances ><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73631
Neutron/sdnapi
2015-02-13T09:37:19Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
<br />
L3VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
L2VPN Instance Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
L2VPN PW Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
L2VPN PW CX Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId String || Example || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
L2VPN AC Attributes<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
< netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
< instanceOperStatus >up</ instanceOperStatus ><br />
<pws><br />
<pw><br />
<pwRole >primary</ pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
< netL2vpnInstance >vpninstance1</ netL2vpnInstance ><br />
</ netL2vpnInstance ><br />
< netL2vpnInstance ><br />
……<br />
</ netL2vpnInstance ><br />
</ netL2vpnInstances ><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73630
Neutron/sdnapi
2015-02-13T09:34:50Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
<br />
L3VPN Instance Attributes<br />
</gallery><br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId String || Example || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
< netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
< instanceOperStatus >up</ instanceOperStatus ><br />
<pws><br />
<pw><br />
<pwRole >primary</ pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
< netL2vpnInstance >vpninstance1</ netL2vpnInstance ><br />
</ netL2vpnInstance ><br />
< netL2vpnInstance ><br />
……<br />
</ netL2vpnInstance ><br />
</ netL2vpnInstances ><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73629
Neutron/sdnapi
2015-02-13T09:28:46Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<pre><nowiki><br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
</nowiki></pre><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId String || Example || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
< netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
< instanceOperStatus >up</ instanceOperStatus ><br />
<pws><br />
<pw><br />
<pwRole >primary</ pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
< netL2vpnInstance >vpninstance1</ netL2vpnInstance ><br />
</ netL2vpnInstance ><br />
< netL2vpnInstance ><br />
……<br />
</ netL2vpnInstance ><br />
</ netL2vpnInstances ><br />
</nowiki></pre><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<pre><nowiki><br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
</nowiki></pre><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
* Response<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<pre><nowiki><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</nowiki></pre></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73628
Neutron/sdnapi
2015-02-13T09:17:47Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
* Response<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
* Response<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
==L2VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L2VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L2VPN model contains multiple VPN Instances.<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || Stringe || Yes || CRD || N/A || Maxlength = 32 Pattern = ([^?]*) || L2VPN instance name<br />
|-<br />
| instanceOperStatus || String enum || No || R || N/A || Up or down || Instance Operation Status<br />
|-<br />
| instanceType || String enum || No || CRU || 2PE || 2PE or 3PE || Instance type<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| pwRole || String enum || Yes || CR || primary || primary or backup or bypas || Pw role <br />
|-<br />
| pwOperStatus || Unsigned byte || No || R || N/A || Up or down || Pw Operation Status<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || String || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| ForwardPeerID || String || No || CRD || N/A || Length = 0~255 || Forward peer<br />
|-<br />
| ForwardInLabel || String || No || CRD || N/A || 17~2^20 || Forward in label<br />
|-<br />
| ForwardOutLabel || String || No || CRD || N/A || 17~2^20 || Forward out labe<br />
|-<br />
| backwardPeerID || String || No || CRD || N/A || Length = 0~255 || Backward peer<br />
|-<br />
| BackwardInLabel || String || No || CRD || N/A || 17~2^20 || Backward in label<br />
|-<br />
| BackwardOutLabel || String || No || CRD || N/A || 17~2^20 || Backward out label<br />
|-<br />
| TunnelId String || Example || No || CRUD || N/A || Length = 0~32 || Tunnel of the PW<br />
|}<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| FPID || Stringe || Yes || CRD || N/A || Length = 0~255 || Forward Point ID<br />
|-<br />
| Interface || String || Yes || CRD || N/A || Length = 0~32 || Interface access the l2vpn<br />
|}<br />
<br />
==L2VPN API example==<br />
===Restful API===<br />
====L2VPN Instance====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2VPNinstances<br />
<br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
<pws><br />
<pw><br />
< pwRole >primary</ pwRole ><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netL2vpn/vpws/nstL2vpnInstances /{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netL2VPN/L2VPNinstances<br />
<br />
<netL2vpnInstances><br />
< netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
</netL2vpnInstance><br />
<netL2vpnInstance><br />
……<br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
<br />
* Response<br />
<br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
< instanceType >2PE</ instanceType ><br />
< instanceOperStatus >up</ instanceOperStatus ><br />
<pws><br />
<pw><br />
<pwRole >primary</ pwRole><br />
<pwOperStatus>up</pwOperStatus><br />
<cxs><br />
<cx><br />
<FPID>1.1.1.1</FPID><br />
< backwardPeerID >2.2.2.2</ backwardPeerID ><br />
< BackwardInLabel >1024</ BackwardInLabel ><br />
< BackwardOutLabel >1025</ BackwardOutLabel ><br />
<FPID>2.2.2.2</FPID><br />
< forwardPeerID >1.1.1.1</ forwardPeerID ><br />
< forwardInLabel >1025</ forwardInLabel ><br />
< forwardOutLabel >1024</ forwardOutLabel ><br />
</cx><br />
</cxs><br />
</pw><br />
</pws><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
</acs><br />
</L2VPNinstance><br />
<L2VPNinstance><br />
……<br />
</L2VPNinstance><br />
</L2VPNinstances><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netL2vpn/vpws/netL2vpnInstances/<br />
<br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
< netL2vpnInstance >vpninstance1</ netL2vpnInstance ><br />
</ netL2vpnInstance ><br />
< netL2vpnInstance ><br />
……<br />
</ netL2vpnInstance ><br />
</ netL2vpnInstances ><br />
<br />
====AC====<br />
=====POST=====<br />
POST URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
<br />
<netL2vpnInstances><br />
<netL2vpnInstance><br />
<instancename>vpninstance1</instancename><br />
<acs><br />
<ac><br />
<FPID>1.1.1.1</FPID><br />
<Interface> Ethernet0/0/1</Interface><br />
</ac><br />
<ac><br />
……<br />
</ac><br />
</acs><br />
</netL2vpnInstance><br />
</netL2vpnInstances><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netL2VPN/vpws/netL2vpnInstances/{instancename}/acs/ac<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
* Response<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====PUT=====<br />
PUT URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netL2VPN/L2VPNinstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73627
Neutron/sdnapi
2015-02-13T08:55:59Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String enum || No || CRUD || full-mesh || full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| remoteAsNumber || String || No || CRUD || N/A || Length = 1 ~ 11 || Valid only when protocol is BGP<br />
|-<br />
| remotePeerAddr || String || No || CRUD || N/A || Length = 0~255 || Valid only when protocol is BGP<br />
|}<br />
==L3VPN API example==<br />
===Restful API===<br />
====L3VPN Instance====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
=====GET=====<br />
* To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
* To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
* Response<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
=====DELETE=====<br />
* To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
* To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
====Access Interface====<br />
=====POST=====<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====GET=====<br />
* To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
* Response<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====PUT=====<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
=====DELETE=====<br />
* To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
* To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73626
Neutron/sdnapi
2015-02-13T08:41:13Z
<p>Dongfeng: </p>
<hr />
<div>==L3VPN Information Model==<br />
===Overview===<br />
====UML Model====<br />
<gallery><br />
Example.jpg|High Level L3VPN Architecture<br />
</gallery><br />
====Elements Description====<br />
The L3 VPN model contains multiple VPN Instances.<br />
===L3VPN Instance===<br />
====UML Model====]<br />
<gallery><br />
Example.jpg| L3VPN Instance Model<br />
</gallery><br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Type !! Required !! CRUD !! Default Value !! Constraints !! Note<br />
|-<br />
| instanceName || String || Yes || CRD || N/A || Maxlength = 64 Pattern = ([^?]*) || L3VPN instance name<br />
|-<br />
| serviceType || String || enum || No || CRUD || full-mesh full-mesh or hub-spoke || Topology type<br />
|-<br />
| afType || String enum || No || CRUD || ipv4uni || ipv4uni or ipv6uni || Address family type: IPv4 or IPv6<br />
|-<br />
| acIf Id || String || Yes || CRD || N/A || Length= 1~63 || Access interface ID<br />
|-<br />
| acIfAddr || String || No || CRUD || N/A || Length = 0~255 || Access interface address, IPv4 or IPv6<br />
|-<br />
| acIfMask || Unsigned byte || No || CRUD || N/A || 0 ~ 128 || IP address mask length<br />
|-<br />
| role || String enum || No || CRUD || edge-if || edge-if or center-if || center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
|-<br />
| userName || String || No || CRUD ||N/A || Maxlength = 64 Pattern = ([^?]*) || User name for this access interface<br />
|-<br />
| userPassword || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || User password for the access interface<br />
|-<br />
| phyNodeId || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || Physical node ID<br />
|-<br />
| phyAcIf || String || No || CRUD || N/A || Maxlength = 64 Pattern = ([^?]*) || hysical access interface<br />
|-<br />
| protocolType || String enum || No || CRUD || ospf || bgp, ospf, or isis || Protocol type<br />
|-<br />
protocolId Unsigned int No CRUD 0 N/A Valid only when protocol is IGP; it can be AS number<br />
remoteAsNumber String No CRUD N/A Length = 1 ~ 11 Valid only when protocol is BGP<br />
remotePeerAddr String No CRUD N/A Length = 0~255 Valid only when protocol is BGP<br />
<br />
| protocolId ||Unsigned int || No || CRUD || 0 || N/A || Valid only when protocol is IGP; it can be AS number<br />
|-<br />
| Example || Example || Example || Example || Example || Example || Example<br />
|-<br />
| Example || Example || Example || Example || Example || Example || Example<br />
|-<br />
| Example || Example || Example || Example || Example || Example || Example<br />
|}</div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73625
Neutron/sdnapi
2015-02-13T07:50:56Z
<p>Dongfeng: </p>
<hr />
<div>==1. L3VPN Information Model== <br />
===1.1 Overview===<br />
<gallery><br />
Ex<br />
<gallery><br />
Example.jpg|picture1<br />
Example.jpg|Caption2<br />
</gallery><br />
ample.jpg|Caption1<br />
Example.jpg|Caption2<br />
</gallery><br />
====1.1.1 UML Model====<br />
<br />
Figure 1 High Level L3VPN Architecture<br />
===1.1.2 Elements Description===<br />
The L3 VPN model contains multiple VPN Instances.<br />
===3.2 L3VPN Instance===<br />
====3.2.1 UML Model====<br />
<br />
Figure 2 L3VPN Instance Model<br />
3.2.2 Element Description<br />
Attribute Type Required CRUD Default Value Constraints Note<br />
instanceName String Yes CRD N/A Maxlength = 64<br />
Pattern = ([^?]*) L3VPN instance name<br />
serviceType String enum No CRUD full-mesh full-mesh or hub-spoke Topology type<br />
afType String enum No CRUD ipv4uni ipv4uni or ipv6uni Address family type: IPv4 or IPv6<br />
acIf Id String Yes CRD N/A Length= 1~63 Access interface ID<br />
acIfAddr String No CRUD N/A Length = 0~255 Access interface address, IPv4 or IPv6<br />
acIfMask Unsigned byte No CRUD N/A 0 ~ 128 IP address mask length<br />
role String enum No CRUD edge-if edge-if or center-if center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
userName String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) User name for this access interface<br />
userPassword String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) User password for the access interface<br />
phyNodeId String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) Physical node ID<br />
phyAcIf String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) Physical access interface<br />
<gallery><br />
<gallery><br />
Example.jpg|Caption1<br />
Example.jpg|Caption2<br />
</gallery><br />
</gallery><br />
protocolType String enum No CRUD ospf bgp, ospf, or isis Protocol type<br />
protocolId Unsigned int No CRUD 0 N/A Valid only when protocol is IGP; it can be AS number<br />
remoteAsNumber String No CRUD N/A Length = 1 ~ 11 Valid only when protocol is BGP<br />
remotePeerAddr String No CRUD N/A Length = 0~255 Valid only when protocol is BGP<br />
Table 1 L3VPN Instance Attributes<br />
<br />
4 L3VPN API example<br />
4.1 Restful API<br />
4.1.1 L3VPN Instance<br />
4.1.1.1 POST<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.2 GET<br />
To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
Response<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.3 PUT<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.4 DELETE<br />
To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
4.1.2 Access Interface<br />
4.1.2.1 POST<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
<br />
4.1.2.2 GET<br />
To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
Response<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
4.1.2.3 PUT<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
<br />
4.1.2.4 DELETE<br />
To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73624
Neutron/sdnapi
2015-02-13T07:44:02Z
<p>Dongfeng: </p>
<hr />
<div>==1. L3VPN Information Model== <br />
1.1 Overview<br />
1.1.1 UML Model<br />
<br />
Figure 1 High Level L3VPN Architecture<br />
1.1.2 Elements Description<br />
The L3 VPN model contains multiple VPN Instances.<br />
3.2 L3VPN Instance<br />
3.2.1 UML Model<br />
<br />
Figure 2 L3VPN Instance Model<br />
3.2.2 Element Description<br />
Attribute Type Required CRUD Default Value Constraints Note<br />
instanceName String Yes CRD N/A Maxlength = 64<br />
Pattern = ([^?]*) L3VPN instance name<br />
serviceType String enum No CRUD full-mesh full-mesh or hub-spoke Topology type<br />
afType String enum No CRUD ipv4uni ipv4uni or ipv6uni Address family type: IPv4 or IPv6<br />
acIf Id String Yes CRD N/A Length= 1~63 Access interface ID<br />
acIfAddr String No CRUD N/A Length = 0~255 Access interface address, IPv4 or IPv6<br />
acIfMask Unsigned byte No CRUD N/A 0 ~ 128 IP address mask length<br />
role String enum No CRUD edge-if edge-if or center-if center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
userName String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) User name for this access interface<br />
userPassword String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) User password for the access interface<br />
phyNodeId String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) Physical node ID<br />
phyAcIf String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) Physical access interface<br />
protocolType String enum No CRUD ospf bgp, ospf, or isis Protocol type<br />
protocolId Unsigned int No CRUD 0 N/A Valid only when protocol is IGP; it can be AS number<br />
remoteAsNumber String No CRUD N/A Length = 1 ~ 11 Valid only when protocol is BGP<br />
remotePeerAddr String No CRUD N/A Length = 0~255 Valid only when protocol is BGP<br />
Table 1 L3VPN Instance Attributes<br />
<br />
4 L3VPN API example<br />
4.1 Restful API<br />
4.1.1 L3VPN Instance<br />
4.1.1.1 POST<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.2 GET<br />
To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
Response<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.3 PUT<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.4 DELETE<br />
To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
4.1.2 Access Interface<br />
4.1.2.1 POST<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
<br />
4.1.2.2 GET<br />
To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
Response<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
4.1.2.3 PUT<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
<br />
4.1.2.4 DELETE<br />
To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs></div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron/sdnapi&diff=73623
Neutron/sdnapi
2015-02-13T07:36:42Z
<p>Dongfeng: </p>
<hr />
<div>This page is for SDN APIs between OpenStack and SDN Controller.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
Disclaimer<br />
THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR ANY PARTICULAR PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. <br />
Without limitation, ONF disclaims all liability, including liability for infringement of any proprietary rights, relating to use of information in this specification and to the implementation of this specification, and ONF disclaims all liability for cost of procurement of substitute goods or services, lost profits, loss of use, loss of data or any incidental, consequential, direct, indirect, or special damages, whether under contract, tort, warranty or otherwise, arising in any way out of use or reliance upon this specification or any information herein. <br />
No license, express or implied, by estoppel or otherwise, to any Open Networking Foundation or Open Networking Foundation member intellectual property rights is granted herein. <br />
Except that a license is hereby granted by ONF to copy and reproduce this specification for internal use only. <br />
Contact the Open Networking Foundation at https://www.opennetworking.org for information on specification licensing through membership agreements. <br />
Any marks and brands contained herein are the property of their respective owners.<br />
<br />
1 INTRODUCTION 5<br />
2 ABBREVIATIONS AND ACRONYMS 5<br />
3 L3VPN OVERVIEW 5<br />
3.1 UML MODEL 5<br />
3.2 ELEMENTS DESCRIPTION 6<br />
4 L3VPN INSTANCE 6<br />
4.1 UML MODEL 6<br />
4.2 ELEMENT DESCRIPTION 6<br />
5 BACK MATTER 7<br />
5.1 REFERENCES 7<br />
5.2 RELEASE HISTORY 8<br />
5.3 CONTRIBUTORS 8<br />
<br />
List of Figures<br />
Figure 1 High Level L3VPN Architecture 5<br />
Figure 2 L3VPN Instance Model 6<br />
<br />
List of Tables<br />
Table 1 L3VPN Instance Attributes 7<br />
<br />
<br />
About this document<br />
<br />
Summary<br />
This document describes NBI information model for L3VPN.<br />
A L3VPN instance contains a set of access interfaces in network devices, its topology, address family, and other attributes.<br />
Keywords<br />
NBI, SDN controller, L3VPN<br />
<br />
1 Introduction<br />
This document describes NBI information model for L3VPN.<br />
A L3VPN model is the collection of L3VPN instances.<br />
A L3VPN instance contains a set of access interfaces in network devices, its topology, address family, and other attributes.<br />
<br />
2 Abbreviations and Acronyms<br />
This document uses the following abbreviations and acronyms:<br />
API Applications Programming Interface<br />
NBI North Bound Interface<br />
CRUD Create, Read, Update, Delete<br />
L3VPN Layer 3 VPN<br />
VACIF Virtual Access Interface<br />
VPN Virtual Private Network<br />
<br />
3 L3VPN Information Model<br />
3.1 Overview<br />
3.1.1 UML Model<br />
<br />
Figure 1 High Level L3VPN Architecture<br />
3.1.2 Elements Description<br />
The L3 VPN model contains multiple VPN Instances.<br />
3.2 L3VPN Instance<br />
3.2.1 UML Model<br />
<br />
Figure 2 L3VPN Instance Model<br />
3.2.2 Element Description<br />
Attribute Type Required CRUD Default Value Constraints Note<br />
instanceName String Yes CRD N/A Maxlength = 64<br />
Pattern = ([^?]*) L3VPN instance name<br />
serviceType String enum No CRUD full-mesh full-mesh or hub-spoke Topology type<br />
afType String enum No CRUD ipv4uni ipv4uni or ipv6uni Address family type: IPv4 or IPv6<br />
acIf Id String Yes CRD N/A Length= 1~63 Access interface ID<br />
acIfAddr String No CRUD N/A Length = 0~255 Access interface address, IPv4 or IPv6<br />
acIfMask Unsigned byte No CRUD N/A 0 ~ 128 IP address mask length<br />
role String enum No CRUD edge-if edge-if or center-if center-if is only available in hub-spoke mode; center-if is the interface in hub node<br />
userName String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) User name for this access interface<br />
userPassword String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) User password for the access interface<br />
phyNodeId String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) Physical node ID<br />
phyAcIf String No CRUD N/A Maxlength = 64<br />
Pattern = ([^?]*) Physical access interface<br />
protocolType String enum No CRUD ospf bgp, ospf, or isis Protocol type<br />
protocolId Unsigned int No CRUD 0 N/A Valid only when protocol is IGP; it can be AS number<br />
remoteAsNumber String No CRUD N/A Length = 1 ~ 11 Valid only when protocol is BGP<br />
remotePeerAddr String No CRUD N/A Length = 0~255 Valid only when protocol is BGP<br />
Table 1 L3VPN Instance Attributes<br />
<br />
4 L3VPN API example<br />
4.1 Restful API<br />
4.1.1 L3VPN Instance<br />
4.1.1.1 POST<br />
POST URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.2 GET<br />
To get all instances<br />
GET URI/netl3vpn/l3vpninstances<br />
No HTTP message body.<br />
<br />
To get a single VPN instance<br />
GET URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
To get one or more VPN instances at a time<br />
GET URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
Response<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.3 PUT<br />
PUT URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
<servicetype>full-mesh</servicetype><br />
<aftype>ipv4uni</aftype><br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
<br />
4.1.1.4 DELETE<br />
To delete a single VPN instance <br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}<br />
No HTTP message body.<br />
<br />
To delete one or more instances<br />
DELETE URI/netl3vpn/l3vpninstances<br />
<br />
<l3vpninstances><br />
<l3vpninstance><br />
<instancename>vpninstance1</instancename><br />
</l3vpninstance><br />
<l3vpninstance><br />
……<br />
</l3vpninstance><br />
</l3vpninstances><br />
4.1.2 Access Interface<br />
4.1.2.1 POST<br />
POST URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
<br />
4.1.2.2 GET<br />
To get a single access interface<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
To get one or more access interfaces<br />
GET URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
Response<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
4.1.2.3 PUT<br />
PUT URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
<acifaddr>20.1.1.1</acifaddr><br />
<acifmask>24</acifmask><br />
<role>edge-if</role><br />
<username>user1</username><br />
<userpassword>userpass</userpassword><br />
<phynodeid>Node1</phynodeid><br />
<phyacif>Node1:Ethernet0/0/1</phyacif><br />
<protocol><br />
<protocoltype>ospf</protocoltype><br />
<igpattr><br />
<protocolid>1000</protocolid><br />
</igpattr><br />
</protocol><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
<br />
<br />
4.1.2.4 DELETE<br />
To delete a single access interface<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs/{acifid}<br />
No HTTP message body.<br />
<br />
To delete one or more access interfaces<br />
DELETE URI/netl3vpn/l3vpninstances/{instancename}/acifs<br />
<acifs><br />
<acif><br />
<acifid>vpninstance1:port1</acifid><br />
</acif><br />
<acif><br />
……<br />
</acif><br />
</acifs><br />
5 Back matter<br />
5.1 References<br />
<br />
5.2 Release history<br />
<br />
5.3 Contributors<br />
Xiaofeng Ji<br />
Zhaozeyu<br />
James Huang<br />
Felix Lu</div>
Dongfeng
https://wiki.openstack.org/w/index.php?title=Neutron&diff=52409
Neutron
2014-05-15T19:00:20Z
<p>Dongfeng: </p>
<hr />
<div><br />
= OpenStack Networking ("Neutron") =<br />
<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
| [http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html Administrator Guide ]<br />
|-<br />
| [http://docs.openstack.org/user-guide/content/neutron_client_sample_commands.html Neutron CLI Guide ]<br />
|-<br />
| [http://docs.openstack.org/api/openstack-network/2.0/content/ API Developer Doc (v2) ]<br />
|-<br />
| [https://github.com/openstack/quantum Source code ]<br />
|-<br />
| [https://bugs.launchpad.net/quantum Bug tracker ]<br />
|-<br />
| [https://blueprints.launchpad.net/quantum Blueprints ]<br />
|}<br />
<br />
== Related projects ==<br />
* [https://launchpad.net/python-quantumclient Python Neutron client]<br />
* Neutron Admin and API documentation in [https://launchpad.net/openstack-manuals OpenStack Manuals]<br />
* Tempest testing project [http://docs.openstack.org/developer/tempest/ Tempest Manuals]. For the Icehouse cycle, the community is undertaking a focused effort to strengthen the suite of Tempest tests for Neutron. If you are interested on contributing to this effort, please go to [https://etherpad.openstack.org/p/icehouse-summit-qa-neutron Icehouse Neutron Tempest push] to see what is being done and to [https://wiki.openstack.org/wiki/Neutron/TempestAPITests TempestAPITests] for HOWTO instructions. Helping to develop Tempest tests (particularly API tests) is an excellent way for new contributors to learn Neutron.<br />
<br />
== What is Neutron? ==<br />
<br />
Neutron is an [https://wiki.openstack.org OpenStack] project to provide "networking as a service" between interface devices (e.g., vNICs) managed by other Openstack services (e.g., nova). <br />
<br />
Starting in the Folsom release, Neutron is a core and supported part of the [https://wiki.openstack.org OpenStack] platform (for Essex, we were an "incubated" project, which means use is suggested only for those who really know what they're doing with Neutron). <br />
<br />
If you're a networking geek and like to hack on [https://wiki.openstack.org OpenStack], please join! <br />
<br />
More Info: <br />
* [http://www.slideshare.net/danwent/openstack-quantum-intro-os-meetup-32612 Overview of Neutron] (slides) (3/12)<br />
* [https://www.youtube.com/watch?v=_I1SrO2QBpg Neutron Project Overview + Update from Grizzly Summit] (video) (10/12) <br />
* [http://www.infoq.com/presentations/Quantum-Virtual-Networks-for-OpenStack Video Neutron Overview] (3/12)<br />
* [http://sdrv.ms/YdnQYS Slides on Technical Architecture of Neutron] (2013-03-14)<br />
<br />
== Why Neutron? ==<br />
<br />
* Give cloud tenants an API to build rich networking topologies, and configure advanced network policies in the cloud. <br />
** Example: create multi-tier web application topology<br />
* Enable innovation plugins (open and closed source) that introduce advanced network capabilities<br />
** Example: use L2-in-L3 tunneling to avoid VLAN limits, provide end-to-end QoS guarantees, used monitoring protocols like [[NetFlow]]. <br />
* Let anyone build advanced network services (open and closed source) that plug into Openstack tenant networks. <br />
** Examples: LB-aaS, VPN-aaS, firewall-aaS, IDS-aaS, data-center-interconnect-aaS.<br />
* Horizon GUI support for: <br />
** Neutron L2 and L3 network and subnet creation/deletion<br />
** Booting VMs on specific Neutron networks. <br />
* API Extensibility Framework, including extensions for: <br />
** "provider network", which maps Neutron L2 networks to a specific VLAN in the physical data center<br />
<br />
== Using Neutron ==<br />
<br />
Follow the instructions in the [http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html Neutron Administrator Guide], or use the installation documentation at http://docs.openstack.org to use Neutron with OpenStack Nova. <br />
<br />
Forget documentation, I just want to get the code!: [https://launchpad.net/quantum/+download Neutron Downloads]<br />
<br />
Detailed information for programming against v2.0 of the Neutron web services API is available in the [http://docs.openstack.org/api/openstack-network/2.0/content/ Neutron API Guide] <br />
<br />
If you are looking for information on using Neutron with devstack, please see: [[NeutronDevstack]] . <br />
<br />
Neutron lets you use a set of different backends called "plugins" that work with a growing variety of networking technologies. These plugins may be distributed as part of the main Neutron release, or separately. <br />
<br />
The set of plugins included in the main Neutron distribution and supported by the Neutron community include: <br />
<br />
* [http://www.openvswitch.org Open vSwitch] Plugin<br />
* [http://wiki.openstack.org/cisco-quantum Cisco UCS/Nexus] Plugin<br />
* [http://wiki.openstack.org/Quantum-Linux-Bridge-Plugin Linux Bridge] Plugin<br />
* [http://wiki.openstack.org/Neutron/ML2 Modular Layer 2] Plugin<br />
* [http://www.nicira.com Nicira Network Virtualization Platform (NVP)] Plugin<br />
* [http://www.osrg.net/ryu/using_with_openstack.html Ryu OpenFlow Controller] Plugin<br />
* [[Neutron/NEC OpenFlow Plugin|NEC OpenFlow]] Plugin <br />
* [http://docs.projectfloodlight.org/display/floodlightcontroller/Quantum+REST+Proxy+Plugin Big Switch Controller Plugin]<br />
* [http://www.cloudbase.it/quantum-hyper-v-plugin/ Cloudbase Hyper-V] Plugin<br />
* [http://www.midokura.com MidoNet] Plugin<br />
* [https://github.com/brocade/brocade Brocade Neutron Plugin] Brocade Neutron Plugin<br />
* [http://www.plumgrid.com/ PLUMgrid] Plugin<br />
* [https://wiki.openstack.org/wiki/Mellanox-Neutron Mellanox Neutron Plugin] Mellanox Neutron Plugin<br />
* [https://wiki.openstack.org/wiki/Neutron/EmbraneNeutronPlugin Embrane Neutron Plugin]<br />
* [https://wiki.openstack.org/wiki/IBM-Neutron IBM SDN-VE] Plugin<br />
<br />
<br />
Additional plugins are available from other sources: <br />
* [http://www.opencontrail.org OpenContrail] Plugin<br />
* [http://www.extremenetworks.com Extreme Networks] Plugin<br />
* [https://github.com/ruijie/rgos_quantum_plugin Ruijie Networks] Plugin<br />
* [https://www.juniper.net/support/downloads/?p=qpluginopen#sw Juniper Networks] Neutron Plugin<br />
If you have your own plugin, feel free to add it to this list.<br />
<br />
== Havana Release and ML2 Plugin Update ==<br />
Starting with Havana release, openvswitch and linuxbridge plugins are deprecated. Modular Layer 2 (ML2) plugin replaces these plugins. <br />
L2 agents work with ML2 plugin and continue to work with the deprecated monolithic plugins. <br />
<br />
ML2 plugin architecture facilitates the type drivers to support multiple networking technologies, and mechanism drivers to facilitate the access to the networking configuration in a transactional model. The details of these drivers is described [https://wiki.openstack.org/wiki/Neutron/ML2#ML2_Drivers here]. Long term goal is to transition all vendor specific plugins to the type and mechanism drivers. <br />
<br />
Following [https://wiki.openstack.org/wiki/Neutron/ML2#Type_Drivers Type Drivers] are supported: <br />
* Flat<br />
* Local<br />
* VLAN<br />
* GRE<br />
* VxLan<br />
<br />
<br />
Following Vendor specific [https://wiki.openstack.org/wiki/Neutron/ML2#Mechanism_Drivers Mechanism Drivers] are supported: <br />
* [https://wiki.openstack.org/wiki/Arista-neutron-ml2-driver Arista Driver]<br />
* [https://wiki.openstack.org/wiki/Neutron/ML2/MechCiscoNexus Cisco Nexus Driver]<br />
* [https://wiki.openstack.org/wiki/Neutron/ML2/Tail-f-NCS-neutron-ml2-driver Tail-f NCS Driver]<br />
<br />
== Participate ==<br />
<br />
To get code, ask questions, view blueprints, etc, see: [https://launchpad.net/quantum/ Neutron Launchpad Page]<br />
<br />
See [[NeutronDevelopment]] for some (rough) guides on how to contribute code to Neutron, including how to add your own plugin. <br />
<br />
If you would like to participate, please send mail to the main openstack-dev list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev<br />
<br />
You can also attend our regular IRC meetings, which start one hour after the main openstack meeting, on the same #openstack-meeting channel: http://wiki.openstack.org/Network/Meetings<br />
<br />
Check out [[NeutronStarterBugs]] for ideas on easy bugs or starter projects you might tackle. Or just start playing with [[NeutronDevstack]] and come up with your own ideas!<br />
<br />
== Related pages ==<br />
=== Neutron/* ===<br />
{{Special:PrefixIndex/Neutron}}<br />
<br />
=== Network/* ===<br />
{{Special:PrefixIndex/Network}}</div>
Dongfeng