Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class sw:Mon (ABSTRACT)

Class ID:1049
Encrypted: false - Exportable: false - Persistent: true
Privileges: []
SNMP OID:

NO COMMENTS

Naming Rules 


DN FORMAT:


Inheritance
naming:NamedObject
 ├
 		sw:Mon
 
 		 ├
 		sw:EthFlowMonSession
 
 		 
 		 ├
 		sw:NetflowMonSession
 
 		 ├
 		sw:EthMon
 
 		 ├
 		sw:FcMon
Events


Faults


Fsms


Properties Summary
Defined in: sw:Mon
fabric:AdminState
          scalar:Enum8 		adminState  (sw:Mon:adminState)
           NO COMMENTS
scalar:Bool hasLastDest  (sw:Mon:hasLastDest)
           NO COMMENTS
sw:MonLifeCycle
          scalar:Enum8 		lifeCycle  (sw:Mon:lifeCycle)
           used for FSM to tell portAG a Mon is deleted
reference:Object peerDn  (sw:Mon:peerDn)
           NO COMMENTS
fabric:MonSession
          scalar:Uint32 		session  (sw:Mon:session)
           NO COMMENTS
fabric:AdminState
          scalar:Enum8 		spanCtrlPkts  (sw:Mon:spanCtrlPkts)
           Indicates whether to SPAN Ctrl packets
network:SwitchId
          scalar:Enum8 		switchId  (sw:Mon:switchId)
           NO COMMENTS
network:Transport
          scalar:Bitmask8 		transport  (sw:Mon:transport)
           NO COMMENTS
network:ConnectionType
          scalar:Bitmask8 		type  (sw:Mon:type)
           NO COMMENTS
Defined in: naming:NamedObject
naming:Name
          string:Basic 		name  (naming:NamedObject:name)
           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

adminState

Type: fabric:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
enabled 1 Indicates the administrative state is enabled. Set this value when you want to administratively enable an end-point. The system will enable the end-point and the operational state should transition to an "up" state. However, some pre-condition may prevent the operational state to be up, such as a misconfigured end-point, or external conditions such as a port not being physically connected.
disabled 2 Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.
DEFAULT disabled(2) Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.

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

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" />

hasLastDest

Type: scalar:Bool
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
yes true NO COMMENTS
defaultValue false NO COMMENTS

lifeCycle

Type: sw:MonLifeCycle
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
used for FSM to tell portAG a Mon is deleted
Constants
normal 1 NO COMMENTS
new 2 NO COMMENTS
deleted 3 NO COMMENTS
DEFAULT normal(1) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

peerDn

Type: reference:Object
Refers: fabric:Mon
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
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

session

Type: fabric:MonSession
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)255l

Comments:
NO COMMENTS
Constants
defaultValue 1u NO COMMENTS

spanCtrlPkts

Type: fabric:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
Indicates whether to SPAN Ctrl packets
Constants
enabled 1 Indicates the administrative state is enabled. Set this value when you want to administratively enable an end-point. The system will enable the end-point and the operational state should transition to an "up" state. However, some pre-condition may prevent the operational state to be up, such as a misconfigured end-point, or external conditions such as a port not being physically connected.
disabled 2 Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.
DEFAULT disabled(2) Indicates the administrative state is disabled. Set this value when you want to administratively disable an end-point. The system will disable the end-point and the operational state will transition to a "down" state.

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.

switchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
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

transport

Type: network:Transport
Primitive Type: scalar:Bitmask8
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 unknown(0) NO COMMENTS

type

Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
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 unknown(0) NO COMMENTS
Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail