/api/space/managed-domain/ptps/{ptpId} (v1)

The following operation is supported on this resource:

  • GET - Get information of the Physical termination point
GET /ptps/{ptpId}Version 1

This API returns physical termination point (PTP) information for a single point.

Sample Usage

GET /ptps/{ptpId}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    ptp-idintPathThe ID of the PTP from which information is needed. Y
  • Sample Output XML:

    <ptp uri="/api/space/managed-domain/ptps/262144">
       <id>262144</id>
       <name>lo0</name>
       <deviceId>229377</deviceId>
       <edgePoint>false</edgePoint>
       <isLoopback>true</isLoopback>
       <ctps>
         <ctp>
            <id>262145</id>
            <name>lo0.0</name>
            <deviceId>229377</deviceId>
            <edgePoint>false</edgePoint>
            <ipAddr>127.0.0.1</ipAddr>
            <isLoopback>false</isLoopback>
            <ipNetmask>32</ipNetmask>
            <isManagement>false</isManagement>
            <nativeVlanIdRange>0-4098</nativeVlanIdRange>
            <vlanId>121</vlanId>
            <vlanTagsInnerRange>1-4094</vlanTagsInnerRange>
            <vlanTagsOuter>VLAN</vlanTagsOuter>
         </ctp>
       </ctps>
       <encapsulation>none</encapsulation>
       <tagging>NONE</tagging>
       <adminStatus>up</adminStatus>
       <operationStatus>up</operationStatus>
       <linkLevelType>Ethernet</linkLevelType>
       <linkType>full-duplex</linkType>
       <speed>0</speed>
       <mtu>0</mtu>
       <mtuStr>Unlimited</mtuStr>
       <hardwarePhysicalAddress>08:00:27:96:60:dc</hardwarePhysicalAddress>
       <managed-element href="/api/space/managed-domain/managed-elements/262148">
          <id>262148</id>
          <ipAddr>192.168.21.9</ipAddr>
       </managed-element>
    </ptp>

  • Sample Output JSON:

    {
      "ptp": {
         "@uri":"/api/space/managed-domain/ptps/262144","id": 262144,
         "name":"lo0",
         "deviceId":229377,
         "edgePoint":false,
         "isLoopback":true,
         "ctps": {
            "ctp": {
               "id":262145,
               "name":"lo0.0",
               "deviceId":229377 ,
               "edgePoint":false ,
               "ipAddr": "127.0.0.1",
               "isLoopback": false,
               "ipNetmask":32,
               "isManagement": false
               "nativeVlanIdRange": "0-4098"
               "vlanId": "121",
               "vlanTagsInnerRange": "1-4094",
               "vlanTagsOuter": "VLAN",
            }
         },
         "encapsulation":"none",
          "tagging": "NONE",
         "adminStatus":"up",
         "operationStatus":"up",
         "linkLevelType":"Ethernet",
         "linkType":"full-duplex",
         "speed":0,
         "mtu":0,
         "mtuStr":"Unlimited",
         "hardwarePhysicalAddress": "08:00:27:96:60:dc",
         "managed-element": {
              "@href": "/api/space/managed-domain/managed-elements/262148",
              "id":262148,
              "ipAddr":"192.168.21.9"
         }
      }
    }

  • Access Control

    The following capabilities are required to access this API: ViewInterfaces

      For the current version of this API, refer to :
    • version 3