Class edm:NicProf (CONCRETE)

Class ID:12657
Class Label: External Device Manager NIC Profile
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Explicit
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

External Switch Controller Profile specifies how to connect to a single External Switch Management Controller that is part of containing policy enforcement domain. For example, policy to connect a Cisco UCSM that is part a External Device Manager Group.

Naming Rules
RN FORMAT: nicprof-{[externalId]}

    [1] PREFIX=nicprof- PROPERTY = externalId




DN FORMAT: 

[0] edm/Mgr-{[groupName]}-{name}/nicprof-{[externalId]}

                


Diagram

Super Mo: edm:ANicProf,
Container Mos: edm:Mgr (deletable:yes),
Contained Mos: edm:NicProfToDom, tag:AInst,
Relations From: edm:ServerNic,
Relations To: edm:EncapDef, infra:ADomP,
Relations: edm:RsEncapDef, edm:RsExtDevDomP, edm:RtNicProf,


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] edm:Uni  This is the top level class for all external device related objects
 
 ├
[V] edm:Mgr  This profile corresponds to External Manager, i.e. UCSM, supporting the JSON/REST Schema fore external Devices
 
 
 ├
[V] edm:NicProf  External Switch Controller Profile specifies how to connect to a single External Switch Management Controller that is part of containing policy enforcement domain. For example, policy to connect a Cisco UCSM that is part a External Device Manager Group.


Contained Hierarchy
[V] edm:NicProf  External Switch Controller Profile specifies how to connect to a single External Switch Management Controller that is part of containing policy enforcement domain. For example, policy to connect a Cisco UCSM that is part a External Device Manager Group.
 ├
[V] edm:NicProfToDom 
 
 ├
[V] edm:RtToNicProfToDom  Association NicPrfToDom
 
 ├
[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] edm:RsEncapDef  Association to Single Encap
 
 ├
[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: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] tag:AInst The label instance, which is contained by the taggable object.
 
 
 ├
[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 
 ├
[V] edm:RsExtDevDomP 
 
 ├
[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: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] tag:AInst The label instance, which is contained by the taggable object.
 
 
 ├
[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 
 ├
[V] edm:RtNicProf  Server NICs can be associated to a NIC Profile - but not required Marking this as 1-to-m for future scnearios where a Server NIC can associate to multiple NIC Profiles, i.e. for example - multiple VMM Domains
 ├
[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] tag:AInst The label instance, which is contained by the taggable object.
 
 ├
[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] 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] edm:Entity 
 
 
 ├
[V] edm:Element  This is the top level class for all external device related objects
 
 
 
 ├
[V] edm:ANicProf 
 
 
 
 
 ├
[V] edm:NicProf  External Switch Controller Profile specifies how to connect to a single External Switch Management Controller that is part of containing policy enforcement domain. For example, policy to connect a Cisco UCSM that is part a External Device Manager Group.


Events
                


Faults
                edm:NicProf:nicprofileMissing


Fsms
                


Properties Summary
Defined in: edm:NicProf
scalar:Bool externFound  (edm:NicProf:externFound)
           NO COMMENTS
string:Basic externalId  (edm:NicProf:externalId)
           Overrides:edm:ANicProf:externalId
           NO COMMENTS
reference:BinRef faultDKey  (edm:NicProf:faultDKey)
           Delegate faults to the User Configured MOs
reference:BinRef monPolDn  (edm:NicProf:monPolDn)
           The monitoring policy attached to this observable object.
l1:Mtu
          scalar:Uint32
operMtu  (edm:NicProf:operMtu)
           Operational Mtu
scalar:Bool userConfigured  (edm:NicProf:userConfigured)
           NO COMMENTS
Defined in: edm:ANicProf
naming:Name
          string:Basic
name  (edm:ANicProf:name)
           Overrides:edm:Entity:name | naming:NamedObject:name
           The name of the object.
Defined in: edm:Entity
naming:Descr
          string:Basic
descr  (edm:Entity:descr)
           The description of this configuration item.
naming:Id
          scalar:Uint64
id  (edm:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           An object identifier.
edm:Issues
          scalar:Bitmask64
issues  (edm:Entity:issues)
           General Issues It captures various issues happened to the Entity.
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           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

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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
    Comments:
The description of this configuration item.



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.



externFound

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





externalId

Type: string:Basic

Overrides:edm:ANicProf:externalId
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
NO COMMENTS



faultDKey

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Delegate faults to the User Configured MOs



id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:naming:NamedIdentifiedObject:id
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
An object identifier.



issues

Type: edm:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
vpn-pull-fault 0x1000ull Error in pulling VPNs from remote vManage Device NO COMMENTS
sla-statspull-fault 0x100ull Error in pulling SLA Stats NO COMMENTS
nicprof-config-fault 0x10ull Error configuring NIC Profiles on Integration Manager NO COMMENTS
connection-fault 0x1ull Failed to connect with Integration Manager NO COMMENTS
sla-dscp-fault 0x2000ull Error in pushing SLA DSCP mapping to remote vManage Device NO COMMENTS
sla-polpull-fault 0x200ull Error in pulling SLA Policies NO COMMENTS
uplinkprof-config-fault 0x20ull Error configuring Uplink Profiles on Integration Manager NO COMMENTS
nicprof-missing-fault 0x2ull Configured NIC Profile does not exist on Integration Manager NO COMMENTS
create-vpn-list-fault 0x4000ull VPN list not configured on remote vManage Device NO COMMENTS
sla-policies-not-configured-fault 0x400ull SLA Policies are not configured on remote vManage Device NO COMMENTS
partner-registration-fault 0x40ull Error registering APIC as partner NO COMMENTS
uplinkprof-missing-fault 0x4ull Configured Uplink Profile does not exist on Integration Manager NO COMMENTS
create-prefix-mapping-fault 0x8000ull Prefix Mapping not configured on remote vManage Device NO COMMENTS
create-prefix-list-fault 0x800ull Prefix list not configured on remote vManage Device NO COMMENTS
sla-config-fault 0x80ull Error in pushing SLA NO COMMENTS
encap-config-fault 0x8ull Error configuring Encaps on Integration Manager NO COMMENTS
DEFAULT none(0x0ull) None NO COMMENTS





lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





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:edm:Entity:name  |  naming:NamedObject:name
Units: null Encrypted: false Access: implicit 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



operMtu

Type: l1:Mtu
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Operational Mtu
Constants
defaultValue 9000u --- 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.






userConfigured

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS