| Properties Summary |
| 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
|
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
|
|
destinationIpAddress
Type: address:IPv4
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
destinationPort
Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
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" />
dscp
Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
exportInternal
Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
exporterStatsTimeout
Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
interfaceTableTimeout
Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
isValidConfig
Type: sw:NFConfigStatus
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| ok |
1 |
NO COMMENTS
|
| incomplete |
2 |
NO COMMENTS
|
| DEFAULT |
ok(1) |
NO COMMENTS
|
|
lifeCycle
Type: sw:MonLifeCycle
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
TODO: vdravid Revisit these properties
| |
| 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
Overrides: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
peerDn
Type: reference:Object
Refers: fabric:FlowMonitor
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
protocol
Type: fabric:FlowMonProtocol
Primitive Type: scalar:Enum16
Overrides:sw:FlowMonExporter:protocol
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| netflow |
1 |
NO COMMENTS
|
| DEFAULT |
netflow(1) |
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: network:VNetId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Range: min: (long)1l max: (long)4093l
Comments:
-
NO COMMENTS
| |
| Constants |
| defaultValue |
1u |
const name="default" value="1"/
|
|
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: implicit
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
|
|
templateDataTimeout
Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
transport
Type: network:Transport
Primitive Type: scalar:Bitmask8
Overrides:sw:FlowMonExporter: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
|
|
transportProtocol
Type: fabric:NFTransport
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| udp |
1 |
NO COMMENTS
|
| sctp |
2 |
NO COMMENTS
|
| DEFAULT |
udp(1) |
NO COMMENTS
|
|
type
Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
Overrides:sw:FlowMonExporter: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
|
|
version
Type: fabric:NFExporterVersion
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| v9 |
1 |
NO COMMENTS
|
| ipfix |
2 |
NO COMMENTS
|
| DEFAULT |
v9(1) |
NO COMMENTS
|
|