Class vns:MFunc (CONCRETE)

Class ID:4753
Class Label: L4-L7 Service Function
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-connectivity-l1, admin, nw-svc-device, nw-svc-policy]
Creatable/Deletable: yes (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: false ]

The metadata for a single function on a device. A function contains a set of connectors and a function-specific configuration tree. This managed object contains the metadata for all such operations.

Naming Rules
RN FORMAT: mFunc-{name}

    [1] PREFIX=mFunc- PROPERTY = name




DN FORMAT: 

[1] uni/infra/mDev-{vendor}-{model}-{version}/mFunc-{name}

                


Diagram

Super Mo: vns:AMName,
Container Mos: vns:MDev (deletable:yes),
Contained Mos: vns:Assertion, vns:MConn, vns:MFeature, vns:MFolder, vns:MImage,
Relations From: vns:VFunc, vns:AbsNode, vns:AbsFuncProf,
Relations: vns:RtFunction, vns:RtNodeToMFunc, vns:RtProfToMFunc,


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] infra:Infra A container for all tenant infra configurations.
 
 
 
 
 
 
 
 ├
[V] vns:MDev Import a device package into the Application Policy Infrastructure Controller (APIC). The device package contains meta device type definition and definitions of the metadata for a service device type. The metadata contains vendor-specific data including the vendor name, device model, and device version.
 
 
 
 
 
 
 
 
 ├
[V] vns:MFunc The metadata for a single function on a device. A function contains a set of connectors and a function-specific configuration tree. This managed object contains the metadata for all such operations.
[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] infra:Infra A container for all tenant infra configurations.
 
 
 ├
[V] vns:MDev Import a device package into the Application Policy Infrastructure Controller (APIC). The device package contains meta device type definition and definitions of the metadata for a service device type. The metadata contains vendor-specific data including the vendor name, device model, and device version.
 
 
 
 ├
[V] vns:MFunc The metadata for a single function on a device. A function contains a set of connectors and a function-specific configuration tree. This managed object contains the metadata for all such operations.


Contained Hierarchy
[V] vns:MFunc The metadata for a single function on a device. A function contains a set of connectors and a function-specific configuration tree. This managed object contains the metadata for all such operations.
 ├
[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] vns:Assertion An assertion base object.
 ├
[V] vns:MConn A connector between logical functions. The attributes includes the cardinality, direction, and encapsulation type for the given connection.
 
 ├
[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] vns:RsInterface A source relation to an interface label. Note that this relation is an internal object.
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] vns:RtConnector A target relation to the meta-connector. Note that this relation is an internal object.
 
 ├
[V] vns:RtMConnAtt A target relation to a connector between logical functions. Note that this relation is an internal object.
 
 ├
[V] vns:RtMConnAttInst A target relation to a connector between logical functions. Note that this relation is an internal object.
 ├
[V] vns:MFeature 
 ├
[V] vns:MFolder The meta folder information. The model utilizes a generic configuration consisting of MFolders and MParams. This allows the configuration to be specified as a hierarchy.
 
 ├
[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] vns:Assertion An assertion base object.
 
 ├
[V] vns:MParam A meta parameter. The model utilizes a generic configuration consisting of MFolders and MParams. This enables configuration to be specified as a hierarchy. The metadata within this model consists of a key, a type (integer, boolean), and other attributes related to parameters.
 
 
 ├
[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] vns:Assertion An assertion base object.
 
 
 ├
[V] vns:RsConnector A source relation to a connector between logical functions. Note that this relation is an internal object.
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] vns:MRel A meta relation.
 
 
 ├
[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] vns:RsConnector A source relation to a connector between logical functions. Note that this relation is an internal object.
 
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 
 ├
[V] vns:RsTarget A source relation to meta folder information. Note that this relation is an internal object.
 
 ├
[V] vns:RsConnector A source relation to a connector between logical functions. Note that this relation is an internal object.
 
 
 ├
[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] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] vns:RtDevFolderToMFolder A target relation to an MFolder path. Note that this relation is an internal object.
 
 ├
[V] vns:RtFolderInstToMFolder A target relation to an MFolder path. Note that this relation is an internal object.
 
 ├
[V] vns:RtTarget A target relation to meta folder information. Note that this relation is an internal object.m
 ├
[V] vns:MImage The image file of the function. This managed object contains details of the image file and its location. It is used to render the image on the graphical user interface (GUI).
 ├
[V] vns:RtFunction A target relation to the metadata for a single function on a device. Note that this relation is an internal object.
 ├
[V] vns:RtNodeToMFunc A target relation to the metadata for a single function on a device. Note that this relation is an internal object.
 ├
[V] vns:RtProfToMFunc A target relation to the metadata for a single function on a device. Note that this relation is an internal object.


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] vns:AMName The meta configuration information.
 
 ├
[V] vns:MFunc The metadata for a single function on a device. A function contains a set of connectors and a function-specific configuration tree. This managed object contains the metadata for all such operations.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vns:MFunc
string:Basic dispLabel  (vns:MFunc:dispLabel)
          
reference:BinRef monPolDn  (vns:MFunc:monPolDn)
           The monitoring policy attached to this observable object.
naming:Name
          string:Basic
name  (vns:MFunc:name)
           Overrides:vns:AMName:name | naming:NamedObject:name
           The name of a single function on a device. Each function that performs a set of operations is uniquely identified by its name.
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: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





dispLabel

Type: string:Basic

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



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:vns:AMName:name  |  naming:NamedObject:name
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
The name of a single function on a device. Each function that performs a set of operations is uniquely identified by its name.



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.