OAM Devices Management RESTful Web Services
The following operations can be performed using the Connectivity Services Director Operations, Administration, and Maintenance (OAM) Devices Management RESTful Web Services.
Get All OAM Devices
This request is used to collect all the OAM devices.
URI | api/space/nsas/prestage-oam-device/manage-devices/devices |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.oam-devices+xml |
Produces | Retrieves all the OAM 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="18"> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131178" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131178" key="131178"> <Common> <Name>embassy</Name> <Identity>131178</Identity> </Common> <ManagementAddress>10.216.114.109</ManagementAddress> <LoopBackAddress>50.1.2.4</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131160" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131160" key="131160"> <Common> <Name>exora</Name> <Identity>131160</Identity> </Common> <ManagementAddress>10.216.114.114</ManagementAddress> <LoopBackAddress>50.1.2.3</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131085" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131085" key="131085"> <Common> <Name>fortius-f1103</Name> <Identity>131085</Identity> </Common> <ManagementAddress>10.216.114.211</ManagementAddress> <LoopBackAddress>30.1.2.18</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131104" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131104" key="131104"> <Common> <Name>fortius-f1104</Name> <Identity>131104</Identity> </Common> <ManagementAddress>10.216.114.210</ManagementAddress> <LoopBackAddress>30.1.2.16</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131249" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131249" key="131249"> <Common> <Name>fortius-f2100-a</Name> <Identity>131249</Identity> </Common> <ManagementAddress>10.216.114.94</ManagementAddress> <LoopBackAddress>30.1.2.13</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131263" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131263" key="131263"> <Common> <Name>fortius-f4000-a</Name> <Identity>131263</Identity> </Common> <ManagementAddress>10.216.114.96</ManagementAddress> <LoopBackAddress>30.1.2.15</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131095" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131095" key="131095"> <Common> <Name>fortius-g2106</Name> <Identity>131095</Identity> </Common> <ManagementAddress>10.216.114.209</ManagementAddress> <LoopBackAddress>30.1.2.19</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131214" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131214" key="131214"> <Common> <Name>jaipur</Name> <Identity>131214</Identity> </Common> <ManagementAddress>10.216.114.112</ManagementAddress> <LoopBackAddress>50.1.2.2</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/133165" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/133165" key="133165"> <Common> <Name>junos-m10-1-space</Name> <Identity>133165</Identity> </Common> <ManagementAddress>10.216.114.102</ManagementAddress> <LoopBackAddress>30.1.2.4</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131282" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131282" key="131282"> <Common> <Name>junos-mx240-space</Name> <Identity>131282</Identity> </Common> <ManagementAddress>10.216.114.101</ManagementAddress> <LoopBackAddress>30.1.2.1</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/132125" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/132125" key="132125"> <Common> <Name>junos-mx480-space</Name> <Identity>132125</Identity> </Common> <ManagementAddress>10.216.114.100</ManagementAddress> <LoopBackAddress>30.1.2.6</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/132012" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/132012" key="132012"> <Common> <Name>junos-mx80-1-space</Name> <Identity>132012</Identity> </Common> <ManagementAddress>10.216.114.104</ManagementAddress> <LoopBackAddress>30.1.2.5</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/133195" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/133195" key="133195"> <Common> <Name>junos-mx80-2-space</Name> <Identity>133195</Identity> </Common> <ManagementAddress>10.216.114.105</ManagementAddress> <LoopBackAddress>30.1.2.3</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/133347" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/133347" key="133347"> <Common> <Name>junos-space1</Name> <Identity>133347</Identity> </Common> <ManagementAddress>10.216.114.119</ManagementAddress> <LoopBackAddress>30.1.2.7</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/133390" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/133390" key="133390"> <Common> <Name>junos-space2</Name> <Identity>133390</Identity> </Common> <ManagementAddress>10.216.114.120</ManagementAddress> <LoopBackAddress>30.1.2.8</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131074" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131074" key="131074"> <Common> <Name>junos-space3</Name> <Identity>131074</Identity> </Common> <ManagementAddress>10.216.114.121</ManagementAddress> <LoopBackAddress>127.0.0.1</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131123" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131123" key="131123"> <Common> <Name>junos-space5</Name> <Identity>131123</Identity> </Common> <ManagementAddress>10.216.114.123</ManagementAddress> <LoopBackAddress>30.1.2.11</LoopBackAddress> </Device> <Device href="/api/space/nsas/prestage-oam-device/manage-devices/devices/131227" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131227" key="131227"> <Common> <Name>kochin</Name> <Identity>131227</Identity> </Common> <ManagementAddress>10.216.114.110</ManagementAddress> <LoopBackAddress>50.1.2.1</LoopBackAddress> </Device> </Devices> </Data>
Get OAM Devices By Device ID
This request is used to retrieve a OAM device based on the device ID.
URI | api/space/nsas/prestage-oam-device/manage-devices/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.manage-devices.oam-devices+xml |
Produces | Retrieves the OAM 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-oam-device/manage-devices/devices/131199" uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/131199" key="131199"> <Common> <Name>kochin</Name> <Identity>131199</Identity> </Common> <ManagementAddress>10.216.114.110</ManagementAddress> <LoopBackAddress>50.1.2.1</LoopBackAddress> <Ports> <Port> <Name>ge-0/0/0</Name> <Id>138092</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/1</Name> <Id>138093</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/2</Name> <Id>138094</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/3</Name> <Id>138095</Id> <AdminStatus>down</AdminStatus> </Port> <Port> <Name>ge-0/0/5</Name> <Id>138096</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/6</Name> <Id>138097</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/7</Name> <Id>138098</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/8</Name> <Id>138099</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/9</Name> <Id>138100</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/2/5</Name> <Id>138101</Id> <AdminStatus>down</AdminStatus> </Port> <Port> <Name>ge-0/0/0.0</Name> <Id>138102</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/1.0</Name> <Id>138103</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/2.0</Name> <Id>138104</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/3.1</Name> <Id>138105</Id> <AdminStatus>down</AdminStatus> </Port> <Port> <Name>ge-0/0/5.0</Name> <Id>138106</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/6.175</Name> <Id>138107</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/6.189</Name> <Id>138108</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/6.190</Name> <Id>138109</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/6.207</Name> <Id>138110</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/7.0</Name> <Id>138111</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/9.141</Name> <Id>138112</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/0/9.2</Name> <Id>138113</Id> <AdminStatus>up</AdminStatus> </Port> <Port> <Name>ge-0/2/5.1</Name> <Id>138114</Id> <AdminStatus>down</AdminStatus> </Port> </Ports> <ActionProfile key="163915" uri="/api/space/nsas/cfm-actionprofiles/service-management/service-definitions/163915" href="/api/space/nsas/cfm-actionprofiles/service-management/service-definitions/163915"> <Common> <Name>Test</Name> <Identity>163915</Identity> </Common> <Type>CFM</Type> </ActionProfile> <ActionProfile key="163923" uri="/api/space/nsas/cfm-actionprofiles/service-management/service-definitions/163923" href="/api/space/nsas/cfm-actionprofiles/service-management/service-definitions/163923"> <Common> <Name>Test123</Name> <Identity>163923</Identity> </Common> <Type>CFM</Type> </ActionProfile> <ActionProfile key="65543" uri="/api/space/nsas/lfm-actionprofiles/service-management/service-definitions/65543" href="/api/space/nsas/lfm-actionprofiles/service-management/service-definitions/65543"> <Common> <Name>StdDef-LFM-ActionProfile</Name> <Identity>65543</Identity> </Common> <Type>LFM</Type> </ActionProfile> <SLAProfile key="98304" uri="/api/space/nsas/sla-iteratorprofiles/service-management/service-definitions/98304" href="/api/space/nsas/sla-iteratorprofiles/service-management/service-definitions/98304"> <Common> <Name>StdDef-Loss</Name> <Identity>98304</Identity> </Common> </SLAProfile> </Device> </Devices> </Data>
Prestage and Discover Get OAM Devices
This request is used to prestage and discover OAM devices.
URI | /api/space/nsas/prestage-oam-device/manage-devices/ |
HTTP Method | GET |
Consumes | application/vnd.net.juniper.space.discover-oam-devices.status+xml |
Produces | Prestages and discovers OAM devices. |
Output
Sample XML Output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Data xmlns="services.schema.networkapi.jmp.juniper.net"> <Status> <Job> <ID>1376519</ID> <Status>INPROGRESS</Status> </Job> <Code>200</Code> <Message>Discover devices process triggered Successfully.Please check the Status using Job Id</Message> </Status> </Data>