Get One-IP Table

Method

URL

Required authentication

Get

/V1/CMDB/Topology/OneIPTable

Yes

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

ip (string)
(query)

The IP address that you want to return its One-IP Table items.

▪If this parameter is specified, the API returns the One-IP table items that have the same IP and ignore the beginIndex and count parameters.

▪If null, the API returns all One-IP table items and the API uses the beginIndex and count parameters to return results.

beginIndex (int)
(query)

Specify from which row to begin indexing data. For example, the begin is 0, and the API will return One-IP Table results starting from the first row. This parameter is required when the IP parameter is specified.

count (int)
(query)

Specify the maximum number of returned data. This parameter is required when the IP parameter is specified.

oneIPList

List

A list of One-IP items.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "OneIPList": [
    {
      'alias': "",
      'descr': '"if&ipfor EIGRP"',
      'devName': 'SanJose_Core',
      'dns': 'SanJose_Core',
      'interfaceName': 'Ethernet0/0',
      'ip': '30.1.3.1',
      'lanSegment': '30.1.3.0/24',
      'mac': 'FCFB.FB8C.6288',
      'portName': 'Ethernet0/0',
      'serverType': 2,
      'source': 'ARP Table',
      'sourceDevice': 'SanJose_Core',
      'switchName': 'NY_DIS_1',
      'switchType': 2,
      'updateTime': '2018-07-31',
      'userFlag': 7,
      'vendor': 'Cisco Systems'},
    }
  ]
}

ip

string

The IP address of an end system or device interface in a One-IP table item.

lanSegment

string

The LAN segment of the IP address.

mac

string

The MAC address that the IP corresponds to.

devName

string

The name of the device that the IP belongs to.

interfaceName

string

The name of the interface that the IP belongs to.

switchName

string

The name of the switch that the IP connects to.

portName

string

The name of the switch port that the IP connects to

alias

string

The routing redundancy protocol that the interface of the IP configures, such as HSRP/GLBP/VRRP.

dns

string

The DNS of an IP.

sourceDevice

string

The source device that the IP is discovered from.

serverType

string

The type of the device that the IP belongs to.

switchType

string

The type of the switch that the IP connects to.

updateTime

string

The last update time of the One-IP Table item.

userFlag

int

The method to retrieve the IP.

▪0: Auto

▪1: Manual

▪5: CDP/LLDP table

▪6: MAC table

▪7: ARP table

▪9: Device Interface

source

string

The method to retrieve the IP, such as from MAC table.

vendor

string

The vendor of the device that the IP belongs to.

descr

string

The description of the switchport that the IP address connects to.