| 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
|
assocPrimaryVlanState
Type: fabric:VlanAssocPrimaryVlanState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| ok |
1 |
NO COMMENTS
|
| is-empty |
2 |
NO COMMENTS
|
| does-not-exists |
3 |
NO COMMENTS
|
| is-not-primary-type |
4 |
NO COMMENTS
|
| is-in-error-state |
5 |
NO COMMENTS
|
| DEFAULT |
ok(1) |
NO COMMENTS
|
|
assocPrimaryVlanSwitchId
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 |
NONE(0) |
NO COMMENTS
|
|
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
|
|
cloud
Type: fabric:CloudType
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
Identifies the cloud that the VLAN resides in.
| |
| Constants |
| unknown |
0ull |
Not applicable
|
| fcsanmon |
16ull |
Fibre Channel SAN monitoring cloud
|
| ethlan |
1ull |
There is no vlan corresponding to the VLAN permit's name.
|
| ethestclan |
2ull |
Ethernet storage cloud
|
| fcestc |
32ull |
Fibre Channel external storage cloud
|
| ethlanmon |
4ull |
Ethernet LAN monitoring cloud
|
| fcsan |
8ull |
Fibre Channel storage cloud
|
| DEFAULT |
unknown(0ull) |
Not applicable
|
|
compressionType
Type: fabric:VlanCompType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
This is VLAN compression type to decide whether A VLAN should be compressed
| |
| Constants |
| included |
1 |
NO COMMENTS
|
| excluded |
2 |
NO COMMENTS
|
| DEFAULT |
included(1) |
NO COMMENTS
|
|
configIssues
Type: fabric:VlanConfigIssues
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
VLAN configuration issues.
| |
| Constants |
| not-applicable |
0ull |
Not applicable
|
| conflicting-vlan-access |
1ull |
overall there are not enough resources
|
| unsupported-multicast-policy |
2ull |
NO COMMENTS
|
| DEFAULT |
not-applicable(0ull) |
Not applicable
|
|
defaultNet
Type: networkrule:Default
Primitive Type: scalar:Bool
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| yes |
true |
NO COMMENTS
|
| no |
false |
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" />
epDn
Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
cross-pointer to the other side of connection
fltAggr
Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
global
Type: scalar:Uint64
Like: fabric:VnicUsers:global
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
id
Type: network:VNetId
Primitive Type: scalar:Uint32
Overrides:fabric:VnetEp:id | network:VnetEp:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: (long)4048l max: (long)4093l
Range: min: (long)1l max: (long)4029l
Comments:
-
The VLAN ID
| |
| Constants |
| defaultValue |
1u |
NO COMMENTS
|
|
ifRole
Type: network:PortRole
Primitive Type: scalar:Enum8
Overrides:network:IfEp:ifRole
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| unknown |
0 |
NO COMMENTS
|
| network |
1 |
NO COMMENTS
|
| server |
2 |
NO COMMENTS
|
| mgmt |
3 |
NO COMMENTS
|
| diag |
4 |
NO COMMENTS
|
| storage |
5 |
NO COMMENTS
|
| monitor |
6 |
NO COMMENTS
|
| fcoe-storage |
7 |
NO COMMENTS
|
| nas-storage |
8 |
NO COMMENTS
|
| fcoe-nas-storage |
9 |
NO COMMENTS
|
| fcoe-uplink |
10 |
NO COMMENTS
|
| network-fcoe-uplink |
11 |
NO COMMENTS
|
| service |
12 |
NO COMMENTS
|
| DEFAULT |
network(1) |
NO COMMENTS
|
|
ifType
Type: network:PortType
Primitive Type: scalar:Enum8
Overrides:network:IfEp:ifType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| unknown |
0 |
NO COMMENTS
|
| physical |
1 |
NO COMMENTS
|
| aggregation |
2 |
NO COMMENTS
|
| virtual |
3 |
NO COMMENTS
|
| DEFAULT |
virtual(3) |
NO COMMENTS
|
|
local
Type: scalar:Uint64
Like: fabric:VnicUsers:local
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
locale
Type: network:Locale
Primitive Type: scalar:Bitmask8
Overrides: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
|
|
mcastPolicyName
Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Policy Reference to: fabric:MulticastPolicy
Property Validators:
Range: min: "0" max: "16"
Allowed Chars:
Regex: [a-zA-Z0-9_.:-]+
Comments:
-
Reference to multicast policy name.
name
Type: naming:Name
Primitive Type: string:Basic
Overrides:fabric:AVlan:name | fabric:VnetEp:name | naming:NamedObject:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Range: min: "1" max: "32"
Allowed Chars:
Regex: [a-zA-Z0-9_.:-]+
Comments:
-
NO COMMENTS
operMcastPolicyName
Type: reference:Object
Refers: fabric:MulticastPolicy
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
operState
Type: fabric:VlanOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| ok |
1 |
NO COMMENTS
|
| error-misconfigured |
2 |
The following error occurs when a vlan overlaps with a fcoe-vlan during import
|
| DEFAULT |
ok(1) |
NO COMMENTS
|
|
overlapStateForA
Type: fabric:VlanOverlapState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| not-active |
0 |
NO COMMENTS
|
| ok |
1 |
NO COMMENTS
|
| sharing-type-mismatch |
2 |
NO COMMENTS
|
| primary-id-mismatch |
3 |
NO COMMENTS
|
| active |
4 |
applicable only for secondary vlans
|
| DEFAULT |
ok(1) |
NO COMMENTS
|
|
overlapStateForB
Type: fabric:VlanOverlapState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| not-active |
0 |
NO COMMENTS
|
| ok |
1 |
NO COMMENTS
|
| sharing-type-mismatch |
2 |
NO COMMENTS
|
| primary-id-mismatch |
3 |
NO COMMENTS
|
| active |
4 |
applicable only for secondary vlans
|
| DEFAULT |
ok(1) |
NO COMMENTS
|
|
peerDn
Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
policyOwner
Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
since Vlan can be imported from Pasadena or created locally by ucsm
the following property will differentiate between the two options:
"local" denotes a 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
|
|
pubNwDn
Type: reference:Object
Refers: fabric:Vlan
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
The distinguished name of the resolved primary VLAN.
This property is applicable for secondary PVLANs.
pubNwId
Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
The VLAN ID of the resolved primary VLAN.
This property is applicable for secondary PVLANs.
pubNwName
Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "510"
Comments:
-
The name of the primary VLAN for this secondary PVLAN.
This property is applicable for secondary PVLANs.
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
|
|
sharing
Type: fabric:VlanSharingType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The sharing type of this VLAN, such as standard, primary PVLAN, isolated PVLAN or community PVLAN
| |
| Constants |
| none |
0 |
NO COMMENTS
|
| primary |
1 |
NO COMMENTS
|
| isolated |
2 |
NO COMMENTS
|
| community |
3 |
NO COMMENTS
|
| DEFAULT |
none(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.
|
|
switchId
Type: network:SwitchId
Primitive Type: scalar:Enum8
Overrides:fabric:VnetEp:switchId
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
|
| dual |
3 |
NO COMMENTS
|
| DEFAULT |
dual(3) |
NO COMMENTS
|
|
transport
Type: network:Transport
Primitive Type: scalar:Bitmask8
Overrides:network:Conn:transport
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
The transport type. Always set to "ether"
| |
| 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:network:Conn:type
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
The type. Always set to "lan"
| |
| Constants |
| unknown |
0 |
NO COMMENTS
|
| lan |
1 |
NO COMMENTS
|
| san |
2 |
NO COMMENTS
|
| ipc |
4 |
NO COMMENTS
|
| DEFAULT |
lan(1) |
NO COMMENTS
|
|