Class fabric:NetflowCollector (CONCRETE)

Class ID:1840
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.82

NO COMMENTS


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

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




DN FORMAT: 

[0] fabric/lanmon/eth-flow-monitoring/flow-collector-[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:NetflowCollector


Contained Hierarchy
fabric:NetflowCollector
 ├
ip:IpV4StaticTargetAddr

Inheritance
naming:NamedObject
 ├
network:Conn EndPoint abstraction
 
 ├
fabric:Domain Abstraction of fabric. Represents an instance of generic fabric domain.
 
 
 ├
fabric:External Abstraction of external fabric. Represents an instance of generic external fabric domain.
 
 
 
 ├
fabric:FlowMonCollector
 
 
 
 
 ├
fabric:LanFlowMonCollector
 
 
 
 
 
 ├
fabric:EthLanFlowMonCollector
 
 
 
 
 
 
 ├
fabric:NetflowCollector

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: fabric:NetflowCollector
fabric:FlowMonProtocol
          scalar:Enum16
flowProtocol  (fabric:NetflowCollector:flowProtocol)
           Overrides:fabric:FlowMonCollector:flowProtocol
           NO COMMENTS
naming:Name
          string:Basic
name  (fabric:NetflowCollector:name)
           Overrides:fabric:Domain:name | naming:NamedObject:name
           NO COMMENTS
scalar:Uint32 port  (fabric:NetflowCollector:port)
           Overrides:fabric:EthLanFlowMonCollector:port
           NO COMMENTS
string:Basic sourceVlan  (fabric:NetflowCollector:sourceVlan)
           NO COMMENTS
reference:Object sourceVlanDn  (fabric:NetflowCollector:sourceVlanDn)
           NO COMMENTS
Defined in: fabric:EthLanFlowMonCollector
network:Transport
          scalar:Bitmask8
transport  (fabric:EthLanFlowMonCollector:transport)
           Overrides:fabric:FlowMonCollector:transport | fabric:Domain:transport | network:Conn:transport
           NO COMMENTS
Defined in: fabric:LanFlowMonCollector
network:ConnectionType
          scalar:Bitmask8
type  (fabric:LanFlowMonCollector:type)
           Overrides:fabric:FlowMonCollector:type | fabric:Domain:type | network:Conn:type
           NO COMMENTS
Defined in: fabric:FlowMonCollector
naming:Descr
          string:Basic
descr  (fabric:FlowMonCollector:descr)
           NO COMMENTS
network:Locale
          scalar:Bitmask8
locale  (fabric:FlowMonCollector:locale)
           Overrides:fabric:External:locale | fabric:Domain:locale | network:Conn:locale
           NO COMMENTS
Defined in: fabric:Domain
network:SwitchId
          scalar:Enum8
id  (fabric:Domain:id)
           NO COMMENTS
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
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" />

flowProtocol

Type: fabric:FlowMonProtocol
Primitive Type: scalar:Enum16
Overrides:fabric:FlowMonCollector:flowProtocol
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
netflow 1 NO COMMENTS
DEFAULT netflow(1) NO COMMENTS

id

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

locale

Type: network:Locale
Primitive Type: scalar:Bitmask8
Overrides:fabric:External:locale  |  fabric:Domain:locale  |  network:Conn:locale
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
server 1 NO COMMENTS
chassis 2 NO COMMENTS
internal 4 NO COMMENTS
external 8 NO COMMENTS
DEFAULT external(8) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:fabric:Domain: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

port

Type: scalar:Uint32
Overrides:fabric:EthLanFlowMonCollector:port
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)65535l
Comments:
NO COMMENTS
Constants
defaultValue 9995u 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

sourceVlan

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

sourceVlanDn

Type: reference:Object
Refers: fabric:Vlan
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
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.


transport

Type: network:Transport
Primitive Type: scalar:Bitmask8
Overrides:fabric:FlowMonCollector:transport  |  fabric:Domain:transport  |  network:Conn:transport
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
ether 1 Transport is Ethernet
dce 2 Transport is Data Center Ethernet (DCE)
fc 4 Transport is Fibre Channel
DEFAULT ether(1) Transport is Ethernet

type

Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
Overrides:fabric:FlowMonCollector:type  |  fabric:Domain:type  |  network:Conn:type
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
lan 1 NO COMMENTS
san 2 NO COMMENTS
ipc 4 NO COMMENTS
DEFAULT lan(1) NO COMMENTS