crossbar.shell.main

Attributes

USAGE

_HEXKEY

_app

Classes

Config

Command configuration object where we collect all the parameters,

Functions

_make_set_output_format(output_format)

_make_set_output_style(output_style)

_read_pubkey(pubkey)

cli(ctx, dotdir, profile, realm, role, debug)

cmd_add(ctx)

cmd_add_principal(ctx, realm, principal[, config])

cmd_add_principal_credential(ctx, realm, principal[, ...])

cmd_add_realm_role(ctx, realm, role[, config])

cmd_add_role_permission(ctx, role, uri[, config])

cmd_add_routercluster_node(ctx, cluster, node[, config])

cmd_add_routercluster_workergroup(ctx, cluster, ...[, ...])

cmd_add_webcluster_node(ctx, cluster, node[, config])

cmd_add_webcluster_service(ctx, cluster, path[, config])

cmd_auth(ctx, code, new_code, yes)

cmd_clear()

cmd_create(ctx)

cmd_create_application_realm(ctx, realm[, config])

cmd_create_docker_container(ctx, node, image[, config])

cmd_create_management_realm(ctx, realm)

cmd_create_role(ctx, role[, config])

cmd_create_routercluster(ctx, cluster[, config])

cmd_create_webcluster(ctx, cluster[, config])

cmd_create_webservice(ctx, cluster, config)

cmd_current(ctx)

cmd_delete(ctx)

cmd_delete_arealm(ctx, arealm[, cascade])

cmd_delete_management_realm(ctx, realm[, cascade])

cmd_delete_role(ctx, role)

cmd_delete_routercluster(ctx, cluster)

cmd_delete_webcluster(ctx, cluster)

cmd_export(ctx)

cmd_export_database(ctx, dbpath, filename, ...)

cmd_help(ctx)

cmd_import(ctx)

cmd_import_database(ctx, dbpath, filename, ...)

cmd_init(ctx, yes)

cmd_list(ctx)

cmd_list_arealm_roles(ctx, arealm, names)

cmd_list_arealms(ctx, names)

cmd_list_docker_containers(ctx, node)

cmd_list_docker_images(ctx, node)

cmd_list_management_realms(ctx, names)

cmd_list_nodes(ctx[, names, online, offline])

cmd_list_principal_credentials(ctx, arealm, principal)

cmd_list_principals(ctx, arealm, names)

cmd_list_role_permissions(ctx, role)

cmd_list_roles(ctx, names)

cmd_list_router_realms(ctx, node, worker)

cmd_list_router_transports(ctx, node, worker)

cmd_list_routercluster_nodes(ctx, cluster, names, ...)

cmd_list_routercluster_workergroups(ctx, cluster, ...)

cmd_list_routerclusters(ctx, names)

cmd_list_webcluster_nodes(ctx, cluster, names, ...)

cmd_list_webcluster_webservices(ctx, cluster)

cmd_list_webclusters(ctx, names)

cmd_list_workers(ctx, node)

cmd_monitor(ctx)

cmd_pair(ctx)

cmd_pair_node(ctx, pubkey, realm, node_id[, authextra])

cmd_remove(ctx)

cmd_remove_arealm_principal(ctx, arealm, principal)

cmd_remove_arealm_principal_credential(ctx, arealm, ...)

cmd_remove_arealm_role(ctx, arealm, role)

cmd_remove_role_permission(ctx, role, path)

cmd_remove_routeercluster_workergroup(ctx, cluster, ...)

cmd_remove_routercluster_node(ctx, cluster, node)

cmd_remove_webcluster_node(ctx, cluster, node)

cmd_remove_webcluster_service(ctx, cluster, path)

cmd_select(ctx)

cmd_select_node(ctx, resource)

cmd_select_transport(ctx, resource)

cmd_select_worker(ctx, resource)

cmd_set(ctx)

cmd_set_output_format(ctx)

cmd_set_output_style(ctx)

cmd_set_output_verbosity(ctx)

cmd_set_output_verbosity_extended(ctx)

cmd_set_output_verbosity_normal(ctx)

cmd_set_output_verbosity_result_only(ctx)

cmd_set_output_verbosity_silent(ctx)

cmd_shell(ctx)

cmd_show(ctx)

cmd_show_arealm(ctx, arealm)

cmd_show_arealm_role(ctx, arealm, role)

cmd_show_component(ctx, node, worker, component)

cmd_show_database(ctx, dbpath, include_slots)

cmd_show_docker(ctx, node)

cmd_show_docker_container(ctx, node, container)

cmd_show_docker_image(ctx, node, image)

cmd_show_domain_license(ctx)

cmd_show_domain_status(ctx)

cmd_show_domain_version(ctx)

cmd_show_fabric(ctx)

cmd_show_mrealm(ctx, realm)

cmd_show_node(ctx, node)

cmd_show_principal(ctx, realm, principal)

cmd_show_realm(ctx, node, worker, realm)

cmd_show_role(ctx, role)

cmd_show_role_permission(ctx, role, uri)

cmd_show_routercluster(ctx, cluster)

cmd_show_routercluster_node(ctx, cluster, node)

cmd_show_routercluster_workergroup(ctx, cluster, ...)

cmd_show_transport(ctx, node, worker, transport)

cmd_show_webcluster(ctx, cluster)

cmd_show_webcluster_node(ctx, cluster, node)

cmd_show_webcluster_service(ctx, cluster, webservice)

cmd_show_worker(ctx, node, worker)

cmd_start(ctx)

cmd_start_arealm(ctx, arealm, routercluster, ...)

cmd_start_container_component(ctx, node, worker, component)

cmd_start_container_worker(ctx, node, worker[, ...])

cmd_start_docker_container(ctx, node, container)

cmd_start_guest_worker(ctx, node, worker)

cmd_start_router_realm(ctx, node, worker, realm)

cmd_start_router_transport(ctx, node, worker, transport)

cmd_start_router_worker(ctx, node, worker[, process_title])

cmd_start_routercluster(ctx, cluster)

cmd_start_web_transport_service(ctx, node, worker, ...)

cmd_start_webcluster(ctx, cluster)

cmd_stop(ctx)

cmd_stop_docker_container(ctx, node, container)

cmd_stop_router_realm(ctx, node, worker, realm)

cmd_stop_router_transport(ctx, node, worker, transport)

cmd_stop_routercluster(ctx, cluster)

cmd_stop_webcluster(ctx, cluster)

cmd_stop_worker(ctx, node, worker)

cmd_unpair(ctx)

cmd_unpair_node(ctx, pubkey)

cmd_version(ctx)

hl(text)

run()

Main entry point into CLI.

Module Contents

class Config(app, dotdir, profile, realm, role)[source]

Bases: object

Command configuration object where we collect all the parameters, options etc for later processing.

__str__()[source]
app[source]
dotdir[source]
profile[source]
realm[source]
resource = None[source]
resource_type = None[source]
role[source]
USAGE = Multiline-String[source]
Show Value
"""
Examples:
To start the interactive shell, use the "shell" command:

    cbf shell

You can run the shell under different user profile
using the "--profile" option:

    cbf --profile mister-test1 shell
"""
_HEXKEY[source]
_app[source]
_make_set_output_format(output_format)[source]
_make_set_output_style(output_style)[source]
_read_pubkey(pubkey)[source]
cli(ctx, dotdir, profile, realm, role, debug)[source]
cmd_add(ctx)[source]
cmd_add_principal(ctx, realm, principal, config=None)[source]
cmd_add_principal_credential(ctx, realm, principal, config=None)[source]
cmd_add_realm_role(ctx, realm, role, config=None)[source]
cmd_add_role_permission(ctx, role, uri, config=None)[source]
cmd_add_routercluster_node(ctx, cluster, node, config=None)[source]
cmd_add_routercluster_workergroup(ctx, cluster, workergroup, config=None)[source]
cmd_add_webcluster_node(ctx, cluster, node, config=None)[source]
cmd_add_webcluster_service(ctx, cluster, path, config=None)[source]
cmd_auth(ctx, code, new_code, yes)[source]
cmd_clear()[source]
cmd_create(ctx)[source]
cmd_create_application_realm(ctx, realm, config=None)[source]
cmd_create_docker_container(ctx, node, image, config=None)[source]
cmd_create_management_realm(ctx, realm)[source]
cmd_create_role(ctx, role, config=None)[source]
cmd_create_routercluster(ctx, cluster, config=None)[source]
cmd_create_webcluster(ctx, cluster, config=None)[source]
cmd_create_webservice(ctx, cluster, config)[source]
cmd_current(ctx)[source]
cmd_delete(ctx)[source]
cmd_delete_arealm(ctx, arealm, cascade=False)[source]
cmd_delete_management_realm(ctx, realm, cascade=False)[source]
cmd_delete_role(ctx, role)[source]
cmd_delete_routercluster(ctx, cluster)[source]
cmd_delete_webcluster(ctx, cluster)[source]
cmd_export(ctx)[source]
cmd_export_database(ctx, dbpath, filename, include_indexes, include_schemata, exclude_tables, use_json, use_binary_hex_encoding, quiet)[source]
cmd_help(ctx)[source]
cmd_import(ctx)[source]
cmd_import_database(ctx, dbpath, filename, include_indexes, include_schemata, exclude_tables, use_json, use_binary_hex_encoding, quiet)[source]
cmd_init(ctx, yes)[source]
cmd_list(ctx)[source]
cmd_list_arealm_roles(ctx, arealm, names)[source]
cmd_list_arealms(ctx, names)[source]
cmd_list_docker_containers(ctx, node)[source]
cmd_list_docker_images(ctx, node)[source]
cmd_list_management_realms(ctx, names)[source]
cmd_list_nodes(ctx, names=None, online=None, offline=None)[source]
cmd_list_principal_credentials(ctx, arealm, principal)[source]
cmd_list_principals(ctx, arealm, names)[source]
cmd_list_role_permissions(ctx, role)[source]
cmd_list_roles(ctx, names)[source]
cmd_list_router_realms(ctx, node, worker)[source]
cmd_list_router_transports(ctx, node, worker)[source]
cmd_list_routercluster_nodes(ctx, cluster, names, filter_status)[source]
cmd_list_routercluster_workergroups(ctx, cluster, names, filter_status)[source]
cmd_list_routerclusters(ctx, names)[source]
cmd_list_webcluster_nodes(ctx, cluster, names, filter_status)[source]
cmd_list_webcluster_webservices(ctx, cluster)[source]
cmd_list_webclusters(ctx, names)[source]
cmd_list_workers(ctx, node)[source]
cmd_monitor(ctx)[source]
cmd_pair(ctx)[source]
cmd_pair_node(ctx, pubkey, realm, node_id, authextra=None)[source]
Parameters:

  • ctx

  • pubkey – the public key of the node, a 32 bytes Ed25519 public key provided as a HEX string (64 characters), or alternatively a filename to read the public key from

  • realm – management realm the node is to be paired with

  • node_id – the ID of node assigned when the node is connecting

  • authextra – authextra to be provided to the node when connecting, must be a JSON string

Returns:

cmd_remove(ctx)[source]
cmd_remove_arealm_principal(ctx, arealm, principal)[source]
cmd_remove_arealm_principal_credential(ctx, arealm, principal, credential)[source]
cmd_remove_arealm_role(ctx, arealm, role)[source]
cmd_remove_role_permission(ctx, role, path)[source]
cmd_remove_routeercluster_workergroup(ctx, cluster, workergroup)[source]
cmd_remove_routercluster_node(ctx, cluster, node)[source]
cmd_remove_webcluster_node(ctx, cluster, node)[source]
cmd_remove_webcluster_service(ctx, cluster, path)[source]
cmd_select(ctx)[source]
cmd_select_node(ctx, resource)[source]
cmd_select_transport(ctx, resource)[source]
cmd_select_worker(ctx, resource)[source]
cmd_set(ctx)[source]
cmd_set_output_format(ctx)[source]
cmd_set_output_style(ctx)[source]
cmd_set_output_verbosity(ctx)[source]
cmd_set_output_verbosity_extended(ctx)[source]
cmd_set_output_verbosity_normal(ctx)[source]
cmd_set_output_verbosity_result_only(ctx)[source]
cmd_set_output_verbosity_silent(ctx)[source]
cmd_shell(ctx)[source]
cmd_show(ctx)[source]
cmd_show_arealm(ctx, arealm)[source]
cmd_show_arealm_role(ctx, arealm, role)[source]
cmd_show_component(ctx, node, worker, component)[source]
cmd_show_database(ctx, dbpath, include_slots)[source]
cmd_show_docker(ctx, node)[source]
cmd_show_docker_container(ctx, node, container)[source]
cmd_show_docker_image(ctx, node, image)[source]
cmd_show_domain_license(ctx)[source]
cmd_show_domain_status(ctx)[source]
cmd_show_domain_version(ctx)[source]
cmd_show_fabric(ctx)[source]
cmd_show_mrealm(ctx, realm)[source]
cmd_show_node(ctx, node)[source]
cmd_show_principal(ctx, realm, principal)[source]
cmd_show_realm(ctx, node, worker, realm)[source]
cmd_show_role(ctx, role)[source]
cmd_show_role_permission(ctx, role, uri)[source]
cmd_show_routercluster(ctx, cluster)[source]
cmd_show_routercluster_node(ctx, cluster, node)[source]
cmd_show_routercluster_workergroup(ctx, cluster, workergroup)[source]
cmd_show_transport(ctx, node, worker, transport)[source]
cmd_show_webcluster(ctx, cluster)[source]
cmd_show_webcluster_node(ctx, cluster, node)[source]
cmd_show_webcluster_service(ctx, cluster, webservice)[source]
cmd_show_worker(ctx, node, worker)[source]
cmd_start(ctx)[source]
cmd_start_arealm(ctx, arealm, routercluster, workergroup, webcluster)[source]
cmd_start_container_component(ctx, node, worker, component)[source]
cmd_start_container_worker(ctx, node, worker, process_title=None)[source]
cmd_start_docker_container(ctx, node, container)[source]
cmd_start_guest_worker(ctx, node, worker)[source]
cmd_start_router_realm(ctx, node, worker, realm)[source]
cmd_start_router_transport(ctx, node, worker, transport, config=None)[source]
cmd_start_router_worker(ctx, node, worker, process_title=None)[source]
cmd_start_routercluster(ctx, cluster)[source]
cmd_start_web_transport_service(ctx, node, worker, transport, path, config=None)[source]
cmd_start_webcluster(ctx, cluster)[source]
cmd_stop(ctx)[source]
cmd_stop_docker_container(ctx, node, container)[source]
cmd_stop_router_realm(ctx, node, worker, realm)[source]
cmd_stop_router_transport(ctx, node, worker, transport)[source]
cmd_stop_routercluster(ctx, cluster)[source]
cmd_stop_webcluster(ctx, cluster)[source]
cmd_stop_worker(ctx, node, worker)[source]
cmd_unpair(ctx)[source]
cmd_unpair_node(ctx, pubkey)[source]
Parameters:

  • ctx

  • pubkey

Returns:

cmd_version(ctx)[source]
hl(text)[source]
run()[source]

Main entry point into CLI.