Data Object - PhysicalNicCdpInfo

Property of
PhysicalNicHintInfo
Extends
DynamicData
See also
PhysicalNicCdpDeviceCapability
Since
VI API 2.5

Data Object Description

CDP (Cisco Discovery Protocol) is a link level protocol that allows for discovering the CDP-awared network hardware at either end of a DIRECT connection. It's only good for direct connection because CDP doesn't get forwarded through switches. It's a simple advertisement protocol which beacons information about the switch or host along with some port information. The CDP information allows ESX Server admins to know which Cisco switch port is connected to any given virtual switch uplink (PNIC).

Properties

Name Type Description
address*xsd:string

The advertised IP address that is assigned to the interface of the device on which the CDP message is sent. The device can advertise all addresses for a given protocol suite and, optionally, can advertise one or more loopback IP addresses. But this property only show the first address.
cdpVersion*xsd:int

CDP version. The value is always 1.
deviceCapability*PhysicalNicCdpDeviceCapability

Device Capability PhysicalNicCdpDeviceCapability
devId*xsd:string

Device ID which identifies the device. By default, the device ID is either the device's fully-qualified host name (including the domain name) or the device's hardware serial number in ASCII.
fullDuplex*xsd:boolean

Half/full duplex setting of the advertising port.
hardwarePlatform*xsd:string

Hardware platform. An ASCII character string that describes the hardware platform of the device , e.g. "cisco WS-C2940-8TT-S"
ipPrefix*xsd:string

IP prefix. Each IP prefix represents one of the directly connected IP network segments of the local route.
ipPrefixLen*xsd:int

ipPrefix length.
location*xsd:string

The configured location of the device.
mgmtAddr*xsd:string

The configured IP address of the SNMP management interface for the device.
mtu*xsd:int

MTU, the maximum transmission unit for the advertising port. Possible values are 1500 through 18190.
portId*xsd:string

Port ID. An ASCII character string that identifies the port on which the CDP message is sent, e.g. "FastEthernet0/8"
samples*xsd:int

The number of CDP messages we have received from the device.
softwareVersion*xsd:string

Software version on the device. A character string that provides information about the software release version that the device is running. e.g. "Cisco Internetwork Operating Syscisco WS-C2940-8TT-S"
systemName*xsd:string

The configured SNMP system name of the device.
systemOID*xsd:string

The configured SNMP system OID of the device.
timeout*xsd:int

This is the periodicity of advertisement, the time between two successive CDP message transmissions
ttl*xsd:int

Time-To-Live. the amount of time, in seconds, that a receiver should retain the information contained in the CDP packet.
vlan*xsd:int

The native VLAN of advertising port. The native VLAN is the VLAN to which a port returns when it is not trunking. Also, the native VLAN is the untagged VLAN on an 802.1Q trunk.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition