Cisco System Model: Classfv:AEpDef

Overview

Diagram

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail

Class fv:AEpDef (ABSTRACT)

Class ID:2050
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: []
Read Access: [admin, tenant-protocol-l2]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

Abstract representation of an endpoint definition.

Naming Rules
DN FORMAT:

Diagram
Super Mo: fv:Ep, Sub Mos: fv:ATunDef, fv:EpDef, fv:EpDefRef, fv:L3EpDef, Relations From: span:AVDest, span:AVSrc, Relations To: comp:Hv, fv:DomDef, fv:PrimaryEncapDef, comp:Nic, comp:Vm, Relations: fv:RsHyper, fv:RsToFvDomDef, fv:RsToFvPrimaryEncapDef, fv:RsToNic, fv:RsToVm, fv:RtDestToVPort, fv:RtSrcToVPort,

Inheritance

naming:NamedObject An abstract base class for an object that contains a name.

├

naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.

├

fv:NwEp Abstract super class.

├

fv:ATp The attachable target point.

├

fv:Ep An endpoint.

├

fv:AEpDef Abstract representation of an endpoint definition.

├

fv:ATunDef The base class for an internal definition of a tunnel.

├

fv:TunDef A tunnel definition.

├

fv:TunDefRef A tunnel on the node. This is an internal object.

├

fv:EpDef An endpoint definition.

├

fv:EpDefRef An internal reference to endpoint definitions.

├

fv:L3EpDef

Events

Faults

Fsms

Properties Summary

Defined in: fv:AEpDef
fv:ClassPref scalar:Enum8	classPref (fv:AEpDef:classPref) Classification preference for this EPG within a domain encap: the class-id is dervied based on packet encapsulation (e.g Vlan/VxLAN id) useg: class-id is derived based on other useg/EPGs or dynamically learned mac address in VMM.
reference:BinRef	host (fv:AEpDef:host) The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.
reference:BinRef	nic (fv:AEpDef:nic)
scalar:Uint64	txId (fv:AEpDef:txId) Indicates the identifier of the transaction in which the user action occurred.
reference:BinRef	vm (fv:AEpDef:vm)
fv:VmmSrc scalar:Bitmask8	vmmSrc (fv:AEpDef:vmmSrc) NO COMMENTS

Defined in: fv:ATp
base:Encap	encap (fv:ATp:encap) The encapsulation (VXLAN or VLAN) to be used for this context.
address:Ip	ip (fv:ATp:ip) The IP address.
fv:LcC scalar:Bitmask8	lcC (fv:ATp:lcC) How this entity's lifecycle is created, deleted, or modified.
address:MAC	mac (fv:ATp:mac) The MAC address.
string:Basic	uuid (fv:ATp:uuid) The endpoint UUID

Defined in: naming:NamedIdentifiedObject
naming:Id scalar:Uint64	id (naming:NamedIdentifiedObject:id) An identifier .

Defined in: naming:NamedObject
naming:Name string:Basic	name (naming:NamedObject:name) The name of the object.
naming:NameAlias string:Basic	nameAlias (naming:NamedObject:nameAlias) NO COMMENTS

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

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

classPref

Type: fv:ClassPref
Primitive Type: scalar:Enum8

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

Comments:

Classification preference for this EPG within a domain encap: the class-id is dervied based on packet encapsulation (e.g Vlan/VxLAN id) useg: class-id is derived based on other useg/EPGs or dynamically learned mac address in VMM.

Constants
encap	0	Packet Encapsulation	NO COMMENTS
useg	1	uSeg	NO COMMENTS
DEFAULT	encap(0)	Packet Encapsulation	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.

encap

Type: base:Encap

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

Comments:

The encapsulation (VXLAN or VLAN) to be used for this context.

host

Type: reference:BinRef

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

Comments:

The hostname or IP for export destination. Call Home sends email messages to either the IP address or hostname, and the associated port number.

id

Type: naming:Id
Primitive Type: scalar:Uint64

Like: naming:Identified:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:

An identifier .

ip

Type: address:Ip

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

Comments:

The IP address.

lcC

Type: fv:LcC
Primitive Type: scalar:Bitmask8

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

Comments:

How this entity's lifecycle is created, deleted, or modified.

Constants
vmm	1	vmm	instanciated by a trigger from corresponding VMM domain
learned	2	learned	learned through network protocol magic
static	4	static	statically configured by admin
dynamic	8	dynamic	dynamically detected through special HV signalling
802-dot-1x	16	802-dot-1x	802.1x authentication Ep
poe	32	poe	Power Over Ethernet Ep
DEFAULT	0	---	Life Cycle Control specifies how this entity (EP)'s Lifecycle is controlled: created, deleted, modified

mac

Type: address:MAC

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

Comments:

The MAC address.

name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:

The name of the object.

nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+

Comments:

NO COMMENTS

nic

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
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.

txId

Type: scalar:Uint64

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

Comments:

Indicates the identifier of the transaction in which the user action occurred.

uuid

Type: string:Basic

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

Comments:

The endpoint UUID

vm

Type: reference:BinRef

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

Comments:

vmmSrc

Type: fv:VmmSrc
Primitive Type: scalar:Bitmask8

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

Comments:

NO COMMENTS

Constants
ignored	0	ignored	ignored
dvs	1	dvs	dynamically detected through opflex signalling from DVS
avs	2	avs	dynamically detected through opflex signalling from AVS
msft	4	msft	dynamically detected through opflex signalling from Microsoft VS
ovs	8	ovs	dynamically detected through opflexp signalling from OVS
k8s	16	k8s	NO COMMENTS
cf	32	cf	NO COMMENTS
openshift	64	openshift	NO COMMENTS
ave	128	ave	NO COMMENTS
DEFAULT	ignored(0)	ignored	ignored

Overview

Diagram

Inheritance

Events

Faults

FSMs

Properties Summary

Properties Detail