Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

TechLibrary
Navigation
Table of Contents
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Performance Monitoring Statistics Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Performance Monitoring Statistics Management RESTful Web Services.

    Start Collection of PM Statistics

    This request is used to start the collection of performance monitoring statistics.

    URI

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/operation

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/operation

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/loss/operation

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/operation

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/operation

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/loss/operation

    HTTP Method

    POST

    Content Type

    application/xml

    Consumes

    application/xml

    Produces

    Starts the collection of performance monitoring statistics.

    Input

    Sample XML Input

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource >
   	 <PerformanceMonitoring>
   	<Operation>start</Operation>
    	<AEnd>
   		<DeviceName>penelope</DeviceName>
   		<DeviceID>589940</DeviceID>
  	</AEnd>
 	<ZEnd>
  		<DeviceName>froh</DeviceName>
<DeviceID>1114174</DeviceID>
</ZEnd> 
<IntervalDuration>10</IntervalDuration>
<MeasurementAttribute>
<Count>10</Count>
<Wait>1</Wait>
<Dot1p>2</Dot1p>
</MeasurementAttribute>
   	</PerformanceMonitoring>   
    </ServiceResource>
 </Data>

    Output

    Sample XML Output

        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Status>
    <Code>200</Code>
    <Message>Operation Successful</Message>
    </Status>
    </Data>

    Stop Collection of PM Statistics

    This request is used to stop the collection of performance monitoring statistics.

    URI

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/operation

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/operation

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/loss/operation

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/operation

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/operation

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/loss/operation

    HTTP Method

    POST

    Content Type

    application/xml

    Consumes

    application/xml

    Produces

    Stops the collection of performance monitoring statistics.

    Input

    Sample XML Input

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource >
   	 <PerformanceMonitoring>
   	<Operation>stop</Operation>
   	</PerformanceMonitoring>   
    </ServiceResource>
 </Data>

    Output

    Sample XML Output

        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Status>
    <Code>200</Code>
    <Message>Operation Successful</Message>
    </Status>
    </Data>

    Get PM Statistics

    This request is used to retrieve the performance monitoring statistics.

    URI

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/stats

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/stats

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/loss/stats

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/stats

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/stats

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/loss/stats

    HTTP Method

    POST

    Content Type

    application/xml

    Consumes

    application/xml

    Produces

    Retrieves the performance monitoring statistics.

    Output

    Sample XML Output

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
      <PerformanceMonitoring>
        <AEnd>
          <DeviceID>1114174</DeviceID>
        </AEnd>
        <ZEnd>
          <DeviceID>3203939</DeviceID>
        </ZEnd>
        <TwoWayDelayStatsCollection>
          <DelayStats>
            <TimeStamp>1356638570414</TimeStamp>
	<Unit>microsecond</Unit>
            <Min>158</Min>
            <Max>201</Max>
            <Average>180</Average>
            <Variation>13</Variation>
          </DelayStats>
          <DelayStats>
            <TimeStamp>1356638582812</TimeStamp>
<Unit>microsecond</Unit>
            <Min>176</Min>
       <Max>215</Max>
            <Average>192</Average>
            <Variation>10</Variation>
          </DelayStats>
          <DelayStats>
            <TimeStamp>1356638595231</TimeStamp>
<Unit>microsecond</Unit>
            <Min>171</Min>
            <Max>221</Max>
            <Average>195</Average>
            <Variation>15</Variation>
          </DelayStats>
          <DelayStats>
            <TimeStamp>1356658454661</TimeStamp>
	<Unit>microsecond</Unit>
            <Min>0</Min>
            <Max>0</Max>
            <Average>0</Average>
            <Variation>0</Variation>
          </DelayStats>
        </TwoWayDelayStatsCollection>
      </PerformanceMonitoring>
    </ServiceResource>
    <Status>
      <Code>200</Code>
      <Message>Operation Successful</Message>
    </Status>
  </Data>

    Get PM Status

    This request is used to retrieve the performance monitoring status.

    URI

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/status

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/status

    api/space/nsas/eline-ptp/service-management/services/
    {service-id}/performanceMonitoring/loss/status

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/twoway-delay/status

    api/space/nsas/elan-vpls/service-management/services/
    {service-id}/performanceMonitoring/oneway-delay/status

    api/space/nsas/elan-vpls/service-management/services/

    {service-id}/performanceMonitoring/loss/status

    HTTP Method

    POST

    Content Type

    application/xml

    Consumes

    application/xml

    Produces

    Retrieves the performance monitoring status details.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8"?>
<Data xmlns="services.schema.networkapi.jmp.juniper.net">
 <Status>
      <Code>200</Code>
      <Message>Two Way Delay On</Message>
    </Status>
  </Data>

    Get Service Path

    This request is used to retrieve the service path information.

    URI

    api/space/nsas/eline-ptp/service-management/ services/
    {service-id}/servicepath?deviceA=819572&deviceZ=819961

    api/space/nsas/elan-vpls/service-management/ services/
    {service-id}/ servicepath?deviceA=819572&deviceZ=819961

    HTTP Method

    GET

    Content Type

    application/xml

    Consumes

    application/xml

    Produces

    Retrieves the service path.

    Output (LDP LSP)

    Sample XML Output

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
   	 <ServicePath>
    		<To>10.1.1.13</To>
    		<Via>ge-1/0/1.0</Via>
    		<MPLSLabel>Push 300016, Push 300000(top)</MPLSLabel>
    		<Selected>true</Selected>
    		<LSPPath>
    			<LSPNode>
    				<Depth>1</Depth>
    				<Parent>(null)</Parent>
    				<Address>10.1.1.13</Address>
    				<LabelValue>300000</LabelValue>
    				<Status>Success</Status>
    				<Device>
    					<DeviceName>wotan</DeviceName>
    					<DeviceID>721023</DeviceID>
    				</Device>
    			</LSPNode>
    			<LSPNode>
    				<Depth>2</Depth>
    				<Parent>10.1.1.13</Parent>
    				<Address>10.1.1.9</Address>
    				<LabelValue>3</LabelValue>
    				<Interface>ge-1/0/1.0</Interface>
    				<Status>Egress</Status>
    				<Device>
    					<DeviceName>acx2k</DeviceName>
    					<DeviceID>721043</DeviceID>
    				</Device>
    			</LSPNode>
    		</LSPPath>
    	</ServicePath>
    </ServiceResource>
    <Status>
    <Code>200</Code>
    <Message>Operation Successful</Message>
    </Status>
    </Data>

    Output (RSVP LSP)

    Sample XML Output

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
   	 <ServicePath>
    		<To>10.1.1.13</To>
    		<Via>ge-1/0/1.0</Via>
    		<MPLSLabel>Push 300016, Push 300000(top)</MPLSLabel>
    		<Selected>true</Selected>
    		<LSPPath>
<RSVPLSPName>penelope-acx2k</RSVPLSPName>
    			<LSPNode>
    				<Depth>1</Depth>
    				<Parent>(null)</Parent>
    				<Address>10.1.1.13</Address>
    				<LabelValue>300000</LabelValue>
    				<Status>Success</Status>
    				<Device>
    					<DeviceName>wotan</DeviceName>
    					<DeviceID>721023</DeviceID>
    				</Device>
    			</LSPNode>
    			<LSPNode>
    				<Depth>2</Depth>
    				<Parent>10.1.1.13</Parent>
    				<Address>10.1.1.9</Address>
    				<LabelValue>3</LabelValue>
    				<Interface>ge-1/0/1.0</Interface>
    				<Status>Egress</Status>
    				<Device>
    					<DeviceName>acx2k</DeviceName>
    					<DeviceID>721043</DeviceID>
    				</Device>
    			</LSPNode>
    		</LSPPath>
    	</ServicePath>
    </ServiceResource>
    <Status>
    <Code>200</Code>
    <Message>Operation Successful</Message>
    </Status>
    </Data>

    Get Services Filtered Using Fault Status for ELINE P2P Services

    This request is used to discover the roles of devices.

    URI

    api/space/nsas/eline-ptp/service-management/
    services?faultStatus=Down

    You can also obtain a list of services with FaultStatus as Up or None by specifying faultStatus=Up/None) in the URI

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.service-management.
    services+xml

    Produces

    Retrieves the ELINE P2P services for which the fault status is down.

    Output

    Sample XML Output

        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource size="1">
    <Service href="/api/space/nsas/eline-ptp/service-management/services/1048583" uri="/api/space/nsas/eline-ptp/service-management/services/1048583" key="1048583">
    <Common>
    <Name>PTP</Name>
    <Identity>1048583</Identity>
    <State>Deployed</State>
    <Comments>PTP</Comments>
    <CreatedDate>2012-12-14T02:01:18.000+05:30</CreatedDate>
    <LastUpdatedDate>2012-12-14T02:01:18.000+05:30</LastUpdatedDate>
    </Common>
    <ServiceType>LDP</ServiceType>
    <AuditFlag>
    <FunctionalAudit>Pending</FunctionalAudit>
    <FaultStatus>Down</FaultStatus>
    </AuditFlag>
    <Reference>
    <ServiceOrder key="1048576" href="/api/space/nsas/eline-ptp/service-management/service-orders/1048576" uri="/api/space/nsas/eline-ptp/service-management/service-orders/1048576"/>
    <ServiceDefinition>
    <ServiceDefinitionID key="294912" href="/api/space/nsas/eline-ptp/service-management/service-definitions/294912" uri="/api/space/nsas/eline-ptp/service-management/service-definitions/294912"/>
    </ServiceDefinition>
    <Customer key="720896" href="/api/space/nsas/customer-management/customers/720896" uri="/api/space/nsas/customer-management/customers/720896"/>
    </Reference>
    </Service>
    </ServiceResource>
    </Data>

    Get Services Filtered Using Fault Status for L3VPN Services

    This request is used to retrieve the L3VPN services for which the fault status is down.

    URI

    api/space/nsas/l3vpn/service-management/
    services?faultStatus=Down

    You can also obtain a list of services with FaultStatus as Up or None by specifying faultStatus=Up/None) in the URI

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.service-management.services+xml

    Produces

    Retrieves the L3VPN services for which the fault status is down.

    Output

    Sample XML Output

        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource size="1">
    <Service href="/api/space/nsas/l3vpn/service-management/services/819207" uri="/api/space/nsas/l3vpn/service-management/services/819207" key="819207">
    <Common>
    <Name>L3vpnTest</Name>
    <Identity>819207</Identity>
    <State>Deployed</State>
    <Comments>L3vpnTest</Comments>
    <CreatedDate>2012-12-14T01:36:50.000+05:30</CreatedDate>
    <LastUpdatedDate>2012-12-14T01:36:50.000+05:30</LastUpdatedDate>
    </Common>
    <ServiceType>L3VPN</ServiceType>
    <AuditFlag>
    <FunctionalAudit>Pending</FunctionalAudit>
    <FaultStatus>Down</FaultStatus>
    </AuditFlag>
    <Reference>
    <ServiceOrder key="819200" href="/api/space/nsas/l3vpn/service-management/service-orders/819200" uri="/api/space/nsas/l3vpn/service-management/service-orders/819200"/>
    <ServiceDefinition>
    <ServiceDefinitionID key="327680" href="/api/space/nsas/l3vpn/service-management/service-definitions/327680" uri="/api/space/nsas/l3vpn/service-management/service-definitions/327680"/>
    </ServiceDefinition>
    <Customer key="720896" href="/api/space/nsas/customer-management/customers/720896" uri="/api/space/nsas/customer-management/customers/720896"/>
    </Reference>
    </Service>
    </ServiceResource>
    </Data>

    Get Services Filtered Using Fault Status for ELAN VPLS Services

    This request is used to retrieve the ELAN VPLS services for which the fault status is down.

    URI

    api/space/nsas/vpls/service-management/services
    ?faultStatus=Down

    You can also obtain a list of services with FaultStatus as Up or None by specifying faultStatus=Up/None) in the URI

    HTTP Method

    GET

    Consumes

    application/vnd.net.juniper.space.service-management.services+xml

    Produces

    Retrieves the VPLS services for which the fault status is down.

    Output

    Sample XML Output

        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource size="1">
    <Service href="/api/space/nsas/elan-vpls/service-management/services/1081439" uri="/api/space/nsas/elan-vpls/service-management/services/1081439" key="1081439">
    <Common>
    <Name>ELAN_VPLS</Name>
    <Identity>1081439</Identity>
    <State>Deployed</State>
    <Comments> </Comments>
    <CreatedDate>2012-12-14T02:13:19.000+05:30</CreatedDate>
    <LastUpdatedDate>2012-12-14T02:13:19.000+05:30</LastUpdatedDate>
    </Common>
    <ServiceType>VPLS</ServiceType>
    <AuditFlag>
    <FunctionalAudit>Pending</FunctionalAudit>
    <FaultStatus>Down</FaultStatus>
    </AuditFlag>
    <ServiceParameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSConfigParameterServiceType"/>
    <Reference>
    <ServiceOrder key="1081426" href="/api/space/nsas/elan-vpls/service-management/service-orders/1081426" uri="/api/space/nsas/elan-vpls/service-management/service-orders/1081426"/>
    <ServiceDefinition>
    <ServiceDefinitionID key="262225" href="/api/space/nsas/elan-vpls/service-management/service-definitions/262225" uri="/api/space/nsas/elan-vpls/service-management/service-definitions/262225"/>
    </ServiceDefinition>
    <Customer key="720896" href="/api/space/nsas/customer-management/customers/720896" uri="/api/space/nsas/customer-management/customers/720896"/>
    </Reference>
    </Service>
    </ServiceResource>
    </Data>

    Modified: 2015-10-13

    Previous Page Next Page