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

    LFM Links Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Link Fault Management (LFM) Links Management RESTful Web Services.

    Create an LFM Link

    This request is used to create an LFM link.

    URI

    /api/space/nsas/prestage-oam-device/
    manage-devices/lfmlinks

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.manage-devices.
    oam-device-lfmlink+xml

    Consumes

    application/vnd.net.juniper.space.manage-devices.
    oam-device-lfmlink-status+xml

    Produces

    Creates an LFM link.

    Input

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<LFMLinks>
    		<LFMLink>
    			<Common>
    				<Name>LFM-API</Name>
    			</Common>
    			<Device-1>
    				<OAM>
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/3</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM>
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/3</LFMInterface>
    				</OAM>
    			</Device-2>
    			<LFMProfile key="32768" />
    		</LFMLink>
    	</LFMLinks>
    </Data>
    
    
    

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Job>
    			<ID>655377</ID>
    			<Status>INPROGESS</Status>
    		</Job>
    		<Code>200</Code>
    		<Message>Creeate LFM Link triggered Successfully.Please Check the
    			status using Job Id.</Message>
    	</Status>
    </Data>
    
    
    

    Get an LFM Link By Link ID

    This request is used to retrieve the details of a particular LFM link, based on the link ID.

    URI

    api/space/nsas/prestage-oam-device/manage-
    devices/lfmlinks/<lfmId >

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.manage-devices.oam-
    device-lfmlink-status+xml

    Produces

    Collects the details of a specific LFM link.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<LFMLinks>
    		<LFMLink>
    			<Common>
    				<Name>vgjhgvfj</Name>
    				<Identity>197230</Identity>
    				<CreatedDate>2013-08-29T15:21:40.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-29T15:21:40.000+05:30</LastUpdatedDate>
    			</Common>
    			<LinkStatus>Failed</LinkStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/5</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/4</LFMInterface>
    				</OAM>
    			</Device-2>
    			<LFMProfile
    				href="/api/space/nsas/lfm-profiles/service-management/service-definitions/32768"
    				uri="/api/space/nsas/lfm-profiles/service-management/service-definitions/32768"
    				key="32768" />
    		</LFMLink>
    	</LFMLinks>
    </Data>
    
    
    

    Get All LFM Links

    This request is used to retrieve all the configured LFM links.

    URI

    api/space/nsas/prestage-oam-device/
    manage-devices/lfmlinks/

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.
    manage-devices.oam-device-lfmlink-status+xml

    Produces

    Collects all the configured LFM links.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<LFMLinks size="6">
    		<LFMLink>
    			<Common>
    				<Name>vgjhgvfj</Name>
    				<Identity>197230</Identity>
    				<CreatedDate>2013-08-29T15:21:40.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-29T15:21:40.000+05:30</LastUpdatedDate>
    			</Common>
    			<LinkStatus>Failed</LinkStatus>
    			<FaultStatus>None</FaultStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/5</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/4</LFMInterface>
    				</OAM>
    			</Device-2>
    		</LFMLink>
    		<LFMLink>
    			<Common>
    				<Name>gxfdrtf</Name>
    				<Identity>197263</Identity>
    				<CreatedDate>2013-08-29T15:22:30.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-29T15:22:30.000+05:30</LastUpdatedDate>
    			</Common>
    			<LinkStatus>Failed</LinkStatus>
    			<FaultStatus>None</FaultStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/5</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/4</LFMInterface>
    				</OAM>
    			</Device-2>
    		</LFMLink>
    		<LFMLink>
    			<Common>
    				<Name>fhgfdh</Name>
    				<Identity>197327</Identity>
    				<CreatedDate>2013-08-29T17:46:37.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-29T17:46:37.000+05:30</LastUpdatedDate>
    			</Common>
    			<LinkStatus>Failed</LinkStatus>
    			<FaultStatus>None</FaultStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/2</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/0</LFMInterface>
    				</OAM>
    			</Device-2>
    		</LFMLink>
    		<LFMLink>
    			<Common>
    				<Name>rdtrdy</Name>
    				<Identity>197421</Identity>
    				<CreatedDate>2013-08-29T18:18:05.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-29T18:18:05.000+05:30</LastUpdatedDate>
    			</Common>
    			<FaultStatus>None</FaultStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/1</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/1</LFMInterface>
    				</OAM>
    			</Device-2>
    		</LFMLink>
    		<LFMLink>
    			<Common>
    				<Name>eafde-API</Name>
    				<Identity>197483</Identity>
    				<CreatedDate>2013-08-29T18:29:25.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-29T18:29:25.000+05:30</LastUpdatedDate>
    			</Common>
    			<FaultStatus>None</FaultStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>xe-0/3/0</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/2/1</LFMInterface>
    				</OAM>
    			</Device-2>
    		</LFMLink>
    		<LFMLink>
    			<Common>
    				<Name>eafde-API1</Name>
    				<Identity>295115</Identity>
    				<CreatedDate>2013-08-30T15:06:27.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-08-30T15:06:27.000+05:30</LastUpdatedDate>
    			</Common>
    			<FaultStatus>None</FaultStatus>
    			<Device-1>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163925"
    					key="163925">
    					<DeviceName>junos-space1</DeviceName>
    					<DeviceID>163925</DeviceID>
    					<LFMInterface>ge-0/1/0</LFMInterface>
    				</OAM>
    			</Device-1>
    			<Device-2>
    				<OAM
    					href="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					uri="/api/space/nsas/prestage-oam-device/manage-devices/devices/163981"
    					key="163981">
    					<DeviceName>junos-space2</DeviceName>
    					<DeviceID>163981</DeviceID>
    					<LFMInterface>ge-0/1/2</LFMInterface>
    				</OAM>
    			</Device-2>
    		</LFMLink>
    	</LFMLinks>
    </Data>
    
    

    Update the LFM Link Status

    This request is used to update the status of an LFM link.

    URI

    /api/space/nsas/prestage-oam-device/
    manage-devices/lfmlinks/update-lfmstatus

    HTTP Method

    POST

    Content-Type

    application/vnd.net.juniper.space.manage-devices.
    oam-device-lfmlink-updatestatus+xml

    Consumes

    application/vnd.net.juniper.space.manage-devices.
    oam-device-lfmlink-status+xml

    Produces

    Updates the status of an LFM link.

    Input

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<LFMLinks>
    		<LFMLink>
    			<Common>
    				<Name>gxfdrtf</Name>
    				<Identity>197263</Identity>
    			</Common>
    			
    			<Common>
    				<Name>fhgfdh</Name>
    				<Identity>197327</Identity>
    			</Common>
    			
    			<Common>
    				<Name>rdtrdy</Name>
    				<Identity>197421</Identity>
    			</Common>
    			
    		</LFMLink>
    	</LFMLinks>
    </Data>
    
    
    

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Job>
    			<ID>655375</ID>
    			<Status>INPROGESS</Status>
    		</Job>
    		<Code>200</Code>
    		<Message>LFM Status update triggered Successfully.</Message>
    	</Status>
    </Data>
    
    
    

    Delete an LFM Link

    This request is used to delete an LFM link.

    URI

    /api/space/nsas/prestage-oam-device/
    manage-devices/lfmlinks/<lfmid>

    HTTP Method

    DELETE

    Content-Type

    application/vnd.net.juniper.space.manage-devices.
    oam-device-lfmlink+xml

    Consumes

    application/vnd.net.juniper.space.manage-devices.
    oam-device-lfmlink-status+xml

    Produces

    Deletes an LFM link.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<Status>
    		<Job>
    			<ID>655372</ID>
    			<Status>INPROGESS</Status>
    		</Job>
    		<Code>200</Code>
    		<Message>Remove LFM Link triggered Successfully.Please Check the
    			status using Job Id.</Message>
    	</Status>
    </Data>
    
    
    

    Modified: 2015-10-13