Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class qosm:Entity (CONCRETE)

Class ID:2393
Class Label: QoS Entity
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-qos, admin]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: true ]

A policy container for QoS related entity information.

Naming Rules 
RN FORMAT: qosm

    [1] PREFIX=qosm


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/qosm

[1] sys/qosm


Diagram

Super Mo: nw:CpEntity,
Container Mos: top:System (deletable:no),
Contained Mos: qosm:Class, qosm:GlobalEgressMplsRule, qosm:GlobalIngressMplsRule, qosm:If, qosp:Class, qosp:Dot1pRule, qosp:DscpRule, qosp:EgressMplsRule, qosp:InfraDscpMap, qosp:IngressMplsRule, qosp:IpRule,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		[V] fabric:Topology The root for IFC topology.
 
 		 ├
 		[V] fabric:Pod A pod.
 
 		 
 		 ├
 		[V] fabric:Node The root node for the APIC.
 
 		 
 		 
 		 ├
 		[V] 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...
 
 		 
 		 
 		 
 		 ├
 		[V] qosm:Entity A policy container for QoS related entity information.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		[V] 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...
 
 		 ├
 		[V] qosm:Entity A policy container for QoS related entity information.


Contained Hierarchy
[V] qosm:Entity A policy container for QoS related entity information.
 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] qosm:Class A QoS policy.
 ├
 		[V] qosm:GlobalEgressMplsRule  Qos classification rules based on dscp values for traffic towards MPLS
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[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] 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.
 
 		 
 		 ├
 		[V] 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
 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] qosm:GlobalIngressMplsRule  Qos classification rules based on Exp values
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[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] 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.
 
 		 
 		 ├
 		[V] 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
 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 ├
 		[V] qosm:If A QoS interface. This object holds information about QoS at an interface level.
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 ├
 		[V] qosm:IfClass A container for information about QoS operated at a per port per class level.
 
 		 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 
 		 ├
 		[V] 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.
 
 		 
 		 
 		 ├
 		[V] 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
 
 		 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 
 		 ├
 		[V] qosm:QStatDirection 
 
 		 
 		 
 		 ├
 		[V] qosm:QStatType 
 
 		 ├
 		[V] qosp:InfraDscpMap  Qos class to DSCP marking policy for multipod and remote tor
 
 		 
 		 ├
 		[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] qosp:Class A container for the QoS fabric class policy. Each class describes QoS attributes such as MTU.
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[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] 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.
 
 		 
 		 ├
 		[V] 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
 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 ├
 		[V] qosp:Buffer The buffering information of a class, such as the minimum buffer required for a class, which is applied at system level.
 
 		 
 		 ├
 		[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] qosp:Cong A container for the congestion policy. This container holds information that describes the congestion parameters of the class such as ECN, WRED, and Tail-drop. These congestion parameters are applied at per class-level in the system.
 
 		 
 		 ├
 		[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] qosp:PrioFlowCtrl 
 
 		 
 		 ├
 		[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] qosp:Queue A container for the queue management policy. This container holds information that describes the queue threshold parameters, such as the management method, which are applied at a per-class basis in the system.
 
 		 
 		 ├
 		[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] qosp:Sched A container for the schedule policy. This container holds information that describes the bandwidth and scheduling algorithm (Strict priority or WRR), which are applied at a per-class basis in the system.
 
 		 
 		 ├
 		[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] qosp:Dot1pRule The QoS classification rules based on dot1p values.
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[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] 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.
 
 		 
 		 ├
 		[V] 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
 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 ├
 		[V] qosp:RtDot1pRuleAtt A target relation to the set of Dot1p rules.
 
 		 ├
 		[V] qosp:RtL3dot1pRuleAtt  Relation to the set of Dot1P rules
 ├
 		[V] qosp:DscpRule The QoS classification rules based on DSCP values.
 
 		 ├
 		[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 		 ├
 		[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] 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.
 
 		 
 		 ├
 		[V] 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
 
 		 
 		 ├
 		[V] tag:Annotation 
 
 		 
 		 ├
 		[V] tag:Tag 
 
 		 ├
 		[V] health:Inst A base class for a health score instance.(Switch only)
 
 		 ├
 		[V] qosp:RtDscpRuleAtt A target relation to the set of DSCP rules.
 
 		 ├
 		[V] qosp:RtL3dscpRuleAtt  Relation to the set of DSCP rules
 ├
 		[V] qosp:EgressMplsRule  Qos classification rules based on dscp values for traffic towards MPLS
 
 		 ├
 		[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] qosp:RtEgressMplsRuleAtt  Relation to Egress MPLS rules
 ├
 		[V] qosp:InfraDscpMap  Qos class to DSCP marking policy for multipod and remote tor
 
 		 ├
 		[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] qosp:IngressMplsRule  Qos classification rules based on Exp values
 
 		 ├
 		[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] qosp:RtIngressMplsRuleAtt  Relation to Ingress MPLS rules
 ├
 		[V] qosp:IpRule The QoS classification rules based on IP values.
 
 		 ├
 		[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.


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:CpEntity The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.
 
 		 
 		 
 		 ├
 		[V] qosm:Entity A policy container for QoS related entity information.


Events 
                qosm:Entity:qosm_Entity_operErr

                qosm:Entity:qosm_Entity_adminStChange


Faults


Fsms


Properties Summary
Defined in: qosm:Entity
qosm:EtrapAgeOutPeriod
          scalar:Uint64 		EtrapAgeTimer  (qosm:Entity:EtrapAgeTimer)
           NO COMMENTS
qosm:EtrapBwThreshold
          scalar:Uint64 		EtrapBwThresh  (qosm:Entity:EtrapBwThresh)
           NO COMMENTS
qosm:EtrapByteCount
          scalar:Uint64 		EtrapByteCt  (qosm:Entity:EtrapByteCt)
           NO COMMENTS
qosm:EtrapEnState
          scalar:Bool 		EtrapSt  (qosm:Entity:EtrapSt)
           E-trap parameters
qosm:FabricFlushIntvl
          scalar:Uint16 		FabricFlushInterval  (qosm:Entity:FabricFlushInterval)
           Fabric Flush Interval
qosm:FabricFlushAdminSt
          scalar:Bool 		FabricFlushSt  (qosm:Entity:FabricFlushSt)
           Fabric PFC Flush Parameters
qosm:ctrl
          scalar:Bitmask32 		ctrl  (qosm:Entity:ctrl)
           The control state.
reference:BinRef monPolDn  (qosm:Entity:monPolDn)
          
Defined in: nw:CpEntity
nw:AdminSt
          scalar:Enum8 		adminSt  (nw:CpEntity:adminSt)
           The administrative state of the object or policy.
naming:Name
          string:Basic 		name  (nw:CpEntity:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64 		operErr  (nw:CpEntity:operErr)
          
nw:EntOperSt
          scalar:Enum8 		operSt  (nw:CpEntity:operSt)
           The runtime state of the object or policy.
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

EtrapAgeTimer

Type: qosm:EtrapAgeOutPeriod
Primitive Type: scalar:Uint64

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


EtrapBwThresh

Type: qosm:EtrapBwThreshold
Primitive Type: scalar:Uint64

Units: bytes per second
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
NO COMMENTS


EtrapByteCt

Type: qosm:EtrapByteCount
Primitive Type: scalar:Uint64

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


EtrapSt

Type: qosm:EtrapEnState
Primitive Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
E-trap parameters
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




FabricFlushInterval

Type: qosm:FabricFlushIntvl
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Fabric Flush Interval
Constants
defaultValue 500 --- NO COMMENTS




FabricFlushSt

Type: qosm:FabricFlushAdminSt
Primitive Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
Fabric PFC Flush Parameters
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS




adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled




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: qosm:ctrl
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The control state.
Constants
none 0u none Default value
dot1p-preserve 1u Dot1p Preserve Preserve dot1p within ACI
DEFAULT none(0u) none Default value




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.


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:


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
    Comments:
The name of the object.


operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
feature-unsupported 64ull Feature Unsupported Feature Unsupported
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier




operSt

Type: nw:EntOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 unknown Entity state unknown
enabled 1 enabled Entity enabled
disabled 2 disabled Entity disabled
initializing 3 initializing Entity initializing
failed 4 failed Entity enable failed
DEFAULT enabled(1) enabled Entity enabled




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.







Overview  Naming  Diagram  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail