Transport Activate Device Management RESTful Web Services
The following operations can be performed using the Connectivity Services Director Transport Activate (TA) Devices Management RESTful Web Services.
Get All TA Devices
This request is used to collect all the TA devices.
URI | api/space/nsas/prestage-ta-device/manage-devices/devices |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.ta-devices+xml |
Produces | Retrieves all the TA devices that are managed and provisioned by the application. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Devices size="3"> <Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/65596" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/65596" key="65596"> <Common> <Name>embassy</Name> <Identity>65596</Identity> </Common> </Device> <Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/65570" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/65570" key="65570"> <Common> <Name>jaipur</Name> <Identity>65570</Identity> </Common> </Device> <Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/65538" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/65538" key="65538"> <Common> <Name>kochin</Name> <Identity>65538</Identity> </Common> </Device> </Devices> </Data>
Get TA Devices By Device ID
This request is used to retrieve a TA device based on the device ID.
URI | api/space/nsas/prestage-ta-device/manage-devices/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.ta-devices+xml |
Produces | Retrieves the TA device based on the device ID. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Devices> <Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/65570" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/65570" key="65570"> <Common> <Name>jaipur</Name> <Identity>65570</Identity> </Common> <IPAddress>10.216.114.112</IPAddress> <LoopBackAddress>50.1.2.2</LoopBackAddress> </Device> </Devices> </Data>
Resynchronize the Device Role Capabilities
This request is used to resynchronize the device roles
URI | /api/space/nsas/resync-role-p?data={device-id} |
HTTP Method | POST |
Consumes | application/vnd.net.juniper.space.manage-roles. |
Content Type | application/vnd.net.juniper.space.manage-roles.devices+xml; |
Produces | Resynchronizes the device roles. |
Input
Sample XML Input
https://10.213.9.198/api/space/nsas/resync-role-pe?data=5079298
Resynchronize LSPs
This request is used to resynchronize the LSP capabilities
URI | /api/space/nsas/prestage-ta-device/manage-devices/ |
HTTP Method | POST |
Consumes | application/vnd.net.juniper.space. |
Content Type | application/vnd.net.juniper.space.resync.ta-devices+xml; |
Produces | Resynchronizes the LSP capabilities. |
Output
Sample XML Output
View a Prestaged Device Details
This request is used to display the details of a particular prestaged device.
URI | /api/space/nsas/prestage-ta-device/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.ta- |
Produces | Displays the prestaged device details based on the device name. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8"?>
<root>
<Data>
<Devices>
<Device href="/api/space/nsas/prestage-ta-device/manage-devices/devices/98436" key="98436" uri="/api/space/nsas/prestage-ta-device/manage-devices/devices/98436">
<Admins />
<Common>
<Identity>98436</Identity>
<Name>amx-1100-a</Name>
</Common>
<Connection>up</Connection>
<IPAddress>10.216.114.33</IPAddress>
<LoopBackAddress>30.1.2.16</LoopBackAddress>
<Platform>MX104</Platform>
<Ports>
<Port>
<element>
<Id>229549</Id>
<Name>ge-1/2/0</Name>
</element>
<element>
<Id>229550</Id>
<Name>gr-1/2/0</Name>
</element>
<element>
<element>
<IPAddress>20.1.45.1</IPAddress>
<Id>229570</Id>
<Name>ge-1/2/0.0</Name>
</element>
<element>
<IPAddress>20.1.47.2</IPAddress>
<Id>229571</Id>
<Name>ge-1/2/1.0</Name>
</element>
<element>
<IPAddress>10.0.77.5</IPAddress>
<Id>229577</Id>
<Name>ge-1/3/4.48</Name>
</element>
<element>
<Id>229578</Id>
<Name>ge-1/3/5.1</Name>
</element>
<element>
<Id>229579</Id>
<Name>ge-1/3/8.1</Name>
</element>
<element>
<Id>229726</Id>
<Name>ge-1/3/5.2</Name>
</element>
</Port>
</Ports>
<Version>13.3R2.7</Version>
</Device>
</Devices>
</Data>
</root>
View the MPLS Path Settings for a Device
This request is used to display the details of MPLS paths for a device.
URI | /api/space/nsas/ta-device-path/manage-devices/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.paths+xml |
Produces | Displays the MPLS path attributes for a device. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8"?>
<Data xmlns="services.schema.networkapi.jmp.juniper.net">
<Devices>
<Device>
<Paths size="4" />
</Device>
</Devices>
</Data>
View the Administrative Groups of a Device
This request is used to display the administrative groups configured for LSPs of a device.
URI | /api/space/nsas/prestage-ta-device/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space. |
Produces | Displays the admin groups for LSPs on a device. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8"?>
<Data xmlns="services.schema.networkapi.jmp.juniper.net">
<Devices>
<Device>
<Admins size="0" />
</Device>
</Devices>
</Data>
View the NNI Details of a Device
This request is used to display the configured network-to-network interfaces (NNIs) of a device.
URI | /api/space/nsas/prestage-ta-device/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space. |
Produces | Displays the NNIs of a device. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8"?>
<Data xmlns="services.schema.networkapi.jmp.juniper.net">
<Devices>
<Device>
<Ports size="32">
<Port>
<Name>ge-1/2/0</Name>
<Id>229549</Id>
</Port>
<Port>
<Name>gr-1/2/0</Name>
<Id>229550</Id>
</Port>
<Port>
<Name>ge-1/2/0.0</Name>
<Id>229570</Id>
<IPAddress>20.1.45.1</IPAddress>
</Port>
<Port>
<Name>ge-1/2/1.0</Name>
<Id>229571</Id>
<IPAddress>20.1.47.2</IPAddress>
</Port>
<Port>
<Name>ge-1/2/5.55</Name>
<Id>229572</Id>
<IPAddress>10.0.88.70</IPAddress>
</Port>
<Port>
<Name>ge-1/3/4.48</Name>
<Id>229577</Id>
<IPAddress>10.0.77.5</IPAddress>
</Port>
<Port>
<Name>ge-1/3/5.1</Name>
<Id>229578</Id>
</Port>
<Port>
<Name>ge-1/3/8.1</Name>
<Id>229579</Id>
</Port>
<Port>
<Name>ge-1/3/5.2</Name>
<Id>229726</Id>
</Port>
</Ports>
</Device>
</Devices>
</Data>
Prestage and Discover Get TA Devices
This request is used to prestage and discover TA devices.
URI | /api/space/nsas/prestage-ta-device/manage-devices/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.ta. |
Produces | Prestages and discovers TA devices. |
Output
Sample XML Output
<Data> <Status> <Job> <ID>229379</ID> <Status>INPROGRESS</Status> </Job> <Code>200</Code> <Message> Discover TA Devices process triggered Successfully.Please check the Status using Job Id </Message> </Status> </Data>