Management Realms

ManagementRealm

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

Bases: ConfigurationElement

Management realm database configuration object.

Parameters

  • oid – Object ID of management realm

  • label – Optional user label of management realm

  • description – Optional user description of management realm

  • tags – Optional list of user tags on management realm

  • name – Name of management realm

  • created – Timestamp when the management realm was created

  • owner – Owning user (object ID)

  • cf_router_worker – INTERNAL USE CFC hosting router worker for this management realm

  • cf_container_worker – INTERNAL USE CFC hosting container worker for this management realm

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 cfxdb.globalschema.ManagementRealms(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

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

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

Bases: MapStringUuid

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

Node

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

Bases: ConfigurationElement

Nodes paired with management realms on this master node.

Parameters

  • oid – Object ID of node

  • label – Optional user label of node

  • description – Optional user description of node

  • tags – Optional list of user tags on node

  • owner_oid – Object owner.

  • pubkey – The WAMP-cryptosign node public key (32 bytes as HEX encoded string).

  • cluster_ip – The (private) clustering IP for incoming rlinks to connect to.

  • mrealm_oid – The management realm the node will be joined on.

  • authid – The WAMP authid the node will be authenticated as.

  • authextra – Optional authextra the node will be sent to when authenticating.

  • _unknown – Any unparsed/unprocessed data attributes

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 cfxdb.globalschema.Nodes(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

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

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

Bases: MapStringUuid

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

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

Bases: MapUuidStringUuid

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

class cfxdb.usage.MasterNodeUsage(from_fbs=None)[source]

Bases: object

Persisted master node metering record database object.

marshal()[source]
Returns

static parse(data)[source]
Parameters

data –

Returns

property timestamp
Returns

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

property timestamp_from
Returns

property mrealm_id
Returns

property metering_id
Returns

property pubkey
Returns

property client_ip_address
Returns

property client_ip_version
Returns

property client_ip_port
Returns

property seq
Returns

property sent
Returns

property processed
Returns

property status
Returns

property status_message
Returns

property count
Returns

property total
Returns

property nodes
Returns

property controllers
Returns

property hostmonitors
Returns

property routers
Returns

property containers
Returns

property guests
Returns

property proxies
Returns

property marketmakers
Returns

property sessions
Returns

property msgs_call
Returns

property msgs_yield
Returns

property msgs_invocation
Returns

property msgs_result
Returns

property msgs_error
Returns

property msgs_publish
Returns

property msgs_published
Returns

property msgs_event
Returns

property msgs_register
Returns

property msgs_registered
Returns

property msgs_subscribe
Returns

property msgs_subscribed
Returns

static cast(buf)[source]
Parameters

buf –

Returns

build(builder)[source]
Parameters

builder –

Returns

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

Bases: MapTimestampUuidFlatBuffers

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