THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
value | type |
|---|---|
1 | uint8 |
2 | uint16 |
3 | uint32 |
4 | uint64 |
6 | str8 |
7 | str16 |
8 | absTime(uint64) |
9 | deltaTime(uint64) |
10 | objectReference(uint64bin128) |
11 | boolean(uint8) |
12 | float |
13 | double |
14 | uuid |
15 | map |
16 | int8 |
17 | int16 |
18 | int32 |
19 | int64 |
...
| No Format |
|---|
+-----+-----+-----+-----+-----------------------+
| 'A' | 'M' | '2' | 'G' | seq |
+-----+-----+-----+-----+-----------------------+----------+
| Get request field table (map) |
+----------------------------------------------------------+
|
The content of a get request is a field table that specifies what objects are being requested. Most of the fields are optional and are available for use in more extensive deployments.
Field Key | Mandatory | Type | Description | ||
|---|---|---|---|---|---|
"_class" | yesstr8 | short-string | The name of the class of objects being requested. | ||
"_package" | nostr8 | short-string | The name of the extension package the class belongs to. If omitted, the package defaults to "qpid" for access to objects in the connected broker. | ||
"_agent" | no | uuid | objectid | bin128 | The object ID of the object being requestedThe management agent that is the target of the request. If omitted, agent defaults to the connected broker. |
When the management agent receives a get request, it sends content messages describing the requested objects. Once the last content message is sent, it then sends a Command Completion message with the same sequence number supplied in the request to indicate to the requestor that there are no more messages coming.
...
| No Format |
|---|
+-----+-----+-----+-----+-----------------------+
| 'A' | 'M' | '2' | 'M' | seq |
+-----+-----+-----+-----+-----------------------+
| objectId (uint64bin128) |
+-----------------------------------------------+
| methodNamepackage name (str8) |
+-----------------------------------------------+------------------------+
| class name (str8) input and bidirectional argument values (in schema order) |
+-----------------------------------------------------------+
| class hash (bin128) |
+-----------------------------------------------+
| methodName (str8) |
+-----------------------------------------------+------------------------+
| input and bidirectional argument values (in schema order) |
+------------------------------------------------------------------------+
|
Method Response
Method reply messages have the following structure. The sequence number is identical to that supplied in the method request. The status code (and text) indicate whether or not the method was successful and if not, what the error was. Output and bidirectional arguments are only included if the status code was 0 (STATUS_OK).
| No Format |
|---|
+-----+-----+-----+-----+-----------------------+
| 'A' | 'M' | '2' | 'm' | seq |
+-----+-----+-----+-----+-----------------------+
| status code (uint32) |
+-----------------------+----------------------------------+
| status text (str8str16) |
+-----------------------+----------------------------------+-------------+
| output and bidirectional argument values (in schema order) |
+------------------------------------------------------------------------+
|
status code values are:
value | description | ||
|---|---|---|---|
0 | STATUS_OK - successful completion | ||
1 | STATUS_UNKNOWN_OBJECT - objectId not found in the agent | ||
2 | STATUS_UNKNOWN_METHOD - method is not known by the object typeby the object type | ||
3 | STATUS_NOT_IMPLEMENTED - method is not currently implemented | ||
4 | STATUS_INVALID_PARAMETER - input argument is invalid | ||
5 | STATUS_FEATURE_NOT_IMPLEMENTED | ||
6 | STATUS_FORBIDDEN - operation is forbidden by Access Control List | ||
7 | STATUS_EXCEPTION - exception caught during method execution | 3 | STATUS_NOT_IMPLEMENTED - method is not currently implemented |
Messages for Extended Scenario
...
| No Format |
|---|
Broker Remote Agent
| |
| <----------------------------------------- Attach Request --- |
| --- Attach Response ----------------------------------------> |
| |
| <------------------------------------- Package Indication --- |
| <------------------------------------- Package Indication --- |
| |
| <--------------------------------------- Class Indication --- |
| <--------------------------------------- Class Indication --- |
| <--------------------------------------- Class Indication --- |
| <--------------------------------------- Class Indication --- |
| <--------------------------------------- Class Indication --- |
| |
| --- Schema Request (class key) -----------------------------> |
| <---------------------------------------- Schema Response --- |
| |
| --- Schema Request (class key) -----------------------------> |
| <---------------------------------------- Schema Response --- |
| |
| |
|
Extended Opcodes
opcode | message | description |
|---|---|---|
'P' | Package Query | This message contains a schema package query request, requesting that the broker dump the list of known packages |
'p' | Package Indication | This message contains a schema package indication, identifying a package known by the broker |
'A' | Agent Attach Request | This message is sent by a remote agent when it wishes to attach to a management broker |
'a' | Agent Attach Response | The management broker sends this response if an attaching remote agent is permitted to join |
'x' | Console Added Indication | This message is sent to all remote agents by the management broker when a new console binds to the management exchange |
...
| No Format |
|---|
+-----+-----+-----+-----+-----------------------+
| 'A' | 'M' | '2' | 'p' | seq |
+-----+-----+-----+-----+-----------------------+----------+
| package name (str8) |
+----------------------------------------------------------+
|
Agent Attach Request
| No Format |
|---|
+-----+-----+-----+-----+-----------------------+
| 'A' | 'M' | '2' | 'A' | seq |
+-----+-----+-----+-----+-----------------------+----------+
| label (str8) |
+-----------------------+-----------------------------------+
| system-id (uuid) |
+---------------------------------+------------------------+
| requested broker bank (uint32) |
+---------------------------------+
| requested objIdagent bank (uint32) |
+---------------------------------+
|
Agent Attach Response (success)
| No Format |
|---|
+-----+-----+-----+-----+-----------------------+
| 'A' | 'M' | '2' | 'a' | seq |
+-----+-----+-----+-----+--------+---------------+
| assigned broker bank (uint32) |
+--------------------------------+
| assigned objIdagent bank (uint32) |
+--------------------------------+
|
Console Added Indication
...