| Properties Summary |
| Defined in: qosclass:Item |
qos:AdminState
scalar:Enum8
|
adminState (qosclass:Item:adminState)
NO COMMENTS
|
qos:BWPercent
scalar:UByte
|
bwPercent (qosclass:Item:bwPercent)
NO COMMENTS
|
qos:Class
scalar:UByte
|
cos (qosclass:Item:cos)
Specifies the Class of Service (CoS).
The CoS is a 3 bit field within an Ethernet frame header when using 802.1q tagging.
|
qos:Drop
scalar:Enum8
|
drop (qosclass:Item:drop)
Specifies if packets can be dropped in this Qos class.
|
qos:MTU
scalar:Uint32
|
mtu (qosclass:Item:mtu)
The Maximum Transmission Unit for all packets in this class of traffic.
The Ethernet MTU is defined as the maximum layer 2 payload of an Ethernet frame
and is specified per QoS class. It ranges from 576 to 9,000 and typically
defaults to 1,500.
UCS performs layer 2 switching and does not support packet fragmentation.
Any Ethernet frame with a size over the MTU is truncated; operating
systems are responsible for performing MTU discovery and sending packets
smaller than the MTU.
The MTU property specified here is enforced on the Fabric Interconnect hardware.
It is applied to service profile traffic through a Network QoS policy as follows:
a Service Profile vnic:Ether or vnic:Fc can refer to a Network QoS Policy epqos:Definition by name,
through the vnic:Vnic:qosPolicyName property.
The Network QoS Policy contains the egress QoS policy epqos:Egress; the egress policy refers to a QoS class,
which specifies the MTU.
The "Fibre Channel" system class (for Fibre Channel and FCoE traffic) has a default MTU of 2158 bytes.
This value cannot be modified.
Note that UCS also enforces the MTU on server network adapters. Refer to vnic:EtherBase:mtu
for a description of the MTU applied at the vNIC level.
Both MTU values must match.
The type of adapter in a server may limit the maximum MTU supported.
Network MTU above the maximums may cause the packet to be dropped for the following adapters:
- The Cisco UCS CNA M71KR adapter, which supports a maximum MTU of 9216.
- The Cisco UCS 82598KR-CI adapter, which supports a maximum MTU of 14000.
|
qos:Priority
scalar:Enum8
|
priority (qosclass:Item:priority)
NO COMMENTS
|
qos:Weight
scalar:UByte
|
weight (qosclass:Item:weight)
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
|
adminState
Type: qos:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| disabled |
0 |
NO COMMENTS
|
| enabled |
1 |
NO COMMENTS
|
| DEFAULT |
enabled(1) |
NO COMMENTS
|
|
bwPercent
Type: qos:BWPercent
Primitive Type: scalar:UByte
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Range: min: (short)0 max: (short)100
Comments:
-
NO COMMENTS
| |
| Constants |
| not-applicable |
0 |
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
|
|
cos
Type: qos:Class
Primitive Type: scalar:UByte
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: (short)0 max: (short)6
Range: min: (short)255 max: (short)255
Comments:
-
Specifies the Class of Service (CoS).
The CoS is a 3 bit field within an Ethernet frame header when using 802.1q tagging.
| |
| Constants |
| any |
255 |
NO COMMENTS
|
| defaultValue |
0 |
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" />
drop
Type: qos:Drop
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
Specifies if packets can be dropped in this Qos class.
| |
| Constants |
| drop |
0 |
NO COMMENTS
|
| no-drop |
1 |
NO COMMENTS
|
| DEFAULT |
drop(0) |
NO COMMENTS
|
|
mtu
Type: qos:MTU
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: (long)1500l max: (long)9216l
Comments:
-
The Maximum Transmission Unit for all packets in this class of traffic.
The Ethernet MTU is defined as the maximum layer 2 payload of an Ethernet frame
and is specified per QoS class. It ranges from 576 to 9,000 and typically
defaults to 1,500.
UCS performs layer 2 switching and does not support packet fragmentation.
Any Ethernet frame with a size over the MTU is truncated; operating
systems are responsible for performing MTU discovery and sending packets
smaller than the MTU.
The MTU property specified here is enforced on the Fabric Interconnect hardware.
It is applied to service profile traffic through a Network QoS policy as follows:
a Service Profile vnic:Ether or vnic:Fc can refer to a Network QoS Policy epqos:Definition by name,
through the vnic:Vnic:qosPolicyName property.
The Network QoS Policy contains the egress QoS policy epqos:Egress; the egress policy refers to a QoS class,
which specifies the MTU.
The "Fibre Channel" system class (for Fibre Channel and FCoE traffic) has a default MTU of 2158 bytes.
This value cannot be modified.
Note that UCS also enforces the MTU on server network adapters. Refer to vnic:EtherBase:mtu
for a description of the MTU applied at the vNIC level.
Both MTU values must match.
The type of adapter in a server may limit the maximum MTU supported.
Network MTU above the maximums may cause the packet to be dropped for the following adapters:
- The Cisco UCS CNA M71KR adapter, which supports a maximum MTU of 9216.
- The Cisco UCS 82598KR-CI adapter, which supports a maximum MTU of 14000.
| |
| Constants |
| normal |
1500u |
NO COMMENTS
|
| fc |
2240u |
NO COMMENTS
|
| DEFAULT |
normal(1500u) |
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
priority
Type: qos:Priority
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
Comments:
-
NO COMMENTS
| |
| Constants |
| fc |
1 |
NO COMMENTS
|
| platinum |
2 |
NO COMMENTS
|
| gold |
3 |
NO COMMENTS
|
| silver |
4 |
NO COMMENTS
|
| bronze |
5 |
NO COMMENTS
|
| best-effort |
6 |
NO COMMENTS
|
| DEFAULT |
best-effort(6) |
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
|
|
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.
|
|
weight
Type: qos:Weight
Primitive Type: scalar:UByte
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: (short)0 max: (short)10
Comments:
-
NO COMMENTS
| |
| Constants |
| none |
0 |
NO COMMENTS
|
| best-effort |
1 |
NO COMMENTS
|
| DEFAULT |
best-effort(1) |
NO COMMENTS
|
|