Class vns:AL4L7ServiceFault (ABSTRACT)

Class ID:4849
Class Label: Abstract Base for Attaching Faults
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: [admin, nw-svc-device]
Read Access: [admin, nw-svc-device]
Creatable/Deletable: derived (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 ]

An abstract base class for attaching faults on service managed objects.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: naming:NamedObject,
Sub Mos: vns:ACCfg, vns:ALDevIf, vns:AVRoutingDeviceCfg, vns:AVRoutingVEncapAsc, vns:CDev, vns:DevConfIssue, vns:DevHealth, vns:DevItem, vns:VDev, vns:VDevDomainRefCont, vns:VFunc, vns:VGrp, vns:VGrpP,


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:ACCfg Contains a hierarchy of folders and parameters similar to AMItem.
 
 
 ├
[V] vns:ACCfgRel Abstract config parameter relation
 
 
 
 ├
[V] vns:AbsCfgRel The folder/param relations added to an abstract graph.
 
 
 
 ├
[V] vns:CRel A concrete relation.
 
 
 
 ├
[V] vns:CfgRelInst A folder instance configured by the administrator.
 
 
 
 ├
[V] vns:GRel A graph instance folder/parameter relation.
 
 
 ├
[V] vns:AFolder Contains folder configuration parameters.
 
 
 
 ├
[V] vns:AbsFolder A folder added to an abstract graph. An abstract graph folder can contain an abstract graph folder (AbsFolder) and abstract node parameters (AbsParam), which are analogous to an MFolder and MParam. An abstract graph folder can be contained under abstract device configuration (AbsDevCfg), abstract group configuration (AbsGrpCfg), or abstract function configuration (AbsFuncCfg).
 
 
 
 ├
[V] vns:FolderInst A folder instance configured by the administrator.
 
 
 
 ├
[V] vns:GFolder A graph instance folder.
 
 
 ├
[V] vns:AParam A configuration parameter
 
 
 
 ├
[V] vns:AbsParam The abstract node parameters. This is contained by the folder added to the abstract graph (AbsFolder).
 
 
 
 ├
[V] vns:GParam NodeInst contains a copy of the abstract parameter from the abstract graph.
 
 
 
 ├
[V] vns:ParamInst A parameter instance configured by the administrator.
 
 
 ├
[V] vns:CFolder A concrete configuration parameter folder.
 
 
 ├
[V] vns:CParam A concrete configuration parameter.
 
 ├
[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] vns:LDevVip An L4-L7 device cluster is represented by a single virtual IP (VIP). The configuration is pushed down to the VIP address.
 
 
 ├
[V] vns:LDevIf The logical device interface is a proxy object in the tenant that points to the logical device. This is used when the device cluster is defined in a common tenant and other tenants want to use the service provided by this device cluster.
 
 ├
[V] vns:AVRoutingDeviceCfg 
 
 
 ├
[V] vns:VBgpDevCfg 
 
 
 ├
[V] vns:VOspfDevCfg 
 
 ├
[V] vns:AVRoutingVEncapAsc 
 
 
 ├
[V] vns:VBgpVEncapAsc 
 
 
 ├
[V] vns:VOspfVEncapAsc 
 
 ├
[V] vns:CDev The individual service device is used to define a concrete l4-l7 service device.
 
 ├
[V] vns:DevConfIssue 
 
 ├
[V] vns:DevHealth The health of a service device, typically from 0 (poor) to 100 (good).
 
 ├
[V] vns:DevItem An abstract class used to represent the concrete classes that store configuration information for concrete device association and that represent a configuration parameter for the service device.
 
 
 ├
[V] vns:DevFolder A container to hold device specific configuration items.
 
 
 ├
[V] vns:DevParam An object used to represent a configuration parameter for the service device. For example, the type of load balancing algorithm to use when configuring a server load balancer or the enable/disable option for the application inspection of ICMP packets in a firewall.
 
 ├
[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 ├
[V] vns:VDevDomainRefCont 
 
 ├
[V] vns:VFunc A virtual function is a single function on a service device such as a firewall, a load balancer, or an SSL offloading device.
 
 ├
[V] vns:VGrp A grouping of virtual functions in a single graph allows virtual functions on a service device to be combined without traffic egressing from the device.
 
 ├
[V] vns:VGrpP  pending VGrp updates


Events
                


Faults
                vns:AL4L7ServiceFault:serviceCriticalFault
vns:AL4L7ServiceFault:serviceMajorFault
vns:AL4L7ServiceFault:serviceMinorFault
vns:AL4L7ServiceFault:serviceWarningFault


Fsms
                


Properties Summary
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

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





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.





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



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.