GRE Service Orders Management RESTful Web Services
The following operations can be performed using the Connectivity Services Director GRE Service Orders Management RESTful Web Services.
Get All GRE Service Orders
This request is used to retrieve all the configured GRE service orders.
URI | api/space/nsas/gre/service-management/service-orders |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Collects all the configured GRE service orders. |
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource size="3"> <ServiceOrder href="/api/space/gre/service-management/service-orders/4161536" uri="/api/space/gre/service-management/service-orders/4161536" key="4161536"> <Common> <Name>GRE_tes02_6</Name> <Identity>4161536</Identity> <State>Invalid</State> <CreatedDate>2012-07-18T17:52:32.000+05:30</CreatedDate> <LastUpdatedDate>2012-07-18T17:52:32.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>GRE</ServiceType> <Action>Provisioning</Action> <Reference> <ServiceDefinition> <ServiceDefinitionID key="1179660" href="/api/space/gre/service-management/service-definitions/1179660" uri="/api/space/gre/service-management/service-definitions/1179660" /> </ServiceDefinition> </Reference> </ServiceOrder> <ServiceOrder href="/api/space/gre/service-management/service-orders/3866624" uri="/api/space/gre/service-management/service-orders/3866624" key="3866624"> <Common> <Name>fdsgdfg_audit_2012-07-17 15:43:28.54</Name> <Identity>3866624</Identity> <State>Completed</State> <Comments>Audit fdsgdfg2012-07-17 15:43:28.54</Comments> <CreatedDate>2012-07-17T15:43:28.000+05:30</CreatedDate> <LastUpdatedDate>2012-07-17T15:43:28.000+05:30</LastUpdatedDate> <CreatedBy>super</CreatedBy> </Common> <ServiceType>GRE</ServiceType> <Action>Provisioning</Action> <Reference> <ServiceDefinition> <ServiceDefinitionID key="1179648" href="/api/space/gre/service-management/service-definitions/1179648" uri="/api/space/gre/service-management/service-definitions/1179648" /> </ServiceDefinition> <Service key="1179679" href="/api/space/gre/service-management/services/1179679" uri="/api/space/gre/service-management/services/1179679" /> </Reference> </ServiceOrder> </ServiceResource> </Data>
Get a Hub-and-Spoke GRE Service Order By Order ID
This request is used to retrieve the details of a particular hub-and-spoke GRE service order based on the service order ID.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific hub-and-spoke GRE service order. |
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="services.schema.networkapi.jmp.juniper.net REST_Data_Model.xsd ">
<ServiceResource>
<ServiceOrder>
<Common>
<Name>GRE_Hub_and_Spoke_Service_Order</Name>
<Identity>7372822</Identity>
<State>Completed</State>
<CreatedDate>2013-01-10T13:08:43.000+05:30</CreatedDate>
<LastUpdatedDate>2013-01-0T13:08:42.000+05:30</LastUpdatedDate>
<Comments>GRE_Hub_and_Spoke_Service_Order</Comments>
</Common>
<ServiceType>GRE</ServiceType>
<Action>Provisioning</Action>
<GRETunnelSettings>
<GRETunnelSetting>
<Hub>
<DeviceId>13403</DeviceId>
<DeviceName>junos-m10-2-space</DeviceName>
<Interface>gr-1/0/0.6</Interface>
</Hub>
<Spoke>
<DeviceId>12303</DeviceId>
<DeviceName>embassy</DeviceName>
<Interface>gr-0/0/10.1</Interface>
</Spoke>
</GRETunnelSetting>
<GRETunnelSetting>
<Hub>
<DeviceId>11503</DeviceId>
<DeviceName>junos-m10-1-space</DeviceName>
<Interface>gr-1/0/0.4</Interface>
</Hub>
<Spoke>
<DeviceId>13603</DeviceId>
<Router>junos-m10-2-space</Router>
<Interface>gr-1/0/0.7</Interface>
</Spoke>
</GRETunnelSetting>
</GRETunnelSettings>
<Reference>
<ServiceDefinition>
<ServiceDefinitionID key="7372802" href="/api/space/nsas/gre/service-management/service-definitions/7372802"
uri="/api/space/nsas/gre/service-management/service-definitions/7372802" />
</ServiceDefinition>
</Reference>
</ServiceOrder>
</ServiceResource>
</Data>
Get a Full-Mesh GRE Service Order By Order ID
This request is used to retrieve the details of a particular full-mesh GRE service order based on the service order ID.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. application/vnd.net.juniper.space.service-management. |
Produces | Collects the details of a specific full-mesh GRE service order. |
Output
Sample XML Output
<Data xmlns="services.schema.networkapi.jmp.juniper.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="services.schema.networkapi.jmp.juniper.net REST_Data_Model.xsd ">
<ServiceResource>
<ServiceOrder
href="/api/space/nsas/gre/service-management/service-orders/7372820"
uri="/api/space/nsas/gre/service-management/service-orders/7372820"
key="7372820">
<Common>
<Name>GRE_FullMesh_Service_Order</Name>
<Identity>7372820</Identity>
<Comments>GRE_FullMesh_Service_Order </Comments>
<State>Completed</State>
<Comments> GRE_FullMesh_Service_Order </Comments>
<CreatedDate>2013-01-10T13:08:43.000+05:30</CreatedDate>
<LastUpdatedDate>2013-01-0T13:08:42.000+05:30</LastUpdatedDate>
</Common>
<ServiceType>GRE</ServiceType>
<Action>Provisioning</Action>
<GRETunnelSettings>
<GRETunnelSetting>
<SourceRouter>
<DeviceId>13503</DeviceId>
<DeviceName>embassy</DeviceName>
<Interface>gr-1/0/10.6</Interface>
</ SourceRouter>
<DestinationRouter>
<DeviceId>13505</DeviceId>
<DeviceName>junos-m10-1-space</DeviceName>
<Interface>gr-1/2/0.1</Interface>
</DestinationRouter>
</GRETunnelSetting>
<GRETunnelSetting>
<SourceRouter>
<DeviceId>13507</DeviceId>
<DeviceName>embassy</DeviceName>
<Interface>gr-0/0/10.1</Interface>
</SourceRouter>
<DestinationRouter>
<DeviceId>13513</DeviceId>
<DeviceName> junos-m10-2-space</DeviceName>
<Interface>gr-1/0/0.4</Interface>
</DestinationRouter>
</GRETunnelSetting>
</GRETunnelSettings>
<Reference>
<ServiceDefinition>
<ServiceDefinitionID key="7372800"
href="/api/space/nsas/gre/service-management/service-definitions/7372800"
uri="/api/space/nsas/gre/service-management/service-definitions/7372800"/> </ServiceDefinition>
</Reference>
</ServiceOrder>
</ServiceResource>
</Data>
Create a Hub-and-Spoke GRE Service Order
This request is used to create a point-to-point GRE service order.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Creates a point-to-multipoint GRE service order. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>GRE_HS_002</Name> <Comments>GRE_HS_002</Comments> </Common> <ServiceType>GRE</ServiceType> <StaticRoute>Disabled</StaticRoute> <ServiceEndPointGroup> <Hub> <DeviceName>embassy</DeviceName> <DeviceId>65616</DeviceId> <Interface>gr-1/0/10</Interface> </Hub> <Spoke> <DeviceName>kochin</DeviceName> <DeviceId>65673</DeviceId> <Interface>gr-0/0/10</Interface> </Spoke> </ServiceEndPointGroup> <Reference> <ServiceDefinition> <ServiceDefinitionID key="32771"/> </ServiceDefinition> <Service key="131081"/> </Reference> </ServiceOrder> </ServiceResource> </Data>
Create a Full-Mesh GRE Service Order
This request is used to create a multipoint-to-multipoint GRE service order.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service- |
Consumes | application/vnd.net.juniper.space.service-management. For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:
|
Produces | Creates a GRE service order. |
Input
Sample XML Input
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <ServiceResource> <ServiceOrder> <Common> <Name>GRE_FULLMESH_001</Name> <Comments>GRE_FULLMESH_001</Comments> </Common> <ServiceEndPointGroup> <SourceRouter> <DeviceName>embassy</DeviceName> <DeviceId>131849</DeviceId> <Interface>gr-1/0/10</Interface> </SourceRouter> <DestinationRouter> <DeviceName>kochin</DeviceName> <DeviceId>131074</DeviceId> <Interface>gr-0/0/10</Interface> </DestinationRouter> </ServiceEndPointGroup> <ServiceEndPointGroup> <SourceRouter> <DeviceName>kochin</DeviceName> <DeviceId>131074</DeviceId> <Interface>gr-0/0/10</Interface> </SourceRouter> <DestinationRouter> <DeviceName>embassy</DeviceName> <DeviceId>131849</DeviceId> <Interface>gr-1/0/10</Interface> </DestinationRouter> </ServiceEndPointGroup> <Reference> <ServiceDefinition> <ServiceDefinitionID key="32768"/> </ServiceDefinition> </Reference> </ServiceOrder> </ServiceResource> </Data>
Deploy, Validate, and Partially-Delete a GRE Service Order
This request is used to deploy, validate, or partially delete a previously created GRE service order.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | POST |
Content-Type | application/vnd.net.juniper.space.service-management. |
Consumes | application/vnd.net.juniper.space.service-management. The options must be specified in the Action Element inside OperationSpecificData. The various options are as follows:
|
Produces | Deploys, validates or, partially-deletes a previously created GRE service order. |
Input
Sample XML Input
<Data xmlns="services.schema.networkapi.jmp.juniper.net" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="services.schema.networkapi.jmp.juniper.net REST_Data_Model.xsd"> <CustomAction xsi:type="ServiceOrderCustomActionType"> <Action>ValidateNow</Action> <ScheduledDateTime>2012-04-09T19:07:18.000+05:30</ScheduledDateTime> </CustomAction> </Data>
Delete a GRE Service Order
This request is used to delete a previously configured GRE service order.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | DELETE |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Deletes a GRE service order. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Identity> <Type>ServiceOrder</Type> <Value>294923</Value> </Identity> <Code>200</Code> <Message>Service order Deleted Successfully.</Message> </Status> </Data>
View the Pending Configuration of a GRE Service Order
This request is used to view the details of a GRE service order that are pending to be applied to a device.
URI | api/space/nsas/gre/service-management/service-orders/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.service-management. |
Produces | Displays the configuration details of a service order pending to be applied to a device. |
Output
Sample XML Output
<Data>
<PendingOrderConfiguration>
<PendingOrderConfigDeviceEnd>
<DeviceName>kochin</DeviceName>
<Configuration>
<configuration
xmlns:a="http://transportactivate.jmp.juniper.net/gre/shared"
xmlns:b="http://jmp.juniper.net/gre/shared">
<interfaces>
<interface>
<name>gr-0/1/10</name>
<unit>
<name>1</name>
<tunnel>
<source>50.1.2.1</source>
<destination>40.1.255.4</destination>
</tunnel>
<family>
<inet/>
<mpls/>
</family>
</unit>
</interface>
</interfaces>
<routing-options>
<rib>
<name>inet.3</name>
<static>
<route>
<name>40.1.255.4/32</name>
<next-hop>gr-0/1/10.1</next-hop>
</route>
</static>
</rib>
</routing-options>
</configuration>
</Configuration>
</PendingOrderConfigDeviceEnd>
<PendingOrderConfigDeviceEnd>
<DeviceName>vjx-junos-m10-2-space</DeviceName>
<Configuration>
<configuration
xmlns:a="http://transportactivate.jmp.juniper.net/gre/shared"
xmlns:b="http://jmp.juniper.net/gre/shared">
<interfaces>
<interface>
<name>gr-0/0/0</name>
<unit>
<name>2</name>
<tunnel>
<source>40.1.255.4</source>
<destination>50.1.2.1</destination>
</tunnel>
<family>
<inet/>
<mpls/>
</family>
</unit>
</interface>
</interfaces>
<routing-options>
<rib>
<name>inet.3</name>
<static>
<route>
<name>50.1.2.1/32</name>
<next-hop>gr-0/0/0.2</next-hop>
</route>
</static>
</rib>
</routing-options>
</configuration>
</Configuration>
</PendingOrderConfigDeviceEnd>
<PendingOrderConfigDeviceEnd>
<DeviceName>embassy</DeviceName>
<Configuration>
<configuration
xmlns:a="http://transportactivate.jmp.juniper.net/gre/shared"
xmlns:b="http://jmp.juniper.net/gre/shared">
<interfaces>
<interface>
<name>gr-1/0/10</name>
</interface>
</interfaces>
<routing-options>
<rib>
<name>inet.3</name>
<static/>
</rib>
</routing-options>
</configuration>
</Configuration>
</PendingOrderConfigDeviceEnd>
</PendingOrderConfiguration>
</Data>