Management Realms

ManagementRealm

class ManagementRealm(oid: UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, name: str | None = None, created: datetime | None = None, owner: UUID | None = None, cf_router_worker: str | None = None, cf_container_worker: str | None = None, _unknown=None)[source]

Bases: ConfigurationElement

Management realm database configuration object.

copy(other, overwrite=False)[source]

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other management realm to copy data from.

Returns:

marshal()[source]

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)[source]

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class ManagementRealms(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Management realm database configuration object (oid -> mrealm).

class IndexManagementRealmByName(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of management realms by name (mrealm_name -> mrealm_oid).

Node

class Node(oid: UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, owner_oid: UUID | None = None, pubkey: str | None = None, cluster_ip: str | None = None, mrealm_oid: UUID | None = None, authid: str | None = None, authextra: dict | None = None, _unknown=None)[source]

Bases: ConfigurationElement

Nodes paired with management realms on this master node.

copy(other, overwrite=False)[source]

Copy over other object.

Parameters:

other (instance of ManagementRealm) – Other management realm to copy data from.

Returns:

marshal()[source]

Marshal this object to a generic host language object.

Returns:

dict

static parse(data)[source]

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

class Nodes(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Nodes paired with management realms (node_oid -> node).

class IndexNodesByPubkey(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of nodes by node public key (node_pubkey -> node_oid).

class IndexNodesByAuthid(slot=None, compress=None)[source]

Bases: MapUuidStringUuid

Index of nodes by management realm and node authid ((mrealm_oid, authid) -> node_oid).

class MasterNodeUsage(from_fbs=None)[source]

Bases: object

Persisted master node metering record database object.

build(builder)[source]
Parameters:

builder

Returns:

static cast(buf)[source]
Parameters:

buf

Returns:

property client_ip_address[source]

return:

property client_ip_port[source]

return:

property client_ip_version[source]

return:

property containers[source]

return:

property controllers[source]

return:

property count[source]

return:

property guests[source]

return:

property hostmonitors[source]

return:

property marketmakers[source]

return:

marshal()[source]
Returns:

property metering_id[source]

return:

property mrealm_id[source]

return:

property msgs_call[source]

return:

property msgs_error[source]

return:

property msgs_event[source]

return:

property msgs_invocation[source]

return:

property msgs_publish[source]

return:

property msgs_published[source]

return:

property msgs_register[source]

return:

property msgs_registered[source]

return:

property msgs_result[source]

return:

property msgs_subscribe[source]

return:

property msgs_subscribed[source]

return:

property msgs_yield[source]

return:

property nodes[source]

return:

static parse(data)[source]
Parameters:

data

Returns:

property processed[source]

return:

property proxies[source]

return:

property pubkey[source]

return:

property routers[source]

return:

property sent[source]

return:

property seq[source]

return:

property sessions[source]

return:

property status[source]

return:

property status_message[source]

return:

property timestamp[source]

Timestamp when usage was recorded (at the node of recording).

Type:

return

property timestamp_from[source]

return:

property total[source]

return:

class UsageRecords(slot=None, compress=None, build=None, cast=None)[source]

Bases: MapTimestampUuidFlatBuffers

Usage metering records ((timestamp, usage_oid) -> usage_record).