Class equipment:BreakoutCap (CONCRETE)

Class ID:2282
Encrypted: false - Exportable: true - Persistent: false
Privileges: []
SNMP OID: .1.3.6.1.4.1.9.9.719.1.38.21

NO COMMENTS


Naming Rules
RN FORMAT: breakout-cap

    [1] PREFIX=breakout-cap


DN FORMAT: 

[0] capabilities/manufacturer-[vendor]-model-[model]-revision-[revision]/breakout-cap

[1] capabilities/derivative-[vendor]-model-[model]-revision-[revision]/manufacturer-[vendor]-model-[model]-revision-[revision]/breakout-cap

                



Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
capability:Catalogue
 
 ├
equipment:HwCapDerivativeProvider DEFINITIONS Specifies a derivative product based on a common platform. For example, the HX series is based on the C220 and C240 series platform
 
 
 ├
equipment:SwitchCapProvider
 
 
 
 ├
equipment:BreakoutCap
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
capability:Catalogue
 
 ├
equipment:SwitchCapProvider
 
 
 ├
equipment:BreakoutCap


Contained Hierarchy
equipment:BreakoutCap

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
capability:Def
 
 
 
 ├
equipment:BreakoutCap

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: equipment:BreakoutCap
equipment:portBitmask
          scalar:Bitmask64
phyPortBitmask  (equipment:BreakoutCap:phyPortBitmask)
           NO COMMENTS
Defined in: capability:Def
naming:Name
          string:Basic
name  (capability:Def:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
Defined in: policy:Definition
naming:Descr
          string:Basic
descr  (policy:Definition:descr)
           NO COMMENTS
policy:InternalId
          scalar:Uint32
intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8
policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
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

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
Like: naming:Described:descr
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" />

intId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject: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

phyPortBitmask

Type: equipment:portBitmask
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
p45 0x100000000000ull NO COMMENTS
p41 0x10000000000ull NO COMMENTS
p37 0x1000000000ull NO COMMENTS
p33 0x100000000ull NO COMMENTS
p29 0x10000000ull NO COMMENTS
p25 0x1000000ull NO COMMENTS
p21 0x100000ull NO COMMENTS
p17 0x10000ull NO COMMENTS
p13 0x1000ull NO COMMENTS
p9 0x100ull NO COMMENTS
p5 0x10ull NO COMMENTS
p1 0x1ull NO COMMENTS
p46 0x200000000000ull NO COMMENTS
p42 0x20000000000ull NO COMMENTS
p38 0x2000000000ull NO COMMENTS
p34 0x200000000ull NO COMMENTS
p30 0x20000000ull NO COMMENTS
p26 0x2000000ull NO COMMENTS
p22 0x200000ull NO COMMENTS
p18 0x20000ull NO COMMENTS
p14 0x2000ull NO COMMENTS
p10 0x200ull NO COMMENTS
p6 0x20ull NO COMMENTS
p2 0x2ull NO COMMENTS
p47 0x400000000000ull NO COMMENTS
p43 0x40000000000ull NO COMMENTS
p39 0x4000000000ull NO COMMENTS
p35 0x400000000ull NO COMMENTS
p31 0x40000000ull NO COMMENTS
p27 0x4000000ull NO COMMENTS
p23 0x400000ull NO COMMENTS
p19 0x40000ull NO COMMENTS
p15 0x4000ull NO COMMENTS
p11 0x400ull NO COMMENTS
p7 0x40ull NO COMMENTS
p3 0x4ull NO COMMENTS
p48 0x800000000000ull NO COMMENTS
p44 0x80000000000ull NO COMMENTS
p40 0x8000000000ull NO COMMENTS
p36 0x800000000ull NO COMMENTS
p32 0x80000000ull NO COMMENTS
p28 0x8000000ull NO COMMENTS
p24 0x800000ull NO COMMENTS
p20 0x80000ull NO COMMENTS
p16 0x8000ull NO COMMENTS
p12 0x800ull NO COMMENTS
p8 0x80ull NO COMMENTS
p4 0x8ull NO COMMENTS
all 0xffffffffffffull NO COMMENTS
DEFAULT all(0xffffffffffffull) NO COMMENTS

policyLevel

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
"local" denotes 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

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.