Cisco System Model: Classcdp:Inst

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class cdp:Inst (CONCRETE)

Class ID:2640
Class Label: CDP Instance
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l1, access-protocol-l2, admin, fabric-protocol-l1, fabric-protocol-l2, tenant-ext-protocol-l2, tenant-protocol-l2]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Default
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: true ]

The object that represents the CDP instance information. Currently only one CDP instance is supported.

Naming Rules
RN FORMAT: inst [1] PREFIX=inst DN FORMAT: [0] topology/pod-{id}/node-{id}/sys/cdp/inst [1] sys/cdp/inst

Diagram
Super Mo: l2:ProtInst, Container Mos: cdp:Entity (deletable:no), Contained Mos: cdp:If,

Containers Hierarchies

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

fabric:Topology The root for IFC topology.

├

fabric:Pod A pod.

├

fabric:Node The root node for the APIC.

├

top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...

├

cdp:Entity Holds cdp control plane entity information

├

cdp:Inst The object that represents the CDP instance information. Currently only one CDP instance is supported.

top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.

├

├

cdp:Entity Holds cdp control plane entity information

├

cdp:Inst The object that represents the CDP instance information. Currently only one CDP instance is supported.

Contained Hierarchy

cdp:Inst The object that represents the CDP instance information. Currently only one CDP instance is supported.

├

cdp:If CDP information that is operated at a interface level. CDP is used to obtain protocol addresses of neighboring devices and discover the platform of those devices. CDP is also used to display information about the neighboring interfaces/devices.

├

cdp:AdjEp The CDP neighbor information. CDP is enabled by default on all supported interfaces.

├

cdp:AdjStats CDP adjacency statistics

├

cdp:IntfAddr The CDP interface address received from CDP neighbor.

├

cdp:MgmtAddr The management device IP address received from CDP neighbor.

├

cdp:IfStats CDP interface statistics

├

l2:RsEthIf A source relation to an L1 interface. This is an internal object.

├

nw:RtPathToIf A target relation to the interface information.

Inheritance

nw:Item Ignore.

├

nw:Conn A connection abstraction.

├

nw:GEp A group endpoint abstraction.

├

nw:CpInst A control plane instance abstraction. This object represents an instance of the protocol. For example, the protocol instance of OSPF or ISIS.

├

nw:ProtInst A protocol instance abstraction.

├

l2:ProtInst A protocol instance abstraction.

├

cdp:Inst The object that represents the CDP instance information. Currently only one CDP instance is supported.

Events
cdp:Inst:cdp_Inst_operErr cdp:Inst:cdp_Inst_adminStChange

Faults

Fsms

Properties Summary

Defined in: cdp:Inst
cdp:DevIdT scalar:Enum8	devIdType (cdp:Inst:devIdType) The CDP instance device type ID to the remote peer.
cdp:HoldIntvl scalar:Enum8	holdIntvl (cdp:Inst:holdIntvl) The interval time that the CDP waits before aging out the neighbor information.
reference:BinRef	monPolDn (cdp:Inst:monPolDn) The monitoring policy for the CDP instance object.
nw:Counter32 scalar:Uint32	numCdpHifs (cdp:Inst:numCdpHifs) Number of HIF ports with CDP enabled
cdp:SysName string:Basic	sysName (cdp:Inst:sysName) A neighbor system name.
cdp:TxFreq scalar:Enum8	txFreq (cdp:Inst:txFreq) The transmission frequency of the CDP instance advertisements.
cdp:Ver scalar:Enum8	ver (cdp:Inst:ver) The CDP version supported by the device.

Defined in: nw:CpInst
nw:AdminSt scalar:Enum8	adminSt (nw:CpInst:adminSt) The administrative state of the object or policy.
nw:InstCtrl scalar:Bitmask64	ctrl (nw:CpInst:ctrl) The control state.
naming:Name string:Basic	name (nw:CpInst:name) Overrides:nw:Conn:name The name of the object.
nw:OperErrQual scalar:Bitmask64	operErr (nw:CpInst:operErr)

Defined in: mo:Resolvable
mo:Owner scalar:Enum8	lcOwn (mo:Resolvable:lcOwn) A value that indicates how this object was created. For internal use only.

Defined in: mo:TopProps
mo:ModificationChildAction scalar:Bitmask32	childAction (mo:TopProps:childAction) Delete or ignore. For internal use only.
reference:BinRef	dn (mo:TopProps:dn) A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN	rn (mo:TopProps:rn) Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus scalar:Bitmask32	status (mo:TopProps:status) The upgrade status. This property is for internal use only.

Defined in: mo:Modifiable
mo:TStamp scalar:Date	modTs (mo:Modifiable:modTs) The time when this object was last modified.

Properties Detail

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The administrative state of the object or policy.

Constants
enabled	1	Enabled	Enabled
disabled	2	Disabled	Disabled
DEFAULT	enabled(1)	Enabled	Enabled

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Comments:

Delete or ignore. For internal use only.

Constants
deleteAll	16384u	deleteAll	NO COMMENTS
ignore	4096u	ignore	NO COMMENTS
deleteNonPresent	8192u	deleteNonPresent	NO COMMENTS
DEFAULT	0	---	This type is used to

ctrl

Type: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The control state.

Constants
stateful-ha	1ull	stateful-ha	Enable stateful HA
DEFAULT	0	---	Instance controls

devIdType

Type: cdp:DevIdT
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The CDP instance device type ID to the remote peer.

Constants
mac	1	MAC address	MAC address
serialNum	2	Serial number	Serial number
sysName	3	System name	System name
DEFAULT	sysName(3)	System name	System name

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

Comments:

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

holdIntvl

Type: cdp:HoldIntvl
Primitive Type: scalar:Enum8

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The interval time that the CDP waits before aging out the neighbor information.

Constants
defaultValue	180	---	NO COMMENTS

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

A value that indicates how this object was created. For internal use only.

Constants
local	0	Local	NO COMMENTS
policy	1	Policy	NO COMMENTS
replica	2	Replica	NO COMMENTS
resolveOnBehalf	3	ResolvedOnBehalf	NO COMMENTS
implicit	4	Implicit	NO COMMENTS
DEFAULT	local(0)	Local	NO COMMENTS

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The time when this object was last modified.

Constants
never	0ull	never	NO COMMENTS
DEFAULT	never(0ull)	never	NO COMMENTS

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The monitoring policy for the CDP instance object.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular

Comments:

The name of the object.

numCdpHifs

Type: nw:Counter32
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

Comments:

Number of HIF ports with CDP enabled

operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

Comments:

Constants
sock-err	16ull	Socket error	Socket errors
init-err	1ull	Initialization error	Initialization errors
mem-err	2ull	Memory error	Memory errors
proto-err	32ull	Protocol error	Protocol errors
ipc-err	4ull	IPC error	IPC errors
int-err	8ull	Internal error	Internal errors
DEFAULT	0	---	Operational error qualifier

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

Comments:

Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

Comments:

The upgrade status. This property is for internal use only.

Constants
created	2u	created	In a setter method: specifies that an object should be created. An error is returned if the object already exists. In the return value of a setter method: indicates that an object has been created.
modified	4u	modified	In a setter method: specifies that an object should be modified In the return value of a setter method: indicates that an object has been modified.
deleted	8u	deleted	In a setter method: specifies that an object should be deleted. In the return value of a setter method: indicates that an object has been deleted.
DEFAULT	0	---	This type controls the life cycle of objects passed in the XML API. When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed. In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed. When invoking a setter method, the ModificationStatus is optional: If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.

sysName

Type: cdp:SysName
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

Comments:

A neighbor system name.

txFreq

Type: cdp:TxFreq
Primitive Type: scalar:Enum8

Units: sec
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The transmission frequency of the CDP instance advertisements.

Constants
defaultValue	60	---	NO COMMENTS

ver

Type: cdp:Ver
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Comments:

The CDP version supported by the device.

Constants
v1	1	Version 1	version 1
v2	2	Version 2	version 2
DEFAULT	v2(2)	Version 2	version 2

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail