Class vns:AFuncNode (ABSTRACT)

Class ID:4626
Class Label: Function Node Abstract Class
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model
Write Access: [admin, nw-svc-policy]
Read Access: [admin, nw-svc-policy]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: EPG
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A function node.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: vns:ANode,
Sub Mos: vns:ANodeInst, vns:AbsNode,
Contained Mos: tag:AInst,
Relations To: vns:ATerm,
Relations: vns:RsDefaultScopeToTerm,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] pol:Obj Represents a generic policy object.
 
 ├
[V] pol:Def Represents self-contained policy document.
 
 
 ├
[V] vns:ANode A node.
 
 
 
 ├
[V] vns:AFuncNode A function node.
 
 
 
 
 ├
[V] vns:ANodeInst The abstraction of a node instance.
 
 
 
 
 
 ├
[V] vns:NodeInst An instance of a function node. A service graph consists of multiple function nodes..
 
 
 
 
 
 ├
[V] vns:NodeInstDef An instance of the service node. This is an internal object.
 
 
 
 
 ├
[V] vns:AbsNode An abstract node represents a service node such as a server load balancer (SLB) or firewall (FW). An abstract node is contained in an abstract graph.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: vns:AFuncNode
vns:FuncTemplateType
          scalar:Enum8
funcTemplateType  (vns:AFuncNode:funcTemplateType)
           Func Template type
vns:NodeFuncType
          scalar:Enum8
funcType  (vns:AFuncNode:funcType)
           A function type. A GoThrough node is a transparent device, where a packet goes through without being addressed to the device, and the endpoints are not aware of that device. A GoTo device has a specific destination.
scalar:Bool isCopy  (vns:AFuncNode:isCopy)
           if the device is a copy device
scalar:Bool managed  (vns:AFuncNode:managed)
           Specified if the function is using a managed device
scalar:Uint32 sequenceNumber  (vns:AFuncNode:sequenceNumber)
           An internally used property that is incremented every time the AAA user logs in.
scalar:Bool shareEncap  (vns:AFuncNode:shareEncap)
          
l2:UnkMacUcastAct
          scalar:Enum8
unkMacUcastAct  (vns:AFuncNode:unkMacUcastAct)
           The parameter used by the node (Leaf) for forwarding data for an unknown layer 2 destination.
Defined in: pol:Def
naming:Descr
          string:Basic
descr  (pol:Def:descr)
           Specifies a description of the policy definition.
naming:Descr
          string:Basic
ownerKey  (pol:Def:ownerKey)
           The key for enabling clients to own their data for entity correlation.
naming:Descr
          string:Basic
ownerTag  (pol:Def:ownerTag)
           A tag for enabling clients to add their own data. For example, to indicate who created this object.
Defined in: pol:Obj
naming:Name
          string:Basic
name  (pol:Obj:name)
           Overrides:naming:NamedObject:name
           null
Defined in: naming:NamedObject
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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

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
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Specifies a description of the policy definition.



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.



funcTemplateType

Type: vns:FuncTemplateType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Func Template type
Constants
FW_TRANS 0 FW_TRANS NO COMMENTS
FW_ROUTED 1 FW_ROUTED NO COMMENTS
ADC_ONE_ARM 2 ADC_ONE_ARM NO COMMENTS
ADC_TWO_ARM 3 ADC_TWO_ARM NO COMMENTS
OTHER 4 OTHER NO COMMENTS
DEFAULT OTHER(4) OTHER NO COMMENTS





funcType

Type: vns:NodeFuncType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
A function type. A GoThrough node is a transparent device, where a packet goes through without being addressed to the device, and the endpoints are not aware of that device. A GoTo device has a specific destination.
Constants
None 0 None NO COMMENTS
GoTo 1 GoTo NO COMMENTS
GoThrough 2 GoThrough NO COMMENTS
DEFAULT GoTo(1) GoTo NO COMMENTS





isCopy

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
if the device is a copy device
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





managed

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Specified if the function is using a managed device
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT yes(true) --- NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: admin Category: TopLevelRegular Property Validators: Range: min: "0" max: "64" Allowed Chars: Regex: [a-zA-Z0-9_.:-]+
    Comments:
null



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



ownerKey

Type: naming:Descr
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:
The key for enabling clients to own their data for entity correlation.



ownerTag

Type: naming:Descr
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "64"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
A tag for enabling clients to add their own data. For example, to indicate who created this object.



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.



sequenceNumber

Type: scalar:Uint32

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
An internally used property that is incremented every time the AAA user logs in.



shareEncap

Type: scalar:Bool

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- 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.






unkMacUcastAct

Type: l2:UnkMacUcastAct
Primitive Type: scalar:Enum8

Like: l2:BD:unkMacUcastAct
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The parameter used by the node (Leaf) for forwarding data for an unknown layer 2 destination.
Constants
flood 0 Flood Flooding
proxy 1 Hardware Proxy Proxy
DEFAULT proxy(1) Hardware Proxy Proxy