Cisco System Model: Classipv4:Addr

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class ipv4:Addr (CONCRETE)

Class ID:3792
Class Label: Ipv4 Address
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l3, access-protocol-l3, admin, fabric-connectivity-l3, fabric-protocol-l3, tenant-connectivity-l3, tenant-ext-connectivity-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: true ]

An interface address.

Naming Rules

RN FORMAT: addr-{[addr]}

    [1] PREFIX=addr- PROPERTY = addr




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}

[1] sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}

Diagram
Super Mo: ip:Addr, Container Mos: ipv4:If (deletable:yes), Relations To: l3ext:IpDef, fv:IfConn, ip:RouteDef, Relations: ip:RsAddrToIpDef, ip:RsIpAddr, ip:RsRtDefIpAddr,

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

├

ipv4:Entity A container for IPV4 control plane entity information.

├

ipv4:Inst A container for IPV4 instance information.

├

ipv4:Dom The domain (VRF) information.

├

ipv4:If A container for IPV4 information that is operated at an interface level.

├

ipv4:Addr An interface address.

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

├

├

ipv4:Entity A container for IPV4 control plane entity information.

├

ipv4:Inst A container for IPV4 instance information.

├

ipv4:Dom The domain (VRF) information.

├

ipv4:If A container for IPV4 information that is operated at an interface level.

├

ipv4:Addr An interface address.

Contained Hierarchy

ipv4:Addr An interface address.

├

fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.

├

fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.

├

aaa:RbacAnnotation RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility

├

tag:Annotation

├

tag:Tag

├

health:Inst A base class for a health score instance.(Switch only)

├

ip:RsAddrToIpDef

├

ip:RsIpAddr A source relation to the connectivity parameters for an interface.

├

ip:RsRtDefIpAddr A source relation to route definitions.

Inheritance

ip:Addr The interface address.

├

ipv4:Addr An interface address.

Events
ipv4:Addr:ipv4_Addr_operStChange

Faults
ipv4:Addr:ipv4CfgCtrl ipv4:Addr:operStDown

Fsms

Properties Summary

Defined in: ipv4:Addr
address:Ip	addr (ipv4:Addr:addr) Overrides:ip:Addr:addr The peer IP address.
scalar:Bitmask64	ipv4CfgFailedBmp (ipv4:Addr:ipv4CfgFailedBmp)
scalar:Time	ipv4CfgFailedTs (ipv4:Addr:ipv4CfgFailedTs)
scalar:UByte	ipv4CfgState (ipv4:Addr:ipv4CfgState)
reference:BinRef	monPolDn (ipv4:Addr:monPolDn)

Defined in: ip:Addr
ip:AddrControl scalar:Bitmask64	ctrl (ip:Addr:ctrl) The control state.
ip:OperSt scalar:Enum8	operSt (ip:Addr:operSt)
ip:AddrOperStQual scalar:Enum8	operStQual (ip:Addr:operStQual)
rt:Preference scalar:UByte	pref (ip:Addr:pref)
rt:Tag scalar:Uint32	tag (ip:Addr:tag)
ip:AddrT scalar:Enum8	type (ip:Addr:type)
address:Ip	vpcPeer (ip:Addr:vpcPeer)

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:Modifiable
mo:TStamp scalar:Date	modTs (mo:Modifiable:modTs) The time when this object was last modified.

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.

Properties Detail

addr

Type: address:Ip

Overrides:ip:Addr:addr

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

Comments:

The peer IP address.

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: ip:AddrControl
Primitive Type: scalar:Bitmask64

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

Comments:

The control state.

Constants
anycast	131072ull	Anycast	Anycast
disable-dad	16ull	Disable dad	DAD disable
pervasive	1ull	Pervasive address	Pervasive
fabric-aware	2ull	Fabric aware	Fabric aware
preferred-subnet	4ull	Preferred subnet	Preferred subnet
eui64	65536ull	EUI64	EUI64
virtual	8ull	Virtual	Virtual
DEFAULT	0	---	Address controls

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.

ipv4CfgFailedBmp

Type: scalar:Bitmask64

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

Comments:

Constants
ipv4:AddrlcOwn_failed_flag	-9223372036854775808ull	---	NO COMMENTS
ipv4:AddrvpcPeer_failed_flag	128ull	---	NO COMMENTS
ipv4:Addrpref_failed_flag	16ull	---	NO COMMENTS
ipv4:Addraddr_failed_flag	1ull	---	NO COMMENTS
ipv4:AddrmonPolDn_failed_flag	2048ull	---	NO COMMENTS
ipv4:AddrmodTs_failed_flag	2305843009213693952ull	---	NO COMMENTS
ipv4:Addrctrl_failed_flag	2ull	---	NO COMMENTS
ipv4:Addrtag_failed_flag	32ull	---	NO COMMENTS
ipv4:Addrtype_failed_flag	64ull	---	NO COMMENTS
DEFAULT	0	---	NO COMMENTS

ipv4CfgFailedTs

Type: scalar:Time

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

Comments:

ipv4CfgState

Type: scalar:UByte

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

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:

operSt

Type: ip:OperSt
Primitive Type: scalar:Enum8

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

Comments:

Constants
unspecified	0	Unspecified	Unspecified
down	1	Down	The state is down
up	2	Up	The state is up
failed	3	Failed	The state is fail
DEFAULT	up(2)	Up	The state is up

operStQual

Type: ip:AddrOperStQual
Primitive Type: scalar:Enum8

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

Comments:

Constants
unspecified	0	Unspecified	Unspecified
up	1	Up	Up
subnet-overlap	2	Subnet overlap	Subnet overlap error
no-primary	3	No primary address	No primary address
if-down	4	Interface down	Interface down
addr-exists	5	Address already exists	Address exists
invalid-vrf	6	Context invalid	Invalid vrf
static-rt-nh	7	Configured as static-rt nh	Invalid vrf
lb-addr	8	Loopback address	Invalid use of loopback
invalid-ll-use	9	Invalid use of link local	Invalid use of link local
no-glbl-addr	10	No global address	Link local without global address
no-ll-addr	11	No link local address	Global without link local address
dad-in-progress	12	DAD in progress	DAD in progress
dad-failed	13	DAD failed	DAD failed
invalid-mask-len	14	Invalid maks length	Invalid mask len
l2-intf-err	15	IP cfg not allowed on L2 intf	Not allowed on L2 interface
super-intf-err	16	IP cfg not allowed on superintf	Not allowed on superinterface
invalid-ll	17	Invalid link local address	Invalid link local address
if-init-err	18	IF init error	IF init error
ifindex-err	19	Failed to get ifindex	IFindex error
invalid-eui64	20	Invalid EUI64 format	Invalid EUI64
lladdr-create-fail	21	Failed to create Link Local Addr.	Failed to create Link Local Addr
DAD-tentative	22	DAD failed, state=tentative.	DAD state tentative
DAD-lcl-duplicate	23	DAD failed, state=local duplicate.	DAD state local duplicate
DAD-duplicate	24	DAD failed, state=duplicate.	DAD state duplicate
DAD-preferred	25	DAD failed, state=preferred.	DAD state preferred
DAD-deprecated	26	DAD failed, state=deprecated.	DAD state deprecated
DAD-invalid	27	DAD failed, state=invalid.	DAD state invalid
internal-cfg-err	28	Internal configuration error.	Internal Config error
no-subnet	29	Subnet does not exist.	No subnet
preferred-subnet-exists	30	Preferred subnet already exists.	Peferred subnet exists
DEFAULT	unspecified(0)	Unspecified	Unspecified

pref

Type: rt:Preference
Primitive Type: scalar:UByte

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

Comments:

Constants
defaultValue	0	---	NO 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.

tag

Type: rt:Tag
Primitive Type: scalar:Uint32

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

Comments:

Constants
defaultValue	0u	---	NO COMMENTS

type

Type: ip:AddrT
Primitive Type: scalar:Enum8

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

Comments:

Constants
primary	1	Primary	Primary
secondary	2	Secondary	Secondary
DEFAULT	primary(1)	Primary	Primary

vpcPeer

Type: address:Ip

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

Comments:

Overview

Naming

Diagram

Containers

Contained

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail