Cisco System Model: Classcoop:VpcRec

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class coop:VpcRec (CONCRETE)

Class ID:2600
Class Label: Vpc Record
Encrypted: false - Exportable: false - Persistent: false - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The Virtual Port Channel (VPC) records.

Naming Rules

RN FORMAT: r-{swId}-r-{portId}

    [1] PREFIX=r- PROPERTY = swId


    [2] PREFIX=-r- PROPERTY = portId




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/coop/inst/dom-{name}/db-{type}/r-{swId}-r-{portId}

[1] sys/coop/inst/dom-{name}/db-{type}/r-{swId}-r-{portId}

Diagram
Super Mo: coop:CoopRec, Container Mos: coop:Db (deletable:no), Contained Mos: coop:VpcNodeRec,

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...

├

coop:Entity The COOP control plane entity information.

├

coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.

├

coop:Dom Per COOP domain (vrf) information.

├

coop:Db An abstraction of the COOP database (repository).

├

coop:VpcRec The Virtual Port Channel (VPC) records.

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

├

├

coop:Entity The COOP control plane entity information.

├

coop:Inst The per-COOP instance information. There is only one instance of this object present in the system.

├

coop:Dom Per COOP domain (vrf) information.

├

coop:Db An abstraction of the COOP database (repository).

├

coop:VpcRec The Virtual Port Channel (VPC) records.

Contained Hierarchy

coop:VpcRec The Virtual Port Channel (VPC) records.

├

coop:VpcNodeRec Per-node in the Virtual Port Channel (VPC) configuration record.

Inheritance

nw:Item Ignore.

├

nw:Conn A connection abstraction.

├

nw:GEp A group endpoint abstraction.

├

nw:DbRec An abstraction of a database record.

├

l3:DbRec A database record abstraction.

├

coop:Rec The abstraction for the COOP database record.

├

coop:CoopRec The COOP records.

├

coop:VpcRec The Virtual Port Channel (VPC) records.

Events

Faults

Fsms

Properties Summary

Defined in: coop:VpcRec
coop:AttachmentType scalar:Enum8	attachmentType (coop:VpcRec:attachmentType) AttachmentType
coop:NodeLocation scalar:Enum8	location (coop:VpcRec:location) Location
coop:PortId scalar:Uint32	portId (coop:VpcRec:portId) The VPC domain assigned by the fabric to this VPC.
coop:PubId address:IPv4	pubId (coop:VpcRec:pubId) Publisher id
coop:SwId address:IPv4	swId (coop:VpcRec:swId) The virtual switch TEP IP assigned by the fabric to the VPC.

Defined in: coop:CoopRec
coop:DampPenalty scalar:Uint16	dampPenalty (coop:CoopRec:dampPenalty) The penalty score for multiple rapid publishing of records.
coop:Timestamp scalar:Date	lastDampen (coop:CoopRec:lastDampen) The last timestamp at which the dampening policy was enforced due to the dampen penalty exceeding the threshold.
coop:Timestamp scalar:Date	lastPub (coop:CoopRec:lastPub) A timestamp indicating the last time a record was published by the client.
coop:Timestamp scalar:Date	recordTs (coop:CoopRec:recordTs)

Defined in: nw:DbRec
naming:Name string:Basic	name (nw:DbRec:name) Overrides:nw:Conn:name The name of the object.

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

attachmentType

Type: coop:AttachmentType
Primitive Type: scalar:Enum8

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

Comments:

AttachmentType

Constants
local	0	Local	Local to Fabric
ipn	1	ipn	Remote to Fabric Via IPN
wan	2	wan	Remote to Fabric Via WAN
DEFAULT	local(0)	Local	Local to Fabric

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

dampPenalty

Type: coop:DampPenalty
Primitive Type: scalar:Uint16

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

Comments:

The penalty score for multiple rapid publishing of records.

Constants
defaultValue	1000	---	NO COMMENTS

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.

lastDampen

Type: coop:Timestamp
Primitive Type: scalar:Date

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

Comments:

The last timestamp at which the dampening policy was enforced due to the dampen penalty exceeding the threshold.

lastPub

Type: coop:Timestamp
Primitive Type: scalar:Date

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

Comments:

A timestamp indicating the last time a record was published by the client.

location

Type: coop:NodeLocation
Primitive Type: scalar:Enum8

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

Comments:

Location

Constants
local	0	Local	Local to Fabric
Remote	1	Remote	Remote to Fabric
DEFAULT	local(0)	Local	Local to Fabric

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

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

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

Comments:

The name of the object.

portId

Type: coop:PortId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular

Comments:

The VPC domain assigned by the fabric to this VPC.

Constants
defaultValue	0u	---	NO COMMENTS

pubId

Type: coop:PubId
Primitive Type: address:IPv4

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

Comments:

Publisher id

recordTs

Type: coop:Timestamp
Primitive Type: scalar:Date

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

Comments:

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.

swId

Type: coop:SwId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular

Comments:

The virtual switch TEP IP assigned by the fabric to the VPC.

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail