Class dhcp:Ep (CONCRETE)

Class ID:1447
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [admin, tenant-epg, tenant-network-profile]
Read Access: [admin, tenant-epg, tenant-network-profile]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: EPG, Fabric,
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The DHCP Discovered Endpoint.

Naming Rules
RN FORMAT: dhcpopt-{name}

    [1] PREFIX=dhcpopt- PROPERTY = name




DN FORMAT: 

[1] uni/tn-{name}/ap-{name}/esg-{name}/cep-{name}/dhcpopt-{name}

[3] uni/tn-{name}/Tnlepg-{name}/cep-{name}/dhcpopt-{name}

[5] uni/ldev-{[priKey]}-ctx-{[ctxDn]}-bd-{[bdDn]}/cep-{name}/dhcpopt-{name}

[7] uni/tn-{name}/LDevInst-{[priKey]}-ctx-{ctxName}/G-{graphRn}-N-{nodeRn}-C-{connRn}/cep-{name}/dhcpopt-{name}

[9] uni/vDev-{[priKey]}-tn-{[tnDn]}-ctx-{ctxName}/rndrInfo/eppContr/G-{graphRn}-N-{nodeRn}-C-{connRn}/cep-{name}/dhcpopt-{name}

[11] uni/tn-{name}/ctx-{name}/cep-{name}/dhcpopt-{name}

[13] uni/tn-{name}/ap-{name}/epg-{name}/cep-{name}/dhcpopt-{name}

[15] uni/tn-{name}/l2out-{name}/instP-{name}/cep-{name}/dhcpopt-{name}

                


Diagram

Super Mo: pol:Obj,
Container Mos: fv:CEp (deletable:no),
Contained Mos: aaa:RbacAnnotation, tag:Annotation, tag:Tag,


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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] fv:Ap The application profile is a set of requirements that an application instance has on the virtualizable fabric. The policy regulates connectivity and visibility among endpoints within the scope of the policy.
 
 
 
 
 
 
 
 
 ├
[V] fv:ESg 
 
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] fv:Ap The application profile is a set of requirements that an application instance has on the virtualizable fabric. The policy regulates connectivity and visibility among endpoints within the scope of the policy.
 
 
 
 ├
[V] fv:ESg 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] fv:TnlEPg  qinq End Point Group
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] fv:TnlEPg  qinq End Point Group
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] vns:SDEPpInfo 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] vns:SDEPpInfo 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] vns:LDevInst The local state in the object that reuses encaps across graphs with the same subnet. This is an internal object.
 
 
 
 
 
 
 
 
 ├
[V] vns:EPpInfo Internal object to store encap info (vlan ID) for an endpoint.
 
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] vns:LDevInst The local state in the object that reuses encaps across graphs with the same subnet. This is an internal object.
 
 
 
 ├
[V] vns:EPpInfo Internal object to store encap info (vlan ID) for an endpoint.
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 
 
 
 
 
 
 ├
[V] vns:RndrInfo An internal object that stores rendered graph information.
 
 
 
 
 
 
 
 
 ├
[V] vns:EPpContr A container to hold endpoint profile objects.
 
 
 
 
 
 
 
 
 
 ├
[V] vns:EPpInfo Internal object to store encap info (vlan ID) for an endpoint.
 
 
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] vns:VDev A collection of groups that can share parts of their configuration. This object is implicit.
 
 
 ├
[V] vns:RndrInfo An internal object that stores rendered graph information.
 
 
 
 ├
[V] vns:EPpContr A container to hold endpoint profile objects.
 
 
 
 
 ├
[V] vns:EPpInfo Internal object to store encap info (vlan ID) for an endpoint.
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] fv:Ctx The private layer 3 network context that belongs to a specific tenant or is shared.
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] fv:Ctx The private layer 3 network context that belongs to a specific tenant or is shared.
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] fv:Ap The application profile is a set of requirements that an application instance has on the virtualizable fabric. The policy regulates connectivity and visibility among endpoints within the scope of the policy.
 
 
 
 
 
 
 
 
 ├
[V] fv:AEPg A set of requirements for the application-level EPG instance. The policy regulates connectivity and visibility among the end points within the scope of the policy.
 
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] fv:Ap The application profile is a set of requirements that an application instance has on the virtualizable fabric. The policy regulates connectivity and visibility among endpoints within the scope of the policy.
 
 
 
 ├
[V] fv:AEPg A set of requirements for the application-level EPG instance. The policy regulates connectivity and visibility among the end points within the scope of the policy.
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] ctx:Local The local Context.
 
 
 
 
 ├
[V] ctx:Application The context application.
 
 
 
 
 
 ├
[V] pol:Uni Represents policy definition/resolution universe.
 
 
 
 
 
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 
 
 
 
 
 ├
[V] l2ext:Out The L2 outside policy controls connectivity to the outside.
 
 
 
 
 
 
 
 
 ├
[V] l2ext:InstP The external network instance profile represents a group of external subnets that have the same security behavior. These subnets inherit contract profiles applied to the parent instance profile. Each subnet can also associate to route control profiles, which defines the routing behavior for that subnet.
 
 
 
 
 
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.
[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] pol:Uni Represents policy definition/resolution universe.
 
 ├
[V] fv:Tenant A policy owner in the virtual fabric. A tenant can be either a private or a shared entity. For example, you can create a tenant with contexts and bridge domains shared by other tenants. A shared type of tenant is typically named common, default, or infra.
 
 
 ├
[V] l2ext:Out The L2 outside policy controls connectivity to the outside.
 
 
 
 ├
[V] l2ext:InstP The external network instance profile represents a group of external subnets that have the same security behavior. These subnets inherit contract profiles applied to the parent instance profile. Each subnet can also associate to route control profiles, which defines the routing behavior for that subnet.
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.


Contained Hierarchy
[V] dhcp:Ep The DHCP Discovered Endpoint.
 ├
[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] 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] tag:Annotation 
 ├
[V] tag:Tag 


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] dhcp:Ep The DHCP Discovered Endpoint.


Events
                dhcp:Ep:creation__dhcp_Ep
dhcp:Ep:modification__dhcp_Ep
dhcp:Ep:deletion__dhcp_Ep


Faults
                


Fsms
                


Properties Summary
Defined in: dhcp:Ep
scalar:Bool ack  (dhcp:Ep:ack)
           Indicates the acknowledgement status of this Ep. If an is acknowledged, it is immediately deleted. If a fault is not acknowledged and cleared, it is deleted after the retention interval.
address:Ip addr  (dhcp:Ep:addr)
           Client IP address that was assigned by DHCP server
mo:Annotation
          string:Basic
annotation  (dhcp:Ep:annotation)
           NO COMMENTS
mo:ExtMngdByType
          scalar:Bitmask32
extMngdBy  (dhcp:Ep:extMngdBy)
           NO COMMENTS
address:MAC mac  (dhcp:Ep:mac)
           Client MAC address
naming:Name
          string:Basic
name  (dhcp:Ep:name)
           Overrides:pol:Obj:name | naming:NamedObject:name
           OPTION NAME
fabric:NodeId
          scalar:Uint16
nodeId  (dhcp:Ep:nodeId)
           null
reference:BinRef port  (dhcp:Ep:port)
           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:Ownable
scalar:Uint16 uid  (mo:Ownable:uid)
           A unique identifier for this object.
mo:UserDomType
          string:Basic
userdom  (mo:Ownable:userdom)
           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.
Properties Detail

ack

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Indicates the acknowledgement status of this Ep. If an is acknowledged, it is immediately deleted. If a fault is not acknowledged and cleared, it is deleted after the retention interval.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





addr

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Client IP address that was assigned by DHCP server



annotation

Type: mo:Annotation
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
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





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.



extMngdBy

Type: mo:ExtMngdByType
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
undefined 0u undefined NO COMMENTS
msc 1u msc NO COMMENTS
DEFAULT undefined(0u) undefined 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





mac

Type: address:MAC

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Client MAC address



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:pol:Obj:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular Property Validators: Range: min: "1" max: "64"
    Comments:
OPTION NAME



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



nodeId

Type: fabric:NodeId
Primitive Type: scalar:Uint16

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





port

Type: reference:BinRef

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



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.






uid

Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A unique identifier for this object.



userdom

Type: mo:UserDomType
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
NO COMMENTS
Constants
defaultValue "all" --- NO COMMENTS