Class health:UpdateDelegateHealthPayload (CONCRETE)

Class ID:5446
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, fabric-equipment, fabric-protocol-ops, fabric-protocol-util, ops, tenant-connectivity-mgmt, tenant-connectivity-util]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]



Naming Rules
RN FORMAT: udhp-{[deliveryDn]}

    [1] PREFIX=udhp- PROPERTY = deliveryDn




DN FORMAT: 

                


Diagram

Super Mo: frmwrk:ARelDelCont,


Containers Hierarchies


Contained Hierarchy
[V] health:UpdateDelegateHealthPayload 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Cont Represents entities that contain policy definitions.
 
 
 ├
[V] frmwrk:ARelDelCont 
 
 
 
 ├
[V] health:UpdateDelegateHealthPayload 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: health:UpdateDelegateHealthPayload
reference:BinRef deliveryDn  (health:UpdateDelegateHealthPayload:deliveryDn)
           Overrides:frmwrk:ARelDelCont:deliveryDn
          
scalar:Bool isExisting  (health:UpdateDelegateHealthPayload:isExisting)
          
health:NodeId
          scalar:Uint32
nodeId  (health:UpdateDelegateHealthPayload:nodeId)
           The ID of the IFC, leaf, or spine from which the core file was uploaded.
reference:BinRef observableDn  (health:UpdateDelegateHealthPayload:observableDn)
          
fault:SvcId
          scalar:Uint32
ownerSvcId  (health:UpdateDelegateHealthPayload:ownerSvcId)
           NO COMMENTS
fabric:PodId
          scalar:UByte
podId  (health:UpdateDelegateHealthPayload:podId)
           The POD identifier.
ident:ShardId
          scalar:UByte
shardId  (health:UpdateDelegateHealthPayload:shardId)
           The shard from which the export job was executed.
fault:TermId
          scalar:Uint64
termId  (health:UpdateDelegateHealthPayload:termId)
           NO COMMENTS
health:Weight
          scalar:Uint32
weight  (health:UpdateDelegateHealthPayload:weight)
           The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.
Defined in: frmwrk:ARelDelCont
scalar:Uint64 timestamp  (frmwrk:ARelDelCont:timestamp)
           This is generated and used only by internal processes.
frmwrk:MonitoringMessageType
          scalar:Enum8
type  (frmwrk:ARelDelCont:type)
           The specific type of the object or component.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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: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

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





deliveryDn

Type: reference:BinRef

Overrides:frmwrk:ARelDelCont:deliveryDn
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    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.



isExisting

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO 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





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular
    Comments:
null



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

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



nodeId

Type: health:NodeId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The ID of the IFC, leaf, or spine from which the core file was uploaded.



observableDn

Type: reference:BinRef

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



ownerSvcId

Type: fault:SvcId
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 0u --- NO COMMENTS





podId

Type: fabric:PodId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The POD identifier.
Constants
defaultValue 1 --- 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.



shardId

Type: ident:ShardId
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The shard from which the export job was executed.



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.






termId

Type: fault:TermId
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 0ull --- NO COMMENTS





timestamp

Type: scalar:Uint64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
This is generated and used only by internal processes.



type

Type: frmwrk:MonitoringMessageType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
unknown 0 unknown NO COMMENTS
fault-process 1 fault-process NO COMMENTS
fault-delegate 2 fault-delegate NO COMMENTS
fault-cleanup 3 fault-cleanup NO COMMENTS
fault-ack 4 fault-ack NO COMMENTS
rel-log 5 rel-log NO COMMENTS
threshold-fault 6 threshold-fault NO COMMENTS
health-score 7 health-score NO COMMENTS
control 8 control NO COMMENTS
health-score-weight 9 health-score-weight NO COMMENTS
DEFAULT unknown(0) unknown NO COMMENTS





weight

Type: health:Weight
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The weight of the fault in calculating the health score of an object. A higher weight causes a higher degradation of the health score of the affected object.
Constants
undefined 0xFFFFFFF0u Undefined NO COMMENTS
DEFAULT 0 --- NO COMMENTS