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

Class ospfv3:Dom (CONCRETE)

Class ID:5822
Class Label: OSPF Domain
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-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
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: true, HasHealth: true, HasEventRules: false ]

The OSPF domain (VRF) information.

Naming Rules 
RN FORMAT: dom-{name}

    [1] PREFIX=dom- PROPERTY = name




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/ospfv3/inst-{name}/dom-{name}

[1] sys/ospfv3/inst-{name}/dom-{name}


Diagram

Super Mo: ospf:ADom,
Container Mos: ospfv3:Inst (deletable:no),
Contained Mos: ospfv3:Area, ospfv3:Db, ospfv3:DomAf, ospfv3:DomStats, ospfv3:Gr, ospfv3:If, ospfv3:LsaCtrl, ospfv3:MaxLsaP, ospfv3:SpfComp, ospfv3:TrafficStats,
Relations To: ipsec:StSecAssoc,
Relations: ospfv3:RsDomSecAssocAtt,


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] ospfv3:Entity The OSPFV3 control plane entity information.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospfv3:Inst The per OSPF instance information.
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospfv3:Dom The OSPF domain (VRF) 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] ospfv3:Entity The OSPFV3 control plane entity information.
 
 		 
 		 ├
 		[V] ospfv3:Inst The per OSPF instance information.
 
 		 
 		 
 		 ├
 		[V] ospfv3:Dom The OSPF domain (VRF) information.


Contained Hierarchy
[V] ospfv3:Dom The OSPF domain (VRF) 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] 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] ospfv3:Area The OSPF information that is operated at an interface level.
 
 		 ├
 		[V] ospfv3:AreaAf The per address family OSPFv3 area information.
 
 		 
 		 ├
 		[V] ospfv3:DefRtLeakP The default route leak policy.
 
 		 
 		 
 		 ├
 		[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] ospfv3:InterAreaRtSum The inter-area route summarization, which is configured on ABRs, summarizing routes between areas in the autonomous 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] ospfv3:LsaLeakCtrlP  Lsa Leak Control concrete class.
 
 		 
 		 
 		 ├
 		[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] ospfv3:LsaLeakP The link-state advertisement leak concrete class.
 
 		 
 		 
 		 ├
 		[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] ospfv3:AreaStats The OSPF area related statistics.
 
 		 ├
 		[V] ospfv3:Db The OSPF databases.
 
 		 
 		 ├
 		[V] ospfv3:LsaRec The LSA records information.
 
 		 
 		 ├
 		[V] ospfv3:Route The internal OSPF routes in the OSPF RIB (Routing Information Base).
 
 		 
 		 
 		 ├
 		[V] ospfv3:McNexthop The OSPF Multicast Nexthop information.
 
 		 
 		 
 		 ├
 		[V] ospfv3:UcNexthop The unicast nexthop information.
 
 		 ├
 		[V] ospfv3:RsAreaSecAssocAtt  ipsec SA
 ├
 		[V] ospfv3:Db The OSPF databases.
 
 		 ├
 		[V] ospfv3:LsaRec The LSA records information.
 
 		 ├
 		[V] ospfv3:Route The internal OSPF routes in the OSPF RIB (Routing Information Base).
 
 		 
 		 ├
 		[V] ospfv3:McNexthop The OSPF Multicast Nexthop information.
 
 		 
 		 ├
 		[V] ospfv3:UcNexthop The unicast nexthop information.
 ├
 		[V] ospfv3:DomAf The OSPF address family domain (VRF) information.
 
 		 ├
 		[V] ospfv3:DefRtLeakP The default route leak policy.
 
 		 
 		 ├
 		[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] ospfv3:ExtRtSum The external route summarization, which is specific to external routes that are injected into OSPF using route leak. Configure external route summarization on ASBRs that are leaking routes into OSPF.
 
 		 
 		 ├
 		[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] ospfv3:InterLeakP The inter protocol route leak policy, which defines the distribution of routes from other protocols to OSPF.
 
 		 
 		 ├
 		[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] ospfv3:LeakCtrlP The leak controls that determine the number of routes leaked.
 
 		 
 		 ├
 		[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] ospfv3:RibLeakP 
 ├
 		[V] ospfv3:DomStats The OSPF domain related statistics.
 ├
 		[V] ospfv3:Gr The OSPF domain related statistics.
 
 		 ├
 		[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] ospfv3:If An OSPF interface.
 
 		 ├
 		[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] nw:RtPathToIf A target relation to the interface information.
 
 		 ├
 		[V] ospfv3:AdjEp The neighbor 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] 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] ospfv3:AdjStats The OSPFV3 neighborship statistics.
 
 		 
 		 ├
 		[V] ospfv3:GrSt The OSPF graceful restart operational information.
 
 		 ├
 		[V] ospfv3:Db The OSPF databases.
 
 		 
 		 ├
 		[V] ospfv3:LsaRec The LSA records information.
 
 		 
 		 ├
 		[V] ospfv3:Route The internal OSPF routes in the OSPF RIB (Routing Information Base).
 
 		 
 		 
 		 ├
 		[V] ospfv3:McNexthop The OSPF Multicast Nexthop information.
 
 		 
 		 
 		 ├
 		[V] ospfv3:UcNexthop The unicast nexthop information.
 
 		 ├
 		[V] ospfv3:IfStats The OSPF interface related statistics.
 
 		 ├
 		[V] ospfv3:RsIfSecAssocAtt  ipsec SA
 
 		 ├
 		[V] ospfv3:RtIfDefToOspfv3If A target relation to OSPF information that is operated at a interface level.
 
 		 ├
 		[V] ospfv3:TrafficStats The OSPF domain traffic statistics.
 ├
 		[V] ospfv3:LsaCtrl The LSA-related frequency control information.
 
 		 ├
 		[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] ospfv3:MaxLsaP The per domain max-lsa 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] 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] ospfv3:RsDomSecAssocAtt  ipsec SA
 ├
 		[V] ospfv3:SpfComp The SPF computation frequency controls information.
 
 		 ├
 		[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] ospfv3:TrafficStats The OSPF domain traffic statistics.


Inheritance
[V] nw:Item Ignore.
 ├
 		[V] nw:Conn A connection abstraction.
 
 		 ├
 		[V] nw:GEp A group endpoint abstraction.
 
 		 
 		 ├
 		[V] nw:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.
 
 		 
 		 
 		 ├
 		[V] nw:ProtDom A protocol domain abstraction.
 
 		 
 		 
 		 
 		 ├
 		[V] l3:ProtDom A layer 3 protocol domain abstraction.
 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospf:ADom An abstraction of an OSPF domain (VRF).
 
 		 
 		 
 		 
 		 
 		 
 		 ├
 		[V] ospfv3:Dom The OSPF domain (VRF) information.


Events


Faults 
                ospf:ADom:MaxEcmpExceeded


Fsms


Properties Summary
Defined in: ospfv3:Dom
reference:BinRef monPolDn  (ospfv3:Dom:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic 		name  (ospfv3:Dom:name)
           Overrides:nw:CpDom:name | nw:Conn:name
           The name of the OSPFv3 domain.
Defined in: ospf:ADom
ospf:BwRef
          scalar:Uint32 		bwRef  (ospf:ADom:bwRef)
           The ISIS domain bandwidth reference. This property sets the default reference bandwidth used for calculating the ISIS cost metric.
ospf:DomControl
          scalar:Bitmask8 		ctrl  (ospf:ADom:ctrl)
           The control state.
ospf:Dist
          scalar:UByte 		dist  (ospf:ADom:dist)
           The preferred ISIS Domain level administrative distance.
ospf:EcmpOperSt
          scalar:Enum8 		ecmpOperSt  (ospf:ADom:ecmpOperSt)
           Operational State of Max ECMP
ospf:FailStQual
          scalar:Bitmask64 		failStQual  (ospf:ADom:failStQual)
           The OSPF domain failed state qualifier.
ospf:DomFlags
          scalar:Bitmask16 		flags  (ospf:ADom:flags)
           The IP address flags.
ospf:Ecmp
          scalar:UByte 		maxEcmp  (ospf:ADom:maxEcmp)
           The maximum number of equal-cost paths for BGP load sharing.
ospf:OperSt
          scalar:Enum8 		operSt  (ospf:ADom:operSt)
           The runtime state of the object or policy.
ip:RtrId
          address:IPv4 		rtrId  (ospf:ADom:rtrId)
           The BGP router ID.
rtmap:RouteTag
          scalar:Uint32 		selfAdvRtTag  (ospf:ADom:selfAdvRtTag)
           NO COMMENTS
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.
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.
Properties Detail

bwRef

Type: ospf:BwRef
Primitive Type: scalar:Uint32

Units: Mbps
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The ISIS domain bandwidth reference. This property sets the default reference bandwidth used for calculating the ISIS cost metric.
Constants
defaultValue 40000u --- 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




ctrl

Type: ospf:DomControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
pfx-suppress 1 Prefix suppression Prefix suppression
name-lookup 2 Enable name lookup for router IDs name loopup
defaultValue 0 --- NO COMMENTS




dist

Type: ospf:Dist
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The preferred ISIS Domain level administrative distance.
Constants
defaultValue 110 --- 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.


ecmpOperSt

Type: ospf:EcmpOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational State of Max ECMP
Constants
ok 0 ok Operating normally
thresh-exceeded 1 Threshold Exceeded Threshold exceeded
DEFAULT ok(0) ok Operating normally




failStQual

Type: ospf:FailStQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The OSPF domain failed state qualifier.
Constants
unspecified 0ull Unspecified Unspecified
ipc-error 16ull IPC error IPC error
init-error 1ull Initialization error Initialization error
ha-error 2ull HA error HA error
rib-error 32ull RIB programming error RIB error
proto-error 4ull Protocol error Protocol error
mtu-mismatch 64ull Mtu Mismatch config error MTU-Mismatch
mem-error 8ull Memory error Memory error
DEFAULT unspecified(0ull) Unspecified Unspecified




flags

Type: ospf:DomFlags
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The IP address flags.
Constants
unspecified 0 Unspecified Unspecified
abr-self 1 ABR self Local node is ABR
asbr-self 2 ASBR self Local node is ASBR
DEFAULT unspecified(0) Unspecified Unspecified




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




maxEcmp

Type: ospf:Ecmp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The maximum number of equal-cost paths for BGP load sharing.
Constants
defaultValue 8 --- 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:
The monitoring policy attached to this observable object.


name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:CpDom:name  |  nw:Conn:name

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
    Comments:
The name of the OSPFv3 domain.


operSt

Type: ospf:OperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
down 0 Down The state is down
up 1 Up The state is up
failed 2 Failed The state is fail
DEFAULT up(1) Up The state is up




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.


rtrId

Type: ip:RtrId
Primitive Type: address:IPv4

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The BGP router ID.


selfAdvRtTag

Type: rtmap:RouteTag
Primitive Type: scalar:Uint32

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




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