Class clitest:TypeTest2 (CONCRETE)

Class ID:79
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.18.2

@@ used for types where we don't want an auto-generated command


Naming Rules
RN FORMAT: tt2-

    [1] PREFIX=tt2-


DN FORMAT: 

[0] tt2-

                



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.
 ├
clitest:TypeTest2


Contained Hierarchy
clitest:TypeTest2

Inheritance
clitest:TypeTest2

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: clitest:TypeTest2
clitest:APartialEnum
          scalar:Uint32
aPartialEnum  (clitest:TypeTest2:aPartialEnum)
           NO COMMENTS
clitest:ABitmaskType
          scalar:Bitmask8
abitmask  (clitest:TypeTest2:abitmask)
           NO COMMENTS
string:CharBuffer acharbuf  (clitest:TypeTest2:acharbuf)
           NO COMMENTS
string:Basic fileDir  (clitest:TypeTest2:fileDir)
           NO COMMENTS
string:Basic fileHost  (clitest:TypeTest2:fileHost)
           NO COMMENTS
string:Basic fileName  (clitest:TypeTest2:fileName)
           NO COMMENTS
aaa:Passwd
          string:Password
filePasswd  (clitest:TypeTest2:filePasswd)
           NO COMMENTS
string:Basic filePath  (clitest:TypeTest2:filePath)
           NO COMMENTS
scalar:Uint32 filePort  (clitest:TypeTest2:filePort)
           NO COMMENTS
comm:FileTransferProtocol
          scalar:Enum8
fileProto  (clitest:TypeTest2:fileProto)
           NO COMMENTS
string:Basic fileUser  (clitest:TypeTest2:fileUser)
           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

Properties Detail

aPartialEnum

Type: clitest:APartialEnum
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)4096l
Comments:
NO COMMENTS
Constants
untagged 0u NO COMMENTS
default 4096u NO COMMENTS
DEFAULT untagged(0u) NO COMMENTS

abitmask

Type: clitest:ABitmaskType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
up 1 NO COMMENTS
down 2 NO COMMENTS
kindOfUp 4 NO COMMENTS
sortOfDown 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

acharbuf

Type: string:CharBuffer
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
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

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" />

fileDir

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

fileHost

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

fileName

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

filePasswd

Type: aaa:Passwd
Primitive Type: string:Password
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "80"
        Allowed Chars:
            Regex: [\\a-zA-Z0-9'"\[\]!#%&()*+,-./:;@_{|}˜`<>ˆ]+
Comments:
NO COMMENTS

filePath

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
Comments:
NO COMMENTS

filePort

Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

fileProto

Type: comm:FileTransferProtocol
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0 NO COMMENTS
ftp 1 NO COMMENTS
tftp 2 NO COMMENTS
scp 3 NO COMMENTS
http 4 NO COMMENTS
sftp 5 NO COMMENTS
nfs-copy 6 NO COMMENTS
DEFAULT none(0) NO COMMENTS

fileUser

Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "510"
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

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.