E-Line BGP Service Definitions Management RESTful Web Services
The following operations can be performed using the Connectivity Services Director E-Line BGP Service Orders Management RESTful Web Services.
Get All E-Line BGP Service Definitions with Pagination, Search, and Filter
This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) BGP service definitions with pagination, and to filter the results based on the search criteria.
URI | /api/space/nsas/eline-ptp/service-management/ /api/space/nsas/eline-ptp/service-management/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects all the configured E-Line BGP service definitions with pagination applied, and with a filtered result-set that matches the search criteria |
For service orders, you can sort with “sortedby=CreatedDate” and “sortedby=State”.
For Start and Limit attributes, you can provide integer values based on your requirement to sort and filter the API output. Sortorder can be “asc” and “desc”. The SortedBy attribute differs based on the APIs. For service orders, the SortedBy option can be “CtreatedDate”, “State”. For services, the SortedBy option can be “Name”, “LastModifiedDate”. The FilteredBy attribute differs based on the APIs. For service orders, the FilteredBy option can be “Name” and “State”. For services, the FilteredBy option can be “Name”.
If you enter “paging=(starteq 2, limit eq 3)”, which is not a single integer value, the display is according to index of records. In this case, it shows from the first indexed record to the third indexed record. If you enter "start=2&limit=3", it starts from the second record and displays the next three records in all.
You can specify multiple key:value pairs with the FilteredBy attribute. For example, to get service orders, you can use Get ServiceOrders with Name and State as “filteredby=Name::L3VPN@@State::Invalid”. Similarly, to get service orders, you can use with Name OR state “filteredby=Name::L3VPN!! State::Invalid”.
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Data> <ServiceResource size="3"> <ServiceDefinition key="458777" uri="/api/space/nsas/eline-ptp/service-management/service-definitions/458777" href="/api/space/nsas/eline-ptp/service-management/service-definitions/458777"> <Common> <Name>ELine-BGP-Dot1q-SingleVLAN</Name> <Identity>458777</Identity> <State>Published</State> <Comments> Used to transport a single VLAN in a point-to-point service between two remote sites. </Comments> <CreatedDate>2014-11-21T18:35:15.000+05:30</CreatedDate> <LastUpdatedDate>2014-11-21T18:35:15.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> </ServiceDefinition> <ServiceDefinition key="458801" uri="/api/space/nsas/eline-ptp/service-management/service-definitions/458801" href="/api/space/nsas/eline-ptp/service-management/service-definitions/458801"> <Common> <Name>ELine-BGP-PortBased</Name> <Identity>458801</Identity> <State>Published</State> <Comments> Used to deliver a point-to-point service between two remote sites, using dedicated ports. </Comments> <CreatedDate>2014-11-21T18:35:15.000+05:30</CreatedDate> <LastUpdatedDate>2014-11-21T18:35:15.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> </ServiceDefinition> <ServiceDefinition key="458752" uri="/api/space/nsas/eline-ptp/service-management/service-definitions/458752" href="/api/space/nsas/eline-ptp/service-management/service-definitions/458752"> <Common> <Name>ELine-BGP-QinQ-AllVLAN</Name> <Identity>458752</Identity> <State>Published</State> <Comments> Used to deliver a point-to-point service between two remote sites, with high BW requirements. </Comments> <CreatedDate>2014-11-21T18:35:15.000+05:30</CreatedDate> <LastUpdatedDate>2014-11-21T18:35:15.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> </ServiceDefinition> </ServiceResource> </Data>
Get All E-Line Service Definitions by Filter Criterion
This request is used to retrieve all the configured E-Line service definitions that match the specified filter criterion. You can filter and retrieve service definitions based on the name, service type, signaling type, and state.
URI | /api/space/nsas/eline-ptp/service-management/service- /api/space/nsas/eline-ptp/service-management/service- /api/space/nsas/eline-ptp/service-management/service- /api/space/nsas/eline-ptp/service-management/service- |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects all the configured E-Line service definitions that match a filter criterion |
For E-Line, IP, and E-LAN service definitions, the FilteredBy option can be Name, ServiceType, Signaling, and State.
Output
Sample XML Output
Get All Published E-Line Service Definitions
This request is used to retrieve all the published E-Line service definitions.
URI | All service types: /api/space/nsas/service-management/ /api/space/nsas/eline-ptp/service-management/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Content Type | application/vnd.net.juniper.space.service-management |
Produces | Collects all the published E-Line service definitions. |
GET an E-Line BGP Service Definition with Instance Type as evpn-vpws
This request is used to retrieve all the E-Line service definitions with instance type as evpn-vpws.
URL | /api/space/nsas/csd/service-definition/<definitionId> |
HTTP Method | GET |
Sample URL | http://192.0.2.10:8080/api/space/nsas/csd/service-definition/2134456 |
Accept | application/xml; |
Content Type | application/xml; |
Input
Not Applicable
Output
Sample
XML Output
"<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes""?> <Data xmlns=""services.schema.networkapi.jmp.juniper.net""> <ServiceResource> <ServiceDefinition key=""557056"" uri=""/api/space/nsas/eline-ptp/service-management/service-definitions/557056"" href=""/api/space/nsas/eline-ptp/service-management/service-definitions/557056""> <Common> <Name>eline-vpws-test</Name> <Identity>557056</Identity> <State>Published</State> <CreatedDate>2018-06-19T20:24:07.000+05:30</CreatedDate> <LastUpdatedDate>2018-06-19T20:24:07.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InstanceType>evpn-vpws</InstanceType> <InterfaceType>Ethernet</InterfaceType> <QosEnabled>false</QosEnabled> <PWResiliency>false</PWResiliency> <DecoupleStatus>false</DecoupleStatus> <ServiceElementConfigurationDefinition xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""PTPServiceEndpointGroupParameterDefType""> <MTU max=""9192"" min=""1522"" editable=""true"" default=""1522"" /> <RD editable=""true"" selection=""Auto pick"" /> <RT editable=""true"" selection=""Auto pick"" /> <VlanNormalization>Normalize to Dot1q tag</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""PTPEndPointParameterDefType""> <EthernetOption>dot1q</EthernetOption> <VlanIdSelection editable=""true"" selection=""Auto pick"" /> <TrafficType>Transport single vlan</TrafficType> <VlanIdAuto max=""4094"" min=""1"" default=""1"" /> <VlanIdManual max=""4094"" min=""1"" default=""1"" /> <PhysicalEncapsulation>flexible-ethernet-services</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU max=""9192"" min=""1522"" editable=""true"" default=""1522"" /> <EnableRateLimiting>Not enabled</EnableRateLimiting> <CalculateBurstSizeType>MTU Based</CalculateBurstSizeType> <MTUFactor editable=""true"">10</MTUFactor> </ServiceEndPointConfigurationDefinition> <UseCount>1</UseCount> <UsedBy /> <IsStandard>false</IsStandard> <IsNorthStarLSPSD>false</IsNorthStarLSPSD> </ServiceDefinition> </ServiceResource> </Data>" "
Create an E-Line BGP Service Definition with Ethernet Option as Asymmetric Tag Depth
This request is used to create an E-Line BGP service definition configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option.
URI | api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management.service-definition-status+xml;version=2 |
Produces | Creates an E-Line BGP service definition configured with flexible VLAN tagging (asymmetric tag depth) as the Ethernet option |
Input
Sample XML Input
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>P2P_BGP_Asymmetric_SD_API</Name> <Comments>werewrtety</Comments> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <PWResiliency>false</PWResiliency> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU editable="false" default="1522"/> <RD editable="false" selection="Auto pick"/> <RT editable="false" selection="Auto pick"/> <VlanNormalization>Normalize to Dot1q tag</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>asymmetric tag depth</EthernetOption> <VlanIdSelection editable="false" selection="Auto pick"/> <TrafficType>Transport all traffic</TrafficType> <VlanIdAuto max="0" min="0" default="0"/> <VlanIdManual max="0" min="0" default="0"/> <PhysicalEncapsulation>flexible-ethernet-services</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU editable="false" default="1522"/> <EnableRateLimiting>Enabled</EnableRateLimiting> <DefaultBandwidth unit="Mbps" max="100" min="1" editable="false" default="1">10</DefaultBandwidth> <MinBandwidth unit="Kbps" max="100000" min="64">0</MinBandwidth> <MaxBandwidth unit="Mbps" max="100000" min="1">0</MaxBandwidth> <Increment unit="Kbps" max="100000" min="64" default="64">0</Increment> <CalculateBurstSizeType>MTU Based</CalculateBurstSizeType> <MTUFactor editable="false">10</MTUFactor> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceDefinition</Type> <Value>393618</Value> </Identity> <Code>200</Code> <Message>ServiceDefinition Created Successfully</Message> </Status> </Data>
Create an E-Line BGP Service Definition with Manual Route Distinguisher and Route Target
This request is used to create an E-Line BGP service definition configured with manual route distinguisher and route target attributes.
URI | /api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates an E-Line BGP service definition configured with manual route distinguisher and route target attributes. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>BGP_Ether1</Name> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU default="1522" editable="false" /> <RD selection="Select manually" editable="true" /> <RT selection="Select manually" editable="true" /> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>dot1q</EthernetOption> <VlanIdSelection selection="Auto pick" editable="false" /> <TrafficType>Transport single vlan</TrafficType> <VlanIdAuto default="0" min="0" max="0" /> <VlanIdManual default="0" min="0" max="0" /> <PhysicalEncapsulation>vlan-ccc</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU default="1522" editable="false" /> <EnableRateLimiting>Not enabled</EnableRateLimiting> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceDefinition</Type> <Value>7012365</Value> </Identity> <Code>200</Code> <Message>ServiceDefinition created successfully</Message> </Status> </Data>
Create an E-Line BGP Service Definition with Ethernet Interfaces
This request is used to create an E-Line BGP service definition configured with Ethernet interfaces.
URI | /api/space/nsas/eline-ptp/service-management/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates an E-Line BGP service definition configured with interfaces that contain Ethernet encapsulation. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>BGP_Ether1</Name> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU default="1522" editable="false" /> <RD selection="Select manually" editable="true" /> <RT selection="Select manually" editable="true" /> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>dot1q</EthernetOption> <VlanIdSelection selection="Auto pick" editable="false" /> <TrafficType>Transport single vlan</TrafficType> <VlanIdAuto default="0" min="0" max="0" /> <VlanIdManual default="0" min="0" max="0" /> <PhysicalEncapsulation>vlan-ccc</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU default="1522" editable="false" /> <EnableRateLimiting>Not enabled</EnableRateLimiting> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceDefinition</Type> <Value>3964928</Value> </Identity> <Code>200</Code> <Message>ServiceDefinition Created Successfully</Message> </Status> </Data>
Create an E-Line BGP Service Definition with ATM Interfaces
This request is used to create an E-Line BGP service definition configured with ATM interfaces.
URI | api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates an E-Line BGP service definition configured with ATM interfaces. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>BGP_ATM1</Name> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>ATM</InterfaceType> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPATMServiceEndpointGroupParameterDefType"> <MTU default="1522" editable="false" /> <RD selection="Select manually" editable="true" /> <RT selection="Select manually" editable="true" /> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPATMEndPointParameterDefType"> <PhysicalEncapsulation>atm-ccc-cell-relay</PhysicalEncapsulation> <VPISelection selection="Select manually" editable="false" /> <VCISelection selection="Select manually" editable="false" /> <CellBundleSize editable="false" min="1" max="176">1 </CellBundleSize> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Create an E-Line BGP Service Definition with TDM Interfaces
This request is used to create an E-Line BGP service definition configured with TDM interfaces.
URI | api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates an E-Line BGP service definition configured with TDM interfaces. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>BGP_TDM1</Name> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>TDM</InterfaceType> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPTDMServiceEndpointGroupParameterDefType"> <MTU default="1522" editable="false" /> <RD selection="Select manually" editable="true" /> <RT selection="Select manually" editable="true" /> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPTDMEndPointParameterDefType"> <PhysicalEncapsulation>satop</PhysicalEncapsulation> <JitterBuffer editable="false">5</JitterBuffer> <IdlePattern editable="false" min="0" max="255">255 </IdlePattern> <ExcessPacketLossRate editable="false" min="0" max="100">20</ExcessPacketLossRate> <PayloadSize editable="false">192</PayloadSize> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Create an E-Line Service Definition
This request is used to create an E-Line service definition.
URI | api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates an E-Line service definition. |
Input
Sample XML Input
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition > <Common> <Name>P2P_BGP_BurstSizeCal_lnRtBased_QinQ_API</Name> <Comments>rtyrty</Comments> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <PWResiliency>false</PWResiliency> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU editable="false" default="1522"/> <RD editable="false" selection="Auto pick"/> <RT editable="false" selection="Auto pick"/> <VlanNormalization>Normalize to QinQ tags</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>qinq</EthernetOption> <VlanIdSelection editable="false" selection="Auto pick"/> <TrafficType>Transport single vlan</TrafficType> <VlanIdAuto max="0" min="0" default="0"/> <VlanIdManual max="0" min="0" default="0"/> <PhysicalEncapsulation>vlan-ccc</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU editable="false" default="1522"/> <OuterTagProtocolId editable="false">0x88a8</OuterTagProtocolId> <InnerTagProtocolId editable="false">0x8100</InnerTagProtocolId> <CalculateBurstSizeType>Line Rate Based</CalculateBurstSizeType> <BurstPeriod editable="false">54</BurstPeriod> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceDefinition</Type> <Value>393583</Value> </Identity> <Code>200</Code> <Message>ServiceDefinition Created Successfully</Message> </Status> </Data>
Create an E-Line BGP Service Definition with Instance Type as evpn-vpws
This request is used to create an E-Line BGP service definition configured with evpn-vpws as the instance type.
URL | /api/space/nsas/csd/service-definition |
HTTP Method | POST |
Sample URL | http://192.0.2.10:8080/api/space/nsas/csd/service-definition |
Accept Header | application/xml |
Content Type | application/xml; |
Input
Sample
XML Input
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>eline-vpws-test</Name> <Comments></Comments> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <InstanceType>evpn-vpws</InstanceType> <UseCount>0</UseCount> <PWResiliency>false</PWResiliency> <DecoupleStatus>false</DecoupleStatus> <QosEnabled>false</QosEnabled> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <RT selection="Auto pick" editable="true" /> <RD selection="Auto pick" editable="true" /> <MTU default="1522" editable="true" min="1522" max="9192">1522</MTU> <MTU_max>9192</MTU_max> <RevertTime>5</RevertTime> <SwitchOverDelay>0</SwitchOverDelay> <VlanNormalization>Normalize to Dot1q tag</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>dot1q</EthernetOption> <TrafficType>Transport single vlan</TrafficType> <VlanIdSelection selection="Auto pick" editable="true" /> <VlanIdAuto min="1" max="4094" default="1" /> <VlanIdAuto_max>4094</VlanIdAuto_max> <VlanIdManual min="1" max="4094" default="1" /> <VlanIdManual_max>4094</VlanIdManual_max> <OuterTagProtocolId_editable>false</OuterTagProtocolId_editable> <PhysicalEncapsulation>flexible-ethernet-services</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU default="1522" editable="true" min="1522" max="9192">1522</MTU> <MTU_max>9192</MTU_max> <EnableRateLimiting>Not enabled</EnableRateLimiting> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>"
Output
Sample
XML Output
"<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes""?> <Data xmlns=""services.schema.networkapi.jmp.juniper.net""> <Status> <Identity> <Type>ServiceDefinition</Type> <Value>557056</Value> </Identity> <Code>200</Code> <Message>ServiceDefinition Created and Published Successfully</Message> </Status> </Data>"
Get an E-Line BGP Service Definition with Manual Route Distinguisher and Route Target By Definition ID
This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) BGP service definition based on the service definition ID.
URI | api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific E-Line BGP service definition with manually-configured route distinguisher and route target parameters. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition href="/api/space/nsas/eline-ptp/service-management/service-definitions/1703977" uri="/api/space/nsas/elineptp/ service-management/service-definitions/1703977" key="1703977"> <Common> <Name>PTPBGPRTRDManual</Name> <Identity>1703977</Identity> <State>Published</State> <CreatedDate>2012-12-16T20:42:08.000+05:30</CreatedDate> <LastUpdatedDate>2012-12-16T20:42:08.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <EnableL3Access>false</EnableL3Access> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU default="1522" editable="false" min="1522" max="9192"/> <RD selection="Select manually" editable="true"/> <RT selection="Select manually" editable="true"/> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>dot1q</EthernetOption> <VlanIdSelection selection="Auto pick" editable="false"/> <TrafficType>Transport single vlan</TrafficType> <VlanIdAuto default="0" min="0" max="0"/> <VlanIdManual default="0" min="0" max="0"/> <PhysicalEncapsulation>vlan-ccc</PhysicalEncapsulation> <LogicalEncapsulation>vlan-ccc</LogicalEncapsulation> <MTU default="1522" editable="false" min="1522" max="9192"/> <EnableRateLimiting>Not enabled</EnableRateLimiting> <DefaultBandwidth default="1" editable="false" min="1" max="100" unit="Mbps">N/A</DefaultBandwidth> <MinBandwidth min="64" max="100000" unit="Kbps">0</MinBandwidth> <MaxBandwidth min="1" max="100000" unit="Mbps">0</MaxBandwidth> <Increment default="64" min="64" max="100000" unit="Kbps">0</Increment> <OuterTagProtocolId editable="false"/> <InnerTagProtocolId editable="false"/> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Get E-Line Service Definition Details with Normalization Support By Definition ID
This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) E-Line service definition configured with normalization of VLANs, based on the service definition ID.
URI | api/space/nsas/eline-ptp/service-management/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific E-Line service definition configured with normalization of VLANs. |
Output (VLAN Normalization: Normalize to dot1Q tags)
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition key="884876" uri="/api/space/nsas/eline-ptp/service-management/service-definitions/884876" href="/api/space/nsas/eline-ptp/service-management/service-definitions/884876"> <Common> <Name>P2P_BGP_BurstSizeCal_SD_Via_API</Name> <Identity>884876</Identity> <State>Unpublished</State> <Comments>ertert</Comments> <CreatedDate>2014-07-22T14:09:23.000+05:30</CreatedDate> <LastUpdatedDate>2014-07-22T14:09:23.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <EnableL3Access>false</EnableL3Access> <PWResiliency>false</PWResiliency> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU max="" min="" editable="false" default="1522"/> <RD editable="false" selection="Auto pick"/> <RT editable="false" selection="Auto pick"/> <VlanNormalization> Normalize to Dot1q tag</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>port-port</EthernetOption> <VlanIdSelection editable="false"/> <TrafficType>N/A</TrafficType> <VlanIdAuto max="0" min="0" default="0"/> <VlanIdManual max="0" min="0" default="0"/> <PhysicalEncapsulation>ethernet-ccc</PhysicalEncapsulation> <LogicalEncapsulation/> <MTU max="0" min="0" editable="false" default="1522"/> <EnableRateLimiting>Not enabled</EnableRateLimiting> <DefaultBandwidth unit="Mbps" max="100" min="1" editable="false" default="1">N/A</DefaultBandwidth> <MinBandwidth unit="Kbps" max="100000" min="64">0</MinBandwidth> <MaxBandwidth unit="Mbps" max="100000" min="1">0</MaxBandwidth> <Increment unit="Kbps" max="100000" min="64" default="64">0</Increment> <CalculateBurstSizeType>MTU Based</CalculateBurstSizeType> <MTUFactor editable="true">56</MTUFactor> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Get an E-Line BGP Service Definition with Default Service Template By Definition ID
This request is used to retrieve the details of a particular Layer 2 Ethernet Private Line (EPL, also called E-Line) E-Line BGP service definition with default service template, based on the service definition ID.
URI | api/space/nsas/eline-ptp/service-management/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific E-Line BGP service definition with default service template. |
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition key="458825" uri="/api/space/nsas/eline-ptp/service-management/service-definitions/458825" href="/api/space/nsas/eline-ptp/service-management/service-definitions/458825"> <Common> <Name>Test_BGP_eth_API</Name> <Identity>458825</Identity> <State>Unpublished</State> <CreatedDate>2015-02-12T19:02:17.000+05:30</CreatedDate> <LastUpdatedDate>2015-02-12T19:02:17.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <StaticpseudoWire>false</StaticpseudoWire> <EnableL3Access>false</EnableL3Access> <MultiSegmentPseudowire>false</MultiSegmentPseudowire> <PWResiliency>false</PWResiliency> <DecoupleStatus>true</DecoupleStatus> <ServiceTemplates> <ServiceTemplate href="/api/space/nsas/eline-ptp/service-management/service-templates/66311" uri="/api/space/nsas/eline-ptp/service-management/service-templates/66311" key="/api/space/nsas/eline-ptp/service-management/service-templates/66311"> <ID>66311</ID> <Name>ST with _Descp_P2P</Name> <Default>true</Default> </ServiceTemplate> <ServiceTemplate href="/api/space/nsas/eline-ptp/service-management/service-templates/66317" uri="/api/space/nsas/eline-ptp/service-management/service-templates/66317" key="/api/space/nsas/eline-ptp/service-management/service-templates/66317"> <ID>66317</ID> <Name>protocoll2circuit</Name> <Default>false</Default> </ServiceTemplate> <ServiceTemplate href="/api/space/nsas/eline-ptp/service-management/service-templates/66341" uri="/api/space/nsas/eline-ptp/service-management/service-templates/66341" key="/api/space/nsas/eline-ptp/service-management/service-templates/66341"> <ID>66341</ID> <Name>Flexi_Temp</Name> <Default>false</Default> </ServiceTemplate> </ServiceTemplates> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU max="" min="" editable="false" default="1522"/> <RD editable="false" selection="Auto pick"/> <RT editable="false" selection="Auto pick"/> <VlanNormalization>Normalize to Dot1q tag</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>port-port</EthernetOption> <VlanIdSelection editable="false"/> <TrafficType>N/A</TrafficType> <VlanIdAuto max="0" min="0" default="0"/> <VlanIdManual max="0" min="0" default="0"/> <PhysicalEncapsulation>ethernet-ccc</PhysicalEncapsulation> <LogicalEncapsulation/> <MTU max="0" min="0" editable="false" default="1522"/> <EnableRateLimiting>Not enabled</EnableRateLimiting> <DefaultBandwidth unit="Mbps" max="100" min="1" editable="false" default="1">N/A</DefaultBandwidth> <MinBandwidth unit="Kbps" max="100000" min="64">0</MinBandwidth> <MaxBandwidth unit="Mbps" max="100000" min="1">0</MaxBandwidth> <Increment unit="Kbps" max="100000" min="64" default="64">0</Increment> <CalculateBurstSizeType>MTU Based</CalculateBurstSizeType> <MTUFactor editable="false">10</MTUFactor> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Create an E-Line BGP Service Definition with Default Service Template
This request is used to create an E-Line BGP TDM service definition configured with default service template.
URI | api/space/nsas/eline-ptp/service-management/service-definitions/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates an E-Line BGP service definition configured with default service template. |
The XPath tag in a service template attribute is optional and we recommend that you use this tag.
Input
Sample XML Input
<xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceDefinition> <Common> <Name>Test_BGP_eth_API</Name> </Common> <ServiceType>Point-to-Point Pseudowire(BGP)</ServiceType> <InterfaceType>Ethernet</InterfaceType> <PWResiliency>false</PWResiliency> <DecoupleStatus>true</DecoupleStatus> <ServiceTemplates> <ServiceTemplate> <ID>66311</ID> <Name>ST with _Descp_P2P</Name> <Default>true</Default> </ServiceTemplate> <ServiceTemplate> <ID>66317</ID> <Name>protocoll2circuit</Name> <Default>false</Default> </ServiceTemplate> <ServiceTemplate> <ID>66341</ID> <Name>Flexi_Temp</Name> <Default>false</Default> </ServiceTemplate> </ServiceTemplates> <ServiceElementConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPServiceEndpointGroupParameterDefType"> <MTU editable="false" default="1522"/> <RD editable="false" selection="Auto pick"/> <RT editable="false" selection="Auto pick"/> <VlanNormalization>Normalize to Dot1q tag</VlanNormalization> </ServiceElementConfigurationDefinition> <ServiceEndPointConfigurationDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPEndPointParameterDefType"> <EthernetOption>port-port</EthernetOption> <PhysicalEncapsulation>ethernet-ccc</PhysicalEncapsulation> <MTU editable="false" default="1522"/> <CalculateBurstSizeType>MTU Based</CalculateBurstSizeType> <MTUFactor editable="false">10</MTUFactor> </ServiceEndPointConfigurationDefinition> </ServiceDefinition> </ServiceResource> </Data>
Sample XML Input (With XPath)
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>Test_BGPSO_1DefTemp_API</Name> </Common> <ServiceType>Point-to-Point Pseudowire</ServiceType> <Signaling>BGP</Signaling> <Action>Provisioning</Action> <ServiceEndPointGroup> <DeviceInfo> <NA> <DeviceName>junos-space1</DeviceName> <DeviceID>524393</DeviceID> </NA> </DeviceInfo> <ServiceEndPoint> <InterfaceName>ge-0/1/7</InterfaceName> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPElineBGPEndPointConfigParameterOrderType"> <EndPointCategory>PTP</EndPointCategory> <UNIDescription>N/A</UNIDescription> </ServiceEndpointConfiguration> <ServiceTemplates> <ServiceTemplate> <ID>66317</ID> <ConfigParams> <Name>Name</Name> <Value>testname</Value> <Decommission>false</Decommission> <SvcSpecificValue>false</SvcSpecificValue> <ConfigPageName>cp1</ConfigPageName> </ConfigParams> </ServiceTemplate> <ServiceTemplate> <ID>6357015</ID> <ConfigParams> <Name>Description</Name> <Value>DemoDescription</Value> <Xpath>/configuration/cp1/interface/description</Xpath> <Decommission>false</Decommission> <SvcSpecificValue>false</SvcSpecificValue> <ConfigPageName>cp1</ConfigPageName> </ConfigParams> </ServiceTemplate> </ServiceTemplates> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceEndPointGroup> <DeviceInfo> <NA> <DeviceName>junos-space2</DeviceName> <DeviceID>524357</DeviceID> </NA> </DeviceInfo> <ServiceEndPoint> <InterfaceName>ge-0/1/6</InterfaceName> <ServiceEndpointConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPElineBGPEndPointConfigParameterOrderType"> <EndPointCategory>PTP</EndPointCategory> <UNIDescription>N/A</UNIDescription> </ServiceEndpointConfiguration> <ServiceTemplates> <ServiceTemplate> <ID>66317</ID> <ConfigParams> <Name>Name</Name> <Value>testname</Value> <Decommission>false</Decommission> <SvcSpecificValue>false</SvcSpecificValue> <ConfigPageName>cp1</ConfigPageName> </ConfigParams> </ServiceTemplate> <ServiceTemplate> <ID>6357015</ID> <ConfigParams> <Name>Description</Name> <Value>DemoDescription</Value> <Xpath>/configuration/cp1/interface/description</Xpath> <Decommission>false</Decommission> <SvcSpecificValue>false</SvcSpecificValue> <ConfigPageName>cp1</ConfigPageName> </ConfigParams> </ServiceTemplate> </ServiceTemplates> </ServiceEndPoint> </ServiceEndPointGroup> <ServiceOrderParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="PTPConfigParameterOrderType"> <VlanTagToStack>1</VlanTagToStack> </ServiceOrderParameter> <Reference> <Customer key="524288"/> <ServiceDefinition> <ServiceDefinitionID key="458825"/> </ServiceDefinition> </Reference> </ServiceOrder> </ServiceResource> </Data>
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceDefinition</Type> <Value>458825</Value> </Identity> <Code>200</Code> <Message>ServiceDefinition Created Successfully</Message> </Status> </Data>