Class fvtopo:Ep (CONCRETE)

Class ID:2105
Class Label: EndPoint
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, tenant-protocol-l2]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The endpoint.

Naming Rules
RN FORMAT: ep-{mac}

    [1] PREFIX=ep- PROPERTY = mac




DN FORMAT: 

[1] uni/epp/tnlp-{[epgPKey]}/epcont/ep-{mac}

[3] uni/epp/instp-{[epgPKey]}/epcont/ep-{mac}

[5] uni/epp/vns-{[epgPKey]}/epcont/ep-{mac}

[7] uni/epp/inb-{[epgPKey]}/epcont/ep-{mac}

[9] uni/epp/oob-{[epgPKey]}/epcont/ep-{mac}

[11] uni/epp/epcont/ep-{mac}

[13] uni/epp/fv-{[epgPKey]}/epcont/ep-{mac}

[15] uni/epp/rtd-{[epgPKey]}/epcont/ep-{mac}

[17] uni/epp/br-{[epgPKey]}/epcont/ep-{mac}

[19] uni/epp/epcont/ep-{mac}

[21] uni/epp/epcont/ep-{mac}

                


Diagram

Super Mo: fv:Ep,
Container Mos: fvtopo:EpCont (deletable:yes),
Relations From: span:AVDest, span:AVSrc, fvtopo:Port,
Relations To: comp:Hv, comp:Nic, comp:Vm,
Relations: fv:RsHyper, fv:RsToNic, fv:RsToVm, fv:RtDestToVPort, fv:RtSrcToVPort, fvtopo:RtEp,


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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:TnlEpP 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:TnlEpP 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:InstPEpP Instance Profile Management EpP for the Fabric Node Management EPG. This EpP is created per external management entity instance profile (InstP EPg).
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:InstPEpP Instance Profile Management EpP for the Fabric Node Management EPG. This EpP is created per external management entity instance profile (InstP EPg).
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:SvcEpP Abstract representation of a service endpoint profile, such as an endpoint profile created per node in the service graph.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:SvcEpP Abstract representation of a service endpoint profile, such as an endpoint profile created per node in the service graph.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:InBEpP An in-band management endpoint profile for a fabric node management endpoint group.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:InBEpP An in-band management endpoint profile for a fabric node management endpoint group.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:OoBEpP An out-of-band management endpoint profile for a fabric node management endpoint group.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:OoBEpP An out-of-band management endpoint profile for a fabric node management endpoint group.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:AMgmtEpP Abstract representation of the management endpoint policy for a fabric node management endpoint group. This is an abstract class and cannot be instantiated.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:AMgmtEpP Abstract representation of the management endpoint policy for a fabric node management endpoint group. This is an abstract class and cannot be instantiated.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:EpP An endpoint profile.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:EpP An endpoint profile.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:RtdEpP A target relation to an L3 routed outside present under a tenant.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:RtdEpP A target relation to an L3 routed outside present under a tenant.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:BrEpP The bridge endpoint profile represents L2 outside present under a tenant.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:BrEpP The bridge endpoint profile represents L2 outside present under a tenant.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:ExtEpP Abstraction of a profile created for an endpoint connected to an external router or switch.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:ExtEpP Abstraction of a profile created for an endpoint connected to an external router or switch.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 
 
 
 
 
 ├
[V] fv:AREpP Abstract representation of the resolvable endpoint profile. This is an abstract class and cannot be instantiated.
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 
 
 
 
 
 ├
[V] fvtopo:Ep The 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:EpPCont The container for an endpoint profile.
 
 
 ├
[V] fv:AREpP Abstract representation of the resolvable endpoint profile. This is an abstract class and cannot be instantiated.
 
 
 
 ├
[V] fvtopo:EpCont The container for all endpoints for a given endpoint protection platform.
 
 
 
 
 ├
[V] fvtopo:Ep The endpoint.


Contained Hierarchy
[V] fvtopo:Ep The endpoint.
 ├
[V] fv:RsHyper A source relation to the hypervisor that controls and monitors the APIC VMs. This is an internal object.
 
 ├
[V] fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.
 ├
[V] fv:RsToNic 
 
 ├
[V] fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.
 ├
[V] fv:RsToVm 
 
 ├
[V] fv:ReportingNode The node reporting a corresponding endpoint. This enables a user to see on which nodes the endpoints are present. This is an internally created object.
 ├
[V] fv:RtDestToVPort A target relation to an endpoint. This is an internal object.
 ├
[V] fv:RtSrcToVPort A target relation to a set of endpoints. This is an internal object.
 ├
[V] fvtopo:RtEp A target relation to the endpoint.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 ├
[V] fv:NwEp Abstract super class.
 
 
 ├
[V] fv:ATp The attachable target point.
 
 
 
 ├
[V] fv:Ep An endpoint.
 
 
 
 
 ├
[V] fvtopo:Ep The endpoint.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: fvtopo:Ep
address:MAC mac  (fvtopo:Ep:mac)
           Overrides:fv:ATp:mac
           The MAC address.
fvtopo:Type
          scalar:Bitmask8
type  (fvtopo:Ep:type)
           The specific type of the object or component.
Defined in: fv:ATp
base:Encap encap  (fv:ATp:encap)
           The encapsulation (VXLAN or VLAN) to be used for this context.
address:Ip ip  (fv:ATp:ip)
           The IP address.
fv:LcC
          scalar:Bitmask8
lcC  (fv:ATp:lcC)
           How this entity's lifecycle is created, deleted, or modified.
string:Basic uuid  (fv:ATp:uuid)
           The endpoint UUID
Defined in: naming:NamedIdentifiedObject
naming:Id
          scalar:Uint64
id  (naming:NamedIdentifiedObject:id)
           An identifier .
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: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





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.



encap

Type: base:Encap

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The encapsulation (VXLAN or VLAN) to be used for this context.



id

Type: naming:Id
Primitive Type: scalar:Uint64

Like: naming:Identified:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
An identifier .



ip

Type: address:Ip

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The IP address.



lcC

Type: fv:LcC
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
How this entity's lifecycle is created, deleted, or modified.
Constants
vmm 1 vmm instanciated by a trigger from corresponding VMM domain
learned 2 learned learned through network protocol magic
static 4 static statically configured by admin
dynamic 8 dynamic dynamically detected through special HV signalling
DEFAULT 0 --- Life Cycle Control specifies how this entity (EP)'s Lifecycle is controlled: created, deleted, modified





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

Overrides:fv:ATp:mac
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The 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

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    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.






type

Type: fvtopo:Type
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
VM 0 VM NO COMMENTS
static 1 static NO COMMENTS
DEFAULT VM(0) VM NO COMMENTS





uuid

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The endpoint UUID