Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Timing Devices Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Timing Devices Management RESTful Web Services.

    Get All Timing Devices

    This request is used to collect all the Timing devices.

    URI

    api/space/nsas/prestage-timing-device/manage-devices/
    devices

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.manage-devices.ta-devices+xml

    Produces

    Retrieves all the Timing 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>
    		<Device
    			href="/api/space/nsas/prestage-timing-device/manage-devices/devices/83"
    			uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/83"
    			key="83">
    			<Common>
    				<Name>embassy</Name>
    				<Identity>83</Identity>
    				<State>PTP</State>
    			</Common>
    			<ManagementAddress>10.216.114.109</ManagementAddress>
    			<LoopBackAddress>50.1.2.4/32</LoopBackAddress>
    		</Device>
    		<Device
    			href="/api/space/nsas/prestage-timing-device/manage-devices/devices/186"
    			uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/186"
    			key="186">
    			<Common>
    				<Name>junos-space1</Name>
    				<Identity>186</Identity>
    				<State>SYNCE</State>
    			</Common>
    			<ManagementAddress>10.216.114.119</ManagementAddress>
    			<LoopBackAddress>30.1.2.7/32</LoopBackAddress>
    		</Device>
    		<Device
    			href="/api/space/nsas/prestage-timing-device/manage-devices/devices/143"
    			uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/143"
    			key="143">
    			<Common>
    				<Name>junos-space2</Name>
    				<Identity>143</Identity>
    				<State>SYNCE</State>
    			</Common>
    			<ManagementAddress>10.216.114.120</ManagementAddress>
    			<LoopBackAddress>30.1.2.8/32</LoopBackAddress>
    		</Device>
    		<Device
    			href="/api/space/nsas/prestage-timing-device/manage-devices/devices/48"
    			uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/48"
    			key="48">
    			<Common>
    				<Name>junos-space3</Name>
    				<Identity>48</Identity>
    				<State>SYNCE</State>
    			</Common>
    			<ManagementAddress>10.216.114.121</ManagementAddress>
    			<LoopBackAddress>127.0.0.1/32</LoopBackAddress>
    		</Device>
    		<Device
    			href="/api/space/nsas/prestage-timing-device/manage-devices/devices/3"
    			uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/3"
    			key="3">
    			<Common>
    				<Name>junos-space5</Name>
    				<Identity>3</Identity>
    				<State>SYNCE</State>
    			</Common>
    			<ManagementAddress>10.216.114.123</ManagementAddress>
    			<LoopBackAddress>30.1.2.11/32</LoopBackAddress>
    		</Device>
    	</Devices>
    </Data>
    
    				

    Get Timing Devices By Device ID

    This request is used to retrieve a Timing device based on the device ID.

    URI

    api/space/nsas/prestage-Timing-device/manage-devices/
    devices/<pe-deviceId>

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.manage-devices.ta-devices+xml

    Produces

    Retrieves the Timing 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-timing-device/manage-devices/devices/83"
    			uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/83"
    			key="83">
    			<Common>
    				<Name>embassy</Name>
    				<Identity>83</Identity>
    				<State>PTP</State>
    			</Common>
    			<ManagementAddress>10.216.114.109</ManagementAddress>
    			<LoopBackAddress>50.1.2.4/32</LoopBackAddress>
    			<Role>PTP</Role>
    			<Ports>
    				<Port>
    					<Name>xe-0/0/0</Name>
    				</Port>
    				<Port>
    					<Name>xe-0/0/1</Name>
    				</Port>
    				<Port>
    					<Name>xe-0/0/2</Name>
    				</Port>
    				<Port>
    					<Name>xe-0/0/3</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/0</Name>
    					<IPAddress>40.1.3.1</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/1</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/2</Name>
    					<IPAddress>40.1.2.1</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/3</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/5</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/6</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/7</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/8</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/9</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/0</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/1</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/2</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/3</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/4</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/5</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/6</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/7</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/8</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/9</Name>
    				</Port>
    				<Port>
    					<Name>xe-1/2/0</Name>
    				</Port>
    				<Port>
    					<Name>xe-1/3/0</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/0.0</Name>
    					<IPAddress>40.1.3.1</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/1.111</Name>
    					<IPAddress>10.0.99.201</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/1.234</Name>
    					<IPAddress>10.0.99.185</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/1.534</Name>
    					<IPAddress>10.0.99.169</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/1.567</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/1.781</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/2.0</Name>
    					<IPAddress>40.1.2.1</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/3.96</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4.1</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4.2</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4.3</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4.12</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4.45</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/4.1245</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/5.122</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/6.56</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/7.1</Name>
    					<IPAddress>10.0.99.1</IPAddress>
    				</Port>
    				<Port>
    					<Name>ge-1/0/7.512</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/0/9.2</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/0.2</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/0.3</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/0.5</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/0.56</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/1.1</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/1.2</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/2.1</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/3.612</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/3.781</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/5.1</Name>
    				</Port>
    				<Port>
    					<Name>ge-1/1/7.18</Name>
    				</Port>
    				<Port>
    					<Name>xe-0/0/2.1</Name>
    				</Port>
    			</Ports>
    		</Device>
    	</Devices>
    </Data>
    
    				

    Configure Timing Devices for Synchronous Ethernet and PTP

    This request is used to configure timing devices for Synchronous Ethernet and PTP.

    URI

    /api/space/nsas/prestage-timing-device/manage-devices/
    devices/config

    HTTP Method

    POST

    Content Type

    application/vnd.net.juniper.space.device-management.
    device-config+xml

    Consumes

    application/vnd.net.juniper.space.device-management.
    device-config-status+xml

    Produces

    Configures timing devices for Synchronous Ethernet and PTP.

    Input

    Sample XML Input

     <?xml version="1.0" encoding="UTF-8"?>
    <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 size="0">
    		<SyncEDeviceConfig>
    			<General>
    				<CurrentServiceType>PTP</CurrentServiceType>
    				<NewServiceType>SYNcE</NewServiceType>
    				<Platform>All</Platform>
    				<Model>ALL</Model>
    			</General>
    			<Devices>
    				
    <TimingDevice href="/api/space/nsas/prestage-timing-device/manage-devices/devices/98621"  uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/98621" key="98621" xsi:type="DeviceIdType">
    					<DeviceName>embassy</DeviceName>
    					<DeviceID>98621</DeviceID>
    				</TimingDevice>
    <TimingDevice href="/api/space/nsas/prestage-timing-device/manage-devices/devices/98712"  uri="/api/space/nsas/prestage-timing-device/manage-devices/devices/98712" key="98712" xsi:type="DeviceIdType">
    					<DeviceName>junos-mx240-space</DeviceName>
    					<DeviceID>98712</DeviceID>
    				</TimingDevice>
    			</Devices>
    		</SyncEDeviceConfig>
    	</ServiceResource>
    </Data>
    
    
    				

    Output

    Sample XML Output

    <Data>
    	<Status>
    		<Code>200</Code>
    		<Message>Devices are configured successfully</Message>
    	</Status>
    </Data>
    
    				

    Modified: 2017-09-13