Properties Summary |
Defined in: mo:Resolvable |
mo:Owner
scalar:Enum8
|
lcOwn (mo:Resolvable:lcOwn)
A value that indicates how this object was created. For internal use only.
|
Defined in: mo:Ownable |
scalar:Uint16
|
uid (mo:Ownable:uid)
A unique identifier for this object.
|
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
|
|
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.
entity
Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Range: min: "0" max: "512"
Allowed Chars:
Regex: ˆ[a-zA-Z0-9_./\[\]:-]+$
Comments:
-
The query entity as a distinguished name or class name.
lcOwn
Type: mo:Owner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
A value that indicates how this object was created. For internal use only.
| |
Constants |
local |
0 |
Local |
NO COMMENTS
|
policy |
1 |
Policy |
NO COMMENTS
|
replica |
2 |
Replica |
NO COMMENTS
|
resolveOnBehalf |
3 |
ResolvedOnBehalf |
NO COMMENTS
|
implicit |
4 |
Implicit |
NO COMMENTS
|
DEFAULT |
local(0) |
Local |
NO COMMENTS
|
|
modTs
Type: mo:TStamp
Primitive Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
The time when this object was last modified.
| |
Constants |
never |
0ull |
never |
NO COMMENTS
|
DEFAULT |
never(0ull) |
never |
NO COMMENTS
|
|
name
Type: naming:Name
Primitive Type: string:Basic
Overrides:naming:NamedObject:name
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
Range: min: "1" max: "16"
Allowed Chars:
Regex: [a-zA-Z0-9_.:-]+
Comments:
-
The user-configured name for the query.
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
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.
rspSubtree
Type: config:RspSubtreeDepth
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The subtree information that should be included in objects returned from the query.
| |
Constants |
no |
0 |
no |
NO COMMENTS
|
children |
1 |
children |
NO COMMENTS
|
full |
2 |
full |
NO COMMENTS
|
DEFAULT |
no(0) |
no |
NO COMMENTS
|
|
rspSubtreeInclude
Type: config:RspSubtreeInclude
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The types of subtrees for the objects returned from the query.
| |
Constants |
none |
0u |
none |
NO COMMENTS
|
custom-path-hop |
0x1000000u |
custom-path-hop |
NO COMMENTS
|
add-mo-list |
0x100000u |
add-mo-list |
NO COMMENTS
|
local-prefix |
0x10000u |
local-prefix |
NO COMMENTS
|
count |
0x1000u |
count |
NO COMMENTS
|
fault-records |
0x100u |
fault-records |
NO COMMENTS
|
relations |
0x10u |
relations |
NO COMMENTS
|
tasks |
0x1u |
tasks |
NO COMMENTS
|
pending-deployment |
0x2000000u |
pending-deployment |
NO COMMENTS
|
deployment-records |
0x200000u |
deployment-records |
NO COMMENTS
|
fault-count |
0x20000u |
fault-count |
NO COMMENTS
|
health-records |
0x2000u |
health-records |
NO COMMENTS
|
audit-logs |
0x200u |
audit-logs |
NO COMMENTS
|
no-scoped |
0x20u |
no-scoped |
NO COMMENTS
|
faults |
0x2u |
faults |
NO COMMENTS
|
ep-records |
0x400000u |
ep-records |
NO COMMENTS
|
relations-with-parent |
0x40000u |
relations-with-parent |
NO COMMENTS
|
port-deployment |
0x4000u |
port-deployment |
NO COMMENTS
|
event-logs |
0x400u |
event-logs |
NO COMMENTS
|
state |
0x40u |
state |
NO COMMENTS
|
stats |
0x4u |
stats |
NO COMMENTS
|
full-deployment |
0x800000u |
full-deployment |
NO COMMENTS
|
record-subtree |
0x80000u |
record-subtree |
NO COMMENTS
|
deployment |
0x8000u |
deployment |
NO COMMENTS
|
required |
0x800u |
required |
NO COMMENTS
|
health |
0x80u |
health |
NO COMMENTS
|
config-only |
0x8u |
config-only |
NO COMMENTS
|
DEFAULT |
none(0u) |
none |
NO COMMENTS
|
|
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.
|
|
target
Type: config:QueryTarget
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
A property to specify if the subtree information should be included for the objects returned by this query.
| |
Constants |
self |
0 |
self |
NO COMMENTS
|
children |
1 |
children |
NO COMMENTS
|
subtree |
2 |
subtree |
NO COMMENTS
|
DEFAULT |
self(0) |
self |
NO COMMENTS
|
|
type
Type: config:QueryType
Primitive Type: scalar:Enum16
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
-
The type of query. The type can be a class-name or a distinguished-name.
| |
Constants |
dn |
0 |
dn |
NO COMMENTS
|
class |
1 |
class |
NO COMMENTS
|
DEFAULT |
dn(0) |
dn |
NO COMMENTS
|
|
uid
Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Comments:
-
A unique identifier for this object.