Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class vns:ALDev (ABSTRACT)

Class ID:4872
Class Label: Logical Device Instance
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, nw-svc-policy]
Read Access: [admin, nw-svc-policy, tenant-connectivity]
Creatable/Deletable: yes (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

A service device cluster.

Naming Rules 


DN FORMAT: 

[1] uni/tn-{name}/


Diagram

Super Mo: vns:ALDevIf,
Sub Mos: cloud:ALDev, cloud:CDevDef, cloud:LDevDef, vns:LDevVip,
Container Mos: fv:Tenant (deletable:yes),
Contained Mos: tag:AInst, vns:CDev, vns:ConfIssue, vns:LIf, vns:MgmtLIf,
Relations From: dbgac:ExtToEp, dbgac:IpToEpg, vns:VDev, vns:LDevCtx, vns:LDevOperInfo, vns:LDevIf, vns:AbsNode, dbgac:EpToExt, dbgac:EpgToIp, pol:DefRelnHolder,
Relations To: vns:DevMgr, vmm:DomP, phys:DomP, fvns:VlanInstP, fvns:VxlanInstP, fv:EPg, vns:MDev,
Relations: vns:RsALDevToDevMgr, vns:RsALDevToDomP, vns:RsALDevToPhysDomP, vns:RsALDevToVlanInstP, vns:RsALDevToVxlanInstP, vns:RsDevEpg, vns:RsMDevAtt, vns:RsSvcMgmtEpg, vns:RtFromLDevForExtToEp, vns:RtFromLDevForIpToEpg, vns:RtLDevAtt, vns:RtLDevCtxToLDev, vns:RtLDevOperInfoToALDev, vns:RtLdevIfToLDev, vns:RtNodeToLDev, vns:RtToLDevForEpToExt, vns:RtToLDevForEpgToIp, vns:RtVnsldev,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
 		[V] vns:AL4L7ServiceFault An abstract base class for attaching faults on service managed objects.
 
 		 ├
 		[V] vns:ALDevIf An abstract object used to represent either a service device cluster or a proxy object for a logical device cluster in the tenant.
 
 		 
 		 ├
 		[V] vns:ALDev A service device cluster.
 
 		 
 		 
 		 ├
 		[V] cloud:ALDev 
 
 		 
 		 
 		 
 		 ├
 		[V] cloud:LB 
 
 		 
 		 
 		 
 		 ├
 		[V] cloud:LDev 
 
 		 
 		 
 		 ├
 		[V] cloud:CDevDef 
 
 		 
 		 
 		 ├
 		[V] cloud:LDevDef 
 
 		 
 		 
 		 ├
 		[V] vns:LDevVip An L4-L7 device cluster is represented by a single virtual IP (VIP). The configuration is pushed down to the VIP address.


Events


Faults 
                vns:ALDev:ConfMismatch

                vns:AL4L7ServiceFault:serviceCriticalFault

                vns:AL4L7ServiceFault:serviceMajorFault

                vns:AL4L7ServiceFault:serviceMinorFault

                vns:AL4L7ServiceFault:serviceWarningFault


Fsms


Properties Summary
Defined in: vns:ALDev
scalar:Bool activeActive  (vns:ALDev:activeActive)
           NO COMMENTS
string:Basic configInfo  (vns:ALDev:configInfo)
          
vns:ConfIssuesType
          scalar:Bitmask64 		configIssues  (vns:ALDev:configIssues)
           The configuration issues occurred. If an issue has occurred, the value returned indicates the type of issue.
vns:ConfSt
          scalar:Enum8 		configSt  (vns:ALDev:configSt)
           The configuration state of the device. The configuration may not yet have been applied, is in the process of being applied, has already been applied, or has failed to apply.
vns:ContextAware
          scalar:Enum8 		contextAware  (vns:ALDev:contextAware)
           A value to determine if the L4-L7 device cluster supports multiple contexts (VRFs).
string:Basic devModel  (vns:ALDev:devModel)
           NO COMMENTS
vns:LDevType
          scalar:Enum8 		devtype  (vns:ALDev:devtype)
          
vns:NodeFuncType
          scalar:Enum8 		funcType  (vns:ALDev:funcType)
           The function type of the L4-L7 device cluster.
scalar:Bool isCopy  (vns:ALDev:isCopy)
           if the device is a copy device
scalar:Bool managed  (vns:ALDev:managed)
           Specified if the device is a managed device
vns:MgmtInterfaceType
          scalar:Enum8 		mgmtType  (vns:ALDev:mgmtType)
          
vns:Mode
          scalar:Enum8 		mode  (vns:ALDev:mode)
           The value for specifying if the device is legacy (classical VLAN/VXLAN) or supports service tag switching (STS).
string:Basic packageModel  (vns:ALDev:packageModel)
           NO COMMENTS
scalar:Bool promMode  (vns:ALDev:promMode)
           The status of promiscuous mode support status for port groups in an external VMM controller, such as a Vcenter.This needs to be turned on only for service devices in the cloud, not for Enterprise AVE service deployments.
vns:L4L7SvcType
          scalar:Enum8 		svcType  (vns:ALDev:svcType)
           UI Template type
scalar:Bool trunking  (vns:ALDev:trunking)
           For virtual devices, if a trunking port group is to be used
Defined in: vns:AL4L7ServiceFault
scalar:Uint32 faultCode  (vns:AL4L7ServiceFault:faultCode)
           The code corresponding to a service fault. The code characterizes information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.
string:Basic faultMessage  (vns:AL4L7ServiceFault:faultMessage)
           The message returned with a service fault. The message provides descriptive information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.
condition:Severity
          scalar:Enum8 		faultSeverity  (vns:AL4L7ServiceFault:faultSeverity)
           The severity of a service fault. The fault may be reported while updating a configuration or polling for health or counter values.
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

activeActive

Type: scalar:Bool

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




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




configInfo

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:


configIssues

Type: vns:ConfIssuesType
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The configuration issues occurred. If an issue has occurred, the value returned indicates the type of issue.
Constants
ok 0ull ok NO COMMENTS
invalid-config 0x1000000000000000ull Configuration of this device contains errors NO COMMENTS
cif-missing-virtual-info 0x100000000000000ull Virtual Object like vnic name is missing in CIf NO COMMENTS
cdev-missing-virtual-info 0x10000000000000ull Virtual Object Info like Vcenter name and VM name is missing in CDev NO COMMENTS
invalid-mfolder 0x1000000000000ull FolderInst points to an invalid MFolder NO COMMENTS
missing-ldev-ctx 0x100000000000ull No device context found for LDev NO COMMENTS
missing-function-node 0x10000000000ull Service graph template missing function node. NO COMMENTS
missing-cif 0x1000000000ull Device interfaces does not match cluster. NO COMMENTS
invalid-devctx 0x100000000ull Device context is not valid for this folder. NO COMMENTS
missing-lif 0x10000000ull no cluster interface found NO COMMENTS
missing-bd 0x1000000ull no bd found NO COMMENTS
invalid-rsmconnatt 0x100000ull Invalid RsMConnAtt MO which points to connector NO COMMENTS
internal-error 0x10000ull internal error occured during graph processing.` NO COMMENTS
invalid-param-config 0x1000ull invalid param config NO COMMENTS
function-type-mismatch-failure 0x100ull invalid function type NO COMMENTS
missing-l3instp 0x10ull no L3InstP found NO COMMENTS
invalid-abstract-graph-config 0x1ull invalid abstract graph config NO COMMENTS
invalid-devcfg-folder 0x2000000000000000ull DevCfg folder has invalid configuration parameters. NO COMMENTS
invalid-filter-referred-by-rsconntoflt 0x200000000000000ull AbsGraph connector is pointing to an invalid filter. NO COMMENTS
invalid-relation-target 0x20000000000000ull Relation target parameter could not be resolved. NO COMMENTS
invalid-namespace-allocation-mode 0x2000000000000ull VlanInstP has invalid allocation mode: static. Allocation mode should be dynamic. NO COMMENTS
arp-flood-enabled 0x200000000000ull ARP flood is enabled on the management end point group NO COMMENTS
graph-loop-detected 0x20000000000ull Service graph template configuration is invalid. It has a loop NO COMMENTS
ldevvip-missing-mgmt-ip 0x2000000000ull No Mgmt ip found for LDevVip NO COMMENTS
insufficient-devctx 0x200000000ull Folder must have one value for each associated CDev. NO COMMENTS
invalid-absfunc-profile 0x20000000ull Service graph template function profile config is invalid. NO COMMENTS
missing-terminal 0x2000000ull Terminal node is missing a terminal NO COMMENTS
cdev-missing-mgmt-ip 0x200000ull no mgmt ip found for cdev NO COMMENTS
resource-allocation-failure 0x20000ull resource could not be allocated during graph processing NO COMMENTS
invalid-param-scope 0x2000ull invalid parameter scope NO COMMENTS
invalid-abstract-graph-config-param 0x200ull invalid abstract graph config param NO COMMENTS
id-allocation-failure 0x20ull id allocation failure NO COMMENTS
missing-mandatory-param 0x2ull mandatory param not found NO COMMENTS
gothru-same-bd 0x4000000000000000ull Both the legs of go through node are attached to same BD NO COMMENTS
missing-mdev 0x400000000000000ull No device type found. LDevVip must be associated with an MDev. NO COMMENTS
invalid-conn-for-configparam 0x40000000000000ull Config param is using an invalid graph connector. NO COMMENTS
devfolder-validation-failed 0x4000000000000ull DevFolder has key, that is not found in MFolder NO COMMENTS
folderinst-validation-failed 0x400000000000ull FolderInst has key, that is not found in MFolder NO COMMENTS
gothrough-routing-enabled-both 0x40000000000ull Both the legs of go through node has routing enabled NO COMMENTS
lif-has-invalid-interface-label 0x4000000000ull LIf has an invalid MifLbl NO COMMENTS
cdev-missing-cif 0x400000000ull No interface defined. It must have at least one interface defined NO COMMENTS
missing-cdev 0x40000000ull No device found in cluster. NO COMMENTS
missing-namespace 0x4000000ull no vlan/vxlan namespace found NO COMMENTS
invalid-graphinst 0x400000ull Graphinst config is invalid NO COMMENTS
missing-abs-function 0x40000ull no abstract function definition found NO COMMENTS
invalid-ldev 0x4000ull Invalid cluster NO COMMENTS
missing-mparam 0x400ull No parameter definition found NO COMMENTS
missing-ldev 0x40ull No cluster found NO COMMENTS
param-cardinality-error 0x4ull invalid param cardinality NO COMMENTS
relinst-validation-failed 0x8000000000000000ull CfgRelInst has key and/or value, that are not found in MParam NO COMMENTS
missing-l3ctx 0x800000000000000ull No L3 Context found for the graph connection NO COMMENTS
invalid-connection 0x80000000000000ull AbsGraph Connection is invalid. NO COMMENTS
devparam-validation-failed 0x8000000000000ull DevParam has key and/or value, that are not found in MParam NO COMMENTS
paraminst-validation-failed 0x800000000000ull ParamInst has key and/or value, that are not found in MParam NO COMMENTS
invalid-terminal-nodes 0x80000000000ull Service graph template must have two or more terminal nodes NO COMMENTS
lif-invalid-CIf 0x8000000000ull LIf has an invalid CIf NO COMMENTS
cdev-missing-path-for-interface 0x800000000ull Missing path for interface. NO COMMENTS
inappropriate-devfolder 0x80000000ull Illegal folder in configuration. NO COMMENTS
missing-function-in-device-package 0x8000000ull No function found in device package NO COMMENTS
missing-interface 0x800000ull no interface found NO COMMENTS
param-validation-failed 0x80000ull param value is invalid NO COMMENTS
missing-config-params 0x8000ull GraphInst does not have any configuration parameters. It should have at least one valid configuration parameter. NO COMMENTS
missing-abs-graph 0x800ull no abs graph found NO COMMENTS
context-cardinality-violation-failure 0x80ull invalid cluster context cardinality NO COMMENTS
epp-download-failure 0x8ull epp download failure NO COMMENTS
DEFAULT ok(0ull) ok NO COMMENTS




configSt

Type: vns:ConfSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The configuration state of the device. The configuration may not yet have been applied, is in the process of being applied, has already been applied, or has failed to apply.
Constants
none 0 none NO COMMENTS
applying 1 applying NO COMMENTS
applied 2 applied NO COMMENTS
failed-to-apply 3 failed-to-apply NO COMMENTS
DEFAULT none(0) none NO COMMENTS




contextAware

Type: vns:ContextAware
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A value to determine if the L4-L7 device cluster supports multiple contexts (VRFs).
Constants
single-Context 0 Single NO COMMENTS
multi-Context 1 Multiple NO COMMENTS
DEFAULT single-Context(0) Single NO COMMENTS




devModel

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS


devtype

Type: vns:LDevType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
PHYSICAL 0 PHYSICAL NO COMMENTS
VIRTUAL 1 VIRTUAL NO COMMENTS
CLOUD 2 CLOUD NO COMMENTS
DEFAULT PHYSICAL(0) PHYSICAL 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.


faultCode

Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The code corresponding to a service fault. The code characterizes information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.


faultMessage

Type: string:Basic

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
The message returned with a service fault. The message provides descriptive information about the fault. The fault may be reported while updating a configuration or polling for health or counter values.


faultSeverity

Type: condition:Severity
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
    Comments:
The severity of a service fault. The fault may be reported while updating a configuration or polling for health or counter values.
Constants
cleared 0 cleared The Cleared severity level indicates the clearing of one or more previously reported alarms. This alarm clears all alarms for this managed object that have the same Alarm type, Probable cause and Specific problems (if given). Multiple associated notifications may be cleared by using the Correlated notifications parameter (defined below).
info 1 info NO COMMENTS
warning 2 warning The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.
minor 3 minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.
major 4 major The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.
critical 5 critical The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.
DEFAULT minor(3) minor The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.




funcType

Type: vns:NodeFuncType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The function type of the L4-L7 device cluster.
Constants
None 0 None NO COMMENTS
GoTo 1 GoTo NO COMMENTS
GoThrough 2 GoThrough NO COMMENTS
L2 3 L2 NO COMMENTS
L1 4 L1 NO COMMENTS
DEFAULT GoTo(1) GoTo NO COMMENTS




isCopy

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
if the device is a copy device
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




managed

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Specified if the device is a managed device
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS




mgmtType

Type: vns:MgmtInterfaceType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
inband 0 inband NO COMMENTS
inbandklm 1 inbandklm NO COMMENTS
oob 2 oob NO COMMENTS
DEFAULT oob(2) oob NO COMMENTS




mode

Type: vns:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The value for specifying if the device is legacy (classical VLAN/VXLAN) or supports service tag switching (STS).
Constants
legacy-Mode 0 Classic NO COMMENTS
DEFAULT legacy-Mode(0) Classic NO COMMENTS




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


packageModel

Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "512"
    Comments:
NO COMMENTS


promMode

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
The status of promiscuous mode support status for port groups in an external VMM controller, such as a Vcenter.This needs to be turned on only for service devices in the cloud, not for Enterprise AVE service deployments.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.





svcType

Type: vns:L4L7SvcType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
UI Template type
Constants
ADC 1 ADC NO COMMENTS
FW 2 Firewall NO COMMENTS
OTHERS 3 Other NO COMMENTS
COPY 4 Copy NO COMMENTS
NATIVELB 5 NativeLB NO COMMENTS
DEFAULT OTHERS(3) Other NO COMMENTS




trunking

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
For virtual devices, if a trunking port group is to be used
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail