Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

No Format
          octet 0      1         2         3         4         5         6         7
        +---------+---------+---------+---------+---------+---------+---------+---------+
        |   'A'   |   'M'   |   '12'   | op-code |                sequence               |
        +---------+---------+---------+---------+---------+---------+---------+---------+

The first three octets contain the protocol magic number "AM1AM2" which is used to identify the type and version of the message.

...

Manageable objects are tagged with a unique 64128-bit object identifier. The object identifier space is owned and managed by the management broker. Objects managed by a single management broker shall have unique object identifiers. Objects managed by separate management brokers may have the same object identifier.

If a management console is designed to manage multiple management brokers, it must use the broker identifier as well as the object identifier to ensure global uniqueness.

No Format
first uint64:
         63   60 59    62           48 47                    24 2328 27                           0
        +-------+-------------------+-----------------------+------------------------------+
        |0 flags |      sequence  |   |      broker bank      |    |      agent bank object         |
        +-------+-------------------+-----------------------+------------------------------+

second uint64:
       bit  63        - reserved, must be zero
                                          bits 63 .. 48  - broker boot sequence (32K)
        bits 47 .. 24  - bank (16M)
        bits 23 .. 0   - object (16M)
                          0
        +----------------------------------------------------------------------------------+
        |                                     object                                       |
        +----------------------------------------------------------------------------------+

Field

Size (bits)

Description

flags

 

 

sequence

 

 

broker bank

 

 

agent bank

 

 

object

 

 

  • For persistent IDs, boot-sequence is zero
  • For non-persistent IDs, boot sequence is a constant number which increments each time the management broker is restarted.
  • Bank number:
    • 0 - reserved
    • 1 - broker-persistent objects
    • 2..4 - store-persistent objects
    • > 4 - transient objects

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'B' |           0           |
        +-----+-----+-----+-----+-----------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'b' |           0           |
        +-----+-----+-----+-----+-----------------------+----------------------------+
        | brokerId (uuid)                                                            |
        +----------------------------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'z' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  Completion Code      |
        +-----------------------+-----------------------------------------+
        |  Completion Text                                                |
        +-----------------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'Q' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  package name (str8)                                     |
        +----------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'q' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  package name (str8)                                     |
        +----------------------------------------------------------+
        |  class name (str8)                                       |
        +----------------------------------------------------------+
        |  schema hash (bin128)                                    |
        +----------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'S' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |                packageName (str8)                        |
        +----------------------------------------------------------+
        |                className (str8)                          |
        +----------------------------------------------------------+
        |                schema-hash (bin128)                      |
        +----------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 's' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |                packageName (str8)                        |
        +----------------------------------------------------------+
        |                className (str8)                          |
        +----------------------------------------------------------+
        |                schema-hash (bin128)                      |
        +-----------+-----------+-----------+-----------+----------+
        | propCnt   | statCnt   | methodCnt | eventCnt  |
        +-----------+-----------+-----------+-----------+----------------------------+
        | propCnt property records                                                   |
        +----------------------------------------------------------------------------+
        | statCnt statistic records                                                  |
        +----------------------------------------------------------------------------+
        | methodCnt method records                                                   |
        +----------------------------------------------------------------------------+
        | eventCnt event records                                                     |
        +----------------------------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'h' |           0           |
        +-----+-----+-----+-----+-----------------------+
        | timestamp of current interval (datetime)      |
        +-----------------------------------------------+

...

No Format
        +-----+-----+-----+-------+-----------------------+
        | 'A' | 'M' | '12' |'g/c/i'|          seq          |
        +-----+-----+-----+-------+-----------------------+--------+
        |                packageName (str8)                        |
        +----------------------------------------------------------+
        |                className (str8)                          |
        +----------------------------------------------------------+
        |                class hash (bin128)                       |
        +-----+-----+-----+-----+-----+-----+-----+-----+----------+
        | timestamp of current sample (datetime)        |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | time object was created (datetime)            |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | time object was deleted (datetime)            |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | objectId (uint64)                             |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | presence bitmasks (0 or more uint8 fields)    |
        +-----+-----+-----+-----+-----+-----+-----+-----+------------------------+
        | config/inst values (in schema order)                                   |
        +------------------------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'G' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        | Get request field table                                  |
        +----------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'M' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  objectId (uint64)                            |
        +-----------------------------------------------+
        |  methodName (str8)                            |
        +-----------------------------------------------+------------------------+
        |  input and bidirectional argument values (in schema order)             |
        +------------------------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'm' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  status code          |
        +-----------------------+----------------------------------+
        |  status text (str8)                                      |
        +-----------------------+----------------------------------+-------------+
        |  output and bidirectional argument values (in schema order)            |
        +------------------------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'P' |          seq          |
        +-----+-----+-----+-----+-----------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'p' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  package name (str8)                                     |
        +----------------------------------------------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'A' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  label (str8)                                            |
        +-----------------------+----------------------------------+
        |  system-id (uuid)                                        |
        +-----------------------+----------------------------------+
        |  requested objId bank |
        +-----------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'a' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  assigned broker bank |
        +-----------------------+
        |  assigned objId bank  |
        +-----------------------+

...

No Format
        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '12' | 'x' |          seq          |
        +-----+-----+-----+-----+-----------------------+