| 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
|
adminState
Type: fabric:AdminState
Primitive Type: scalar:Enum8
Overrides:fabric:CIoEp:adminState
Units: null
Encrypted: false
Access: implicit
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 |
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.
|
|
chassisId
Type: equipment:ChassisId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Range: min: (long)0l max: (long)255l
Comments:
-
NO COMMENTS
| |
| Constants |
| N/A |
0u |
NO COMMENTS
|
| DEFAULT |
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
|
|
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" />
epDn
Type: reference:Object
Refers: port:PIo
Overrides:network:Ep:epDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
fltAggr
Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
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 |
server(2) |
NO COMMENTS
|
|
ifType
Type: network:PortType
Primitive Type: scalar:Enum8
Overrides:network:CIoEp:ifType | network:IfEp:ifType
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
The interface type of this logical interface
| |
| Constants |
| unknown |
0 |
NO COMMENTS
|
| physical |
1 |
NO COMMENTS
|
| aggregation |
2 |
NO COMMENTS
|
| virtual |
3 |
NO COMMENTS
|
| DEFAULT |
aggregation(2) |
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 |
internal(4) |
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
operSpeed
Type: port:EthSpeed
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| indeterminate |
0 |
NO COMMENTS
|
| 1gbps |
1 |
NO COMMENTS
|
| 10gbps |
2 |
NO COMMENTS
|
| 20gbps |
3 |
NO COMMENTS
|
| 40gbps |
4 |
NO COMMENTS
|
| DEFAULT |
10gbps(2) |
NO COMMENTS
|
|
operState
Type: network:PortOperState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
-
The operational status of this port channel
| |
| Constants |
| indeterminate |
0 |
|
| up |
1 |
This port is operationally up
|
| admin-down |
2 |
This port is down because it is administratively down.
|
| link-down |
3 |
The link is down
|
| failed |
4 |
NO COMMENTS
|
| no-license |
5 |
The port has no valid license
|
| link-up |
6 |
NO COMMENTS
|
| hardware-failure |
7 |
This port has a hardware failure
|
| software-failure |
8 |
This port has a software failure
|
| error-disabled |
9 |
NO COMMENTS
|
| sfp-not-present |
10 |
NO COMMENTS
|
| udld-aggr-down |
11 |
NO COMMENTS
|
| down |
12 |
NO COMMENTS
|
| DEFAULT |
indeterminate(0) |
|
|
peerDn
Type: reference:Object
Refers: network:PIoEp
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
portId
Type: equipment:PortId
Primitive Type: scalar:Uint32
Overrides:fabric:SwSrvPc:portId | network:CIoEp:portId
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Range: min: (long)1024l max: (long)4096l
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
|
|
stateQual
Type: port:StateQual
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "510"
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.
|
|
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
|
|
transport
Type: network:Transport
Primitive Type: scalar:Bitmask8
Overrides: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 |
dce(2) |
Transport is Data Center Ethernet (DCE)
|
|
type
Type: network:ConnectionType
Primitive Type: scalar:Bitmask8
Overrides: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
|
|