| Properties Summary |
childAction
Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Comments:
-
Delete or ignore. For internal use only.
| |
| Constants |
| deleteAll |
16384u |
deleteAll |
NO COMMENTS
|
| ignore |
4096u |
ignore |
NO COMMENTS
|
| deleteNonPresent |
8192u |
deleteNonPresent |
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: "128"
Allowed Chars:
Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
Comments:
-
dn
Type: reference:BinRef
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Comments:
-
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
id
Type: naming:Id
Primitive Type: scalar:Uint64
Like: naming:Identified:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
An identifier .
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:
-
The name of the object.
nameAlias
Type: naming:NameAlias
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "63"
Allowed Chars:
Regex: [a-zA-Z0-9_.-]+
Comments:
-
NO COMMENTS
objDn
Type: reference:BinRef
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
propBmp64
Type: synthetic:TestBitmask64
Primitive Type: scalar:Bitmask64
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
| |
| Constants |
| nobit |
0x0ull |
no bit |
NO COMMENTS
|
| bit32 |
0x100000000ull |
bit 33 of 64 |
NO COMMENTS
|
| bit16 |
0x10000ull |
bit 17 of 64 |
NO COMMENTS
|
| bit4 |
0x10ull |
bit 5 of 64 |
NO COMMENTS
|
| bit0 |
0x1ull |
bit 1 of 64 |
NO COMMENTS
|
| bit5 |
0x20ull |
bit 6 of 64 |
NO COMMENTS
|
| bit1 |
0x2ull |
bit 2 of 64 |
NO COMMENTS
|
| bit63 |
0x4000000000000000ull |
bit 63 of 64 |
NO COMMENTS
|
| bit2 |
0x4ull |
bit 3 of 64 |
NO COMMENTS
|
| bit64 |
0x8000000000000000ull |
bit 64 of 64 |
NO COMMENTS
|
| bit31 |
0x80000000ull |
bit 32 of 64 |
NO COMMENTS
|
| bit15 |
0x8000ull |
bit 16 of 64 |
NO COMMENTS
|
| bit3 |
0x8ull |
bit 4 of 64 |
NO COMMENTS
|
| defaultValue |
0ull |
--- |
NO COMMENTS
|
|
propBmp8
Type: synthetic:TestBitmask8
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
| |
| Constants |
| nobit |
0x0 |
no bit |
NO COMMENTS
|
| bit0 |
0x1 |
bit 1 of 8 |
NO COMMENTS
|
| bit4 |
0x10 |
bit 5 of 8 |
NO COMMENTS
|
| bit1 |
0x2 |
bit 2 of 8 |
NO COMMENTS
|
| bit5 |
0x20 |
bit 6 of 8 |
NO COMMENTS
|
| bit2 |
0x4 |
bit 3 of 8 |
NO COMMENTS
|
| bit6 |
0x40 |
bit 7 of 8 |
NO COMMENTS
|
| bit3 |
0x8 |
bit 4 of 8 |
NO COMMENTS
|
| bit7 |
0x80 |
bit 8 of 8 |
NO COMMENTS
|
| defaultValue |
0 |
--- |
NO COMMENTS
|
|
propDate
Type: scalar:Date
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
propEnum16
Type: synthetic:TestEnum16
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
| |
| Constants |
| generic |
0 |
generic |
NO COMMENTS
|
| first |
1 |
first |
NO COMMENTS
|
| second |
2 |
second |
NO COMMENTS
|
| third |
3 |
third |
NO COMMENTS
|
| last |
65535 |
last |
NO COMMENTS
|
| DEFAULT |
generic(0) |
generic |
NO COMMENTS
|
|
propString
Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "512"
Comments:
-
propUByte
Type: scalar:UByte
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
propUint32
Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
propUint64
Type: scalar:Uint64
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
rn
Type: reference:BinRN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Comments:
-
Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
status
Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Comments:
-
The upgrade status. This property is for internal use only.
| |
| Constants |
| created |
2u |
created |
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 |
modified |
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 |
deleted |
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.
|
|
![[V]](styles/eye.gif)