Class fabric:FlowMonDefinition (CONCRETE)

Class ID:1827
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ext-lan-config, ext-lan-policy]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.45.67

NO COMMENTS


Naming Rules
RN FORMAT: flow-record-[name]

    [1] PREFIX=flow-record- PROPERTY = name




DN FORMAT: 

[0] fabric/lanmon/eth-flow-monitoring/flow-record-[name]

                



Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
fabric:Ep The root container of all fabric configuration objects.
 
 ├
fabric:LanMonCloud A container for logical Ethernet monitoring configuration Objects that span across the Fabric Interconnects. The contained configuration objects specify the logical monitoring configuration (SPAN), including Ethernet SPAN sessions on fabric A and B.
 
 
 ├
fabric:EthLanFlowMonitoring
 
 
 
 ├
fabric:FlowMonDefinition


Contained Hierarchy
fabric:FlowMonDefinition

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
fabric:FlowMonDefinition

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: fabric:FlowMonDefinition
naming:Descr
          string:Basic
descr  (fabric:FlowMonDefinition:descr)
           Overrides:policy:Definition:descr
           NO COMMENTS
fabric:FlowMonIpv4Keys
          scalar:Bitmask32
ipv4keys  (fabric:FlowMonDefinition:ipv4keys)
           NO COMMENTS
fabric:FlowMonIpv6Keys
          scalar:Bitmask32
ipv6keys  (fabric:FlowMonDefinition:ipv6keys)
           NO COMMENTS
fabric:FlowMonKeyType
          scalar:Enum16
keyType  (fabric:FlowMonDefinition:keyType)
           NO COMMENTS
fabric:FlowMonL2Keys
          scalar:Bitmask32
l2keys  (fabric:FlowMonDefinition:l2keys)
           NO COMMENTS
naming:Name
          string:Basic
name  (fabric:FlowMonDefinition:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
fabric:FlowMonNonKeys
          scalar:Bitmask32
nonkeys  (fabric:FlowMonDefinition:nonkeys)
           NO COMMENTS
fabric:FlowMonDefType
          scalar:Enum8
recordType  (fabric:FlowMonDefinition:recordType)
           NO COMMENTS
Defined in: policy:Definition
policy:InternalId
          scalar:Uint32
intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8
policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8
sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           This property controls the life cycle of a managed object

Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:
Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

descr

Type: naming:Descr
Primitive Type: string:Basic
Overrides:policy:Definition:descr
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

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:
Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

intId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

ipv4keys

Type: fabric:FlowMonIpv4Keys
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
src-port 16u NO COMMENTS
ipv4-src-address 1u NO COMMENTS
ipv4-dest-address 2u NO COMMENTS
dest-port 32u NO COMMENTS
ip-protocol 4u NO COMMENTS
ip-tos 8u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

ipv6keys

Type: fabric:FlowMonIpv6Keys
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
src-port 16u NO COMMENTS
ipv6-src-address 1u NO COMMENTS
ipv6-dest-address 2u NO COMMENTS
dest-port 32u NO COMMENTS
ip-protocol 4u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

keyType

Type: fabric:FlowMonKeyType
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
l2keys 0 NO COMMENTS
ipv4keys 1 NO COMMENTS
ipv6keys 2 NO COMMENTS
DEFAULT ipv4keys(1) NO COMMENTS

l2keys

Type: fabric:FlowMonL2Keys
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
ethertype 1u NO COMMENTS
dest-mac-address 2u NO COMMENTS
src-mac-address 4u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

nonkeys

Type: fabric:FlowMonNonKeys
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
counter-packets-long 1u NO COMMENTS
counter-bytes-long 2u NO COMMENTS
sys-uptime-first 4u NO COMMENTS
sys-uptime-last 8u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

policyLevel

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
"local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Constants
local 0 NO COMMENTS
policy 1 NO COMMENTS
pending-policy 2 NO COMMENTS
DEFAULT local(0) NO COMMENTS

recordType

Type: fabric:FlowMonDefType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
system-defined 1 NO COMMENTS
user-defined 2 NO COMMENTS
DEFAULT user-defined(2) NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:
Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:
Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:
Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.