crossbar.shell.command¶

Classes¶

`Cmd`
`CmdAdd`
`CmdAddApplicationRealmRole`	MREALM: Add a role to an application realm.
`CmdAddPrincipal`	MREALM: Add a principal to an application realm.
`CmdAddPrincipalCredential`	MREALM: Add a credential to a principal.
`CmdAddRolePermission`	MREALM: Add a permission to a role.
`CmdAddRouterClusterNode`	MREALM: Add a node to a routercluster.
`CmdAddRouterClusterWorkerGroup`	MREALM: Add a workergroup to a routercluster.
`CmdAddWebClusterNode`	MREALM: Add a node to a webcluster.
`CmdAddWebClusterService`	MREALM: Add a service to a webcluster.
`CmdCreate`
`CmdCreateApplicationRealm`	MREALM REALM: Create a new application realm.
`CmdCreateDockerContainer`	MREALM: Create a Docker container on a node.
`CmdCreateManagementRealm`	GLOBAL REALM: Create a new management realm.
`CmdCreateRole`	MREALM REALM: Create a new role (for use with application realms).
`CmdCreateRouterCluster`	MREALM: Create a routercluster.
`CmdCreateWebCluster`	MREALM: Create a webcluster.
`CmdCreateWebService`	MREALM: Create a webservice (within a webcluster).
`CmdDelete`
`CmdDeleteApplicationRealm`
`CmdDeleteManagementRealm`
`CmdDeleteRole`
`CmdDeleteRouterCluster`	MREALM: delete routercluster by UUID.
`CmdDeleteWebCluster`	MREALM: delete webcluster by UUID.
`CmdGetDomainLicense`	GLOBAL REALM: get domain software stack license.
`CmdGetDomainStatus`	GLOBAL REALM or MREALM: get system status.
`CmdGetDomainVersion`	GLOBAL REALM: get domain controller software version.
`CmdList`
`CmdListARealmRoles`	MREALM: Get list of roles associated with the given application realm defined on a mrealm.
`CmdListARealms`	MREALM: Get list of application realms defined on a mrealm.
`CmdListDockerContainers`	MREALM: Get list of Docker containers on a node.
`CmdListDockerImages`	MREALM: Get list of Docker images available on a node.
`CmdListManagementRealms`	GLOBAL REALM: Get list of management realms.
`CmdListNodes`	GLOBAL REALM: Get list of nodes in management realms.
`CmdListPrincipalCredentials`	MREALM: Get list of credentials of a principal.
`CmdListPrincipals`	MREALM: Get list of principals defined on a mrealm.
`CmdListRolePermissions`	MREALM: Get list of permissions defined for a role.
`CmdListRoles`	MREALM: Get list of roles defined on a mrealm.
`CmdListRouterClusterNodes`	MREALM: Get list of nodes associated with a routercluster.
`CmdListRouterClusterWorkerGroups`	MREALM: Get list of workergroups running in a routercluster.
`CmdListRouterClusters`	MREALM: Get list of webclusters defined on a mrealm.
`CmdListRouterRealms`
`CmdListRouterTransports`
`CmdListWebClusterNodes`	MREALM: Get list of nodes associated with a webcluster.
`CmdListWebClusterWebService`	MREALM: Get list of webcluster-webservices defined on a webcluster.
`CmdListWebClusters`	MREALM: Get list of webclusters defined on a mrealm.
`CmdListWorkers`	MREALM: Get list of workers on a node.
`CmdPair`
`CmdPairNode`	GLOBAL REALM: Pair a node to a management realm.
`CmdRemove`
`CmdRemoveArealmPrincipal`
`CmdRemoveArealmPrincipalCredential`
`CmdRemoveArealmRole`
`CmdRemoveRolePermission`
`CmdRemoveRouterClusterNode`
`CmdRemoveRouterClusterWorkerGroup`
`CmdRemoveWebClusterNode`
`CmdRemoveWebClusterService`
`CmdRunResult`
`CmdShow`
`CmdShowARealmRole`	MREALM: show application realm role association.
`CmdShowApplicationRealm`	MREALM: show application realm by UUID or name.
`CmdShowComponent`
`CmdShowDocker`
`CmdShowDockerContainer`
`CmdShowDockerImage`
`CmdShowFabric`
`CmdShowManagementRealm`
`CmdShowNode`
`CmdShowPrincipal`	MREALM: show principal on an application realm role.
`CmdShowRealm`
`CmdShowRole`	MREALM: show role by UUID or name.
`CmdShowRolePermission`	MREALM: show role permission by role UUID or name, and optionally URI
`CmdShowRouterCluster`	MREALM: show webcluster by UUID or name.
`CmdShowRouterClusterNode`	MREALM: show routercluster-node by (UUID, UUID).
`CmdShowRouterClusterWorkerGroup`	MREALM: show routercluster workergroup by UUID or name.
`CmdShowTransport`
`CmdShowWebCluster`	MREALM: show webcluster by UUID or name.
`CmdShowWebClusterNode`	MREALM: show webcluster-node by (UUID, UUID).
`CmdShowWebClusterWebService`	MREALM: show webcluster-webservice by (UUID, UUID).
`CmdShowWorker`
`CmdStart`
`CmdStartApplicationRealm`
`CmdStartContainerComponent`
`CmdStartContainerWorker`
`CmdStartDockerContainer`
`CmdStartGuestWorker`
`CmdStartRouterCluster`
`CmdStartRouterRealm`
`CmdStartRouterTransport`
`CmdStartRouterWorker`
`CmdStartWebCluster`
`CmdStartWebTransportService`
`CmdStartWorker`
`CmdStop`
`CmdStopDockerContainer`
`CmdStopRouterCluster`
`CmdStopRouterRealm`
`CmdStopRouterTransport`
`CmdStopWebCluster`
`CmdStopWorker`
`CmdUnpair`
`CmdUnpairNode`	GLOBAL REALM: Unpair a node currently paired to a management realm.

Module Contents¶

class Cmd[source]¶

Bases: object

_post(session, result)[source]¶

_pre(session)[source]¶

_started = None[source]¶

class CmdAdd[source]¶: Bases: Cmd

class CmdAddApplicationRealmRole(arealm, role, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a role to an application realm.

arealm[source]¶

config = None[source]¶

role[source]¶

async run(session)[source]¶

class CmdAddPrincipal(arealm, principal, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a principal to an application realm.

arealm[source]¶

config[source]¶

async run(session)[source]¶

class CmdAddPrincipalCredential(arealm, principal, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a credential to a principal.

arealm[source]¶

config[source]¶

principal[source]¶

async run(session)[source]¶

class CmdAddRolePermission(role, uri, config)[source]¶

Bases: CmdAdd

MREALM: Add a permission to a role.

config[source]¶

role[source]¶

async run(session)[source]¶

uri[source]¶

class CmdAddRouterClusterNode(routercluster, node, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a node to a routercluster.

config = None[source]¶

node[source]¶

routercluster[source]¶

async run(session)[source]¶

class CmdAddRouterClusterWorkerGroup(cluster, workergroup, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a workergroup to a routercluster.

cluster[source]¶

config = None[source]¶

async run(session)[source]¶

workergroup[source]¶

class CmdAddWebClusterNode(webcluster, node, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a node to a webcluster.

config = None[source]¶

node[source]¶

async run(session)[source]¶

webcluster[source]¶

class CmdAddWebClusterService(webcluster, path, config=None)[source]¶

Bases: CmdAdd

MREALM: Add a service to a webcluster.

config = None[source]¶

path[source]¶

async run(session)[source]¶

webcluster[source]¶

class CmdCreate[source]¶: Bases: Cmd

class CmdCreateApplicationRealm(realm)[source]¶

Bases: CmdCreate

MREALM REALM: Create a new application realm.

realm[source]¶

async run(session)[source]¶

class CmdCreateDockerContainer(node, image, config)[source]¶

Bases: CmdCreate

MREALM: Create a Docker container on a node.

config[source]¶

image[source]¶

node[source]¶

async run(session)[source]¶

class CmdCreateManagementRealm(realm)[source]¶

Bases: CmdCreate

GLOBAL REALM: Create a new management realm.

realm[source]¶

async run(session)[source]¶

class CmdCreateRole(role)[source]¶

Bases: CmdCreate

MREALM REALM: Create a new role (for use with application realms).

role[source]¶

async run(session)[source]¶

class CmdCreateRouterCluster(routercluster)[source]¶

Bases: CmdCreate

MREALM: Create a routercluster.

routercluster[source]¶

async run(session)[source]¶

class CmdCreateWebCluster(webcluster)[source]¶

Bases: CmdCreate

MREALM: Create a webcluster.

async run(session)[source]¶

webcluster[source]¶

class CmdCreateWebService(webcluster_oid, webservice)[source]¶

Bases: CmdCreate

MREALM: Create a webservice (within a webcluster).

async run(session)[source]¶

webcluster_oid[source]¶

webservice[source]¶

class CmdDelete[source]¶: Bases: Cmd

class CmdDeleteApplicationRealm(realm, cascade)[source]¶

Bases: CmdDelete

cascade[source]¶

realm[source]¶

async run(session)[source]¶

class CmdDeleteManagementRealm(realm, cascade)[source]¶

Bases: CmdDelete

cascade[source]¶

realm[source]¶

async run(session)[source]¶

class CmdDeleteRole(role)[source]¶

Bases: CmdDelete

role[source]¶

async run(session)[source]¶

class CmdDeleteRouterCluster(routercluster)[source]¶

Bases: CmdDelete

MREALM: delete routercluster by UUID.

routercluster[source]¶

async run(session)[source]¶

class CmdDeleteWebCluster(webcluster)[source]¶

Bases: CmdDelete

MREALM: delete webcluster by UUID.

async run(session)[source]¶

webcluster[source]¶

class CmdGetDomainLicense(realm=None)[source]¶

Bases: Cmd

GLOBAL REALM: get domain software stack license.

realm = None[source]¶

async run(session)[source]¶

class CmdGetDomainStatus(realm=None)[source]¶

Bases: Cmd

GLOBAL REALM or MREALM: get system status.

realm = None[source]¶

async run(session)[source]¶

class CmdGetDomainVersion(realm=None)[source]¶

Bases: Cmd

GLOBAL REALM: get domain controller software version.

realm = None[source]¶

async run(session)[source]¶

class CmdList[source]¶: Bases: Cmd

class CmdListARealmRoles(arealm, names=False)[source]¶

Bases: CmdList

MREALM: Get list of roles associated with the given application realm defined on a mrealm.

arealm[source]¶

names = False[source]¶

async run(session)[source]¶

class CmdListARealms(names=False)[source]¶

Bases: CmdList

MREALM: Get list of application realms defined on a mrealm.

names = False[source]¶

async run(session)[source]¶

class CmdListDockerContainers(node)[source]¶

Bases: CmdList

MREALM: Get list of Docker containers on a node.

node[source]¶

async run(session)[source]¶

class CmdListDockerImages(node)[source]¶

Bases: CmdList

MREALM: Get list of Docker images available on a node.

node[source]¶

async run(session)[source]¶

class CmdListManagementRealms(names=None)[source]¶

Bases: CmdList

GLOBAL REALM: Get list of management realms.

names = None[source]¶

async run(session)[source]¶

class CmdListNodes(online=None, offline=None, names=None)[source]¶

Bases: CmdList

GLOBAL REALM: Get list of nodes in management realms.

names = None[source]¶

offline = None[source]¶

online = None[source]¶

async run(session)[source]¶

class CmdListPrincipalCredentials(arealm, principal)[source]¶

Bases: CmdList

MREALM: Get list of credentials of a principal.

arealm[source]¶

principal[source]¶

async run(session)[source]¶

class CmdListPrincipals(arealm, names=False)[source]¶

Bases: CmdList

MREALM: Get list of principals defined on a mrealm.

arealm[source]¶

names = False[source]¶

async run(session)[source]¶

class CmdListRolePermissions(role)[source]¶

Bases: CmdList

MREALM: Get list of permissions defined for a role.

role[source]¶

async run(session)[source]¶

class CmdListRoles(names=False)[source]¶

Bases: CmdList

MREALM: Get list of roles defined on a mrealm.

names = False[source]¶

async run(session)[source]¶

class CmdListRouterClusterNodes(cluster, names=None, filter_status=None)[source]¶

Bases: CmdList

MREALM: Get list of nodes associated with a routercluster.

cluster[source]¶

filter_status = None[source]¶

names = None[source]¶

async run(session)[source]¶

class CmdListRouterClusterWorkerGroups(cluster, names=None, filter_status=None)[source]¶

Bases: CmdList

MREALM: Get list of workergroups running in a routercluster.

cluster[source]¶

filter_status = None[source]¶

names = None[source]¶

async run(session)[source]¶

class CmdListRouterClusters(names=False)[source]¶

Bases: CmdList

MREALM: Get list of webclusters defined on a mrealm.

names = False[source]¶

async run(session)[source]¶

class CmdListRouterRealms(node, worker)[source]¶

Bases: CmdList

node[source]¶

async run(session)[source]¶

worker[source]¶

class CmdListRouterTransports(node, worker)[source]¶

Bases: CmdList

node[source]¶

async run(session)[source]¶

worker[source]¶

class CmdListWebClusterNodes(cluster, names=None, filter_status=None)[source]¶

Bases: CmdList

MREALM: Get list of nodes associated with a webcluster.

cluster[source]¶

filter_status = None[source]¶

names = None[source]¶

async run(session)[source]¶

class CmdListWebClusterWebService(webcluster)[source]¶

Bases: CmdList

MREALM: Get list of webcluster-webservices defined on a webcluster.

async run(session)[source]¶

webcluster[source]¶

class CmdListWebClusters(names=False)[source]¶

Bases: CmdList

MREALM: Get list of webclusters defined on a mrealm.

names = False[source]¶

async run(session)[source]¶

class CmdListWorkers(node)[source]¶

Bases: CmdList

MREALM: Get list of workers on a node.

node[source]¶

async run(session)[source]¶

class CmdPair[source]¶: Bases: Cmd

class CmdPairNode(realm, pubkey, node_id, authextra=None)[source]¶

Bases: CmdPair

GLOBAL REALM: Pair a node to a management realm.

authextra = None[source]¶

node_id[source]¶

pubkey[source]¶

realm[source]¶

async run(session)[source]¶

class CmdRemove[source]¶: Bases: Cmd

class CmdRemoveArealmPrincipal(arealm, principal)[source]¶

Bases: CmdRemove

arealm[source]¶

principal[source]¶

async run(session)[source]¶

class CmdRemoveArealmPrincipalCredential(arealm, principal, credential)[source]¶

Bases: CmdRemove

arealm[source]¶

credential[source]¶

principal[source]¶

async run(session)[source]¶

class CmdRemoveArealmRole(arealm, role)[source]¶

Bases: CmdRemove

arealm[source]¶

role[source]¶

async run(session)[source]¶

class CmdRemoveRolePermission(role, path)[source]¶

Bases: CmdRemove

path[source]¶

role[source]¶

async run(session)[source]¶

class CmdRemoveRouterClusterNode(cluster, node)[source]¶

Bases: CmdRemove

cluster[source]¶

node[source]¶

async run(session)[source]¶

class CmdRemoveRouterClusterWorkerGroup(cluster, workergroup)[source]¶

Bases: CmdRemove

cluster[source]¶

async run(session)[source]¶

workergroup[source]¶

class CmdRemoveWebClusterNode(cluster, node)[source]¶

Bases: CmdRemove

cluster[source]¶

node[source]¶

async run(session)[source]¶

class CmdRemoveWebClusterService(webcluster, path)[source]¶

Bases: CmdRemove

path[source]¶

async run(session)[source]¶

webcluster[source]¶

class CmdRunResult(result, duration=None)[source]¶

Bases: object

__str__()[source]¶

duration = None[source]¶

result[source]¶

class CmdShow[source]¶: Bases: Cmd

class CmdShowARealmRole(arealm, role)[source]¶

Bases: CmdShow

MREALM: show application realm role association.

arealm[source]¶

role[source]¶

async run(session)[source]¶

class CmdShowApplicationRealm(arealm)[source]¶

Bases: CmdShow

MREALM: show application realm by UUID or name.

arealm[source]¶

async run(session)[source]¶

class CmdShowComponent(node, worker, component)[source]¶

Bases: CmdShow

component[source]¶

node[source]¶

async run(session)[source]¶

worker[source]¶

class CmdShowDocker(node, status=True)[source]¶

Bases: CmdShow

node[source]¶

async run(session)[source]¶

status = True[source]¶

class CmdShowDockerContainer(node, container)[source]¶

Bases: CmdShow

container[source]¶

node[source]¶

async run(session)[source]¶

class CmdShowDockerImage(node, image)[source]¶

Bases: CmdShow

image[source]¶

node[source]¶

async run(session)[source]¶

class CmdShowFabric[source]¶

Bases: CmdShow

async run(session)[source]¶

class CmdShowManagementRealm(realm)[source]¶

Bases: CmdShow

realm[source]¶

async run(session)[source]¶

class CmdShowNode(node=None)[source]¶

Bases: CmdShow

node = None[source]¶

async run(session)[source]¶

class CmdShowPrincipal(arealm, principal)[source]¶

Bases: CmdShow

MREALM: show principal on an application realm role.

arealm[source]¶

principal[source]¶

async run(session)[source]¶

class CmdShowRealm(node, worker, realm)[source]¶

Bases: CmdShow

node[source]¶

realm[source]¶

async run(session)[source]¶

worker[source]¶

class CmdShowRole(role)[source]¶

Bases: CmdShow

MREALM: show role by UUID or name.

role[source]¶

async run(session)[source]¶

class CmdShowRolePermission(role, uri)[source]¶

Bases: CmdShow

MREALM: show role permission by role UUID or name, and optionally URI

role[source]¶

async run(session)[source]¶

uri[source]¶

class CmdShowRouterCluster(cluster)[source]¶

Bases: CmdShow

MREALM: show webcluster by UUID or name.

cluster[source]¶

async run(session)[source]¶

class CmdShowRouterClusterNode(cluster, node)[source]¶

Bases: CmdShow

MREALM: show routercluster-node by (UUID, UUID).

cluster[source]¶

node[source]¶

async run(session)[source]¶

class CmdShowRouterClusterWorkerGroup(cluster, workergroup)[source]¶

Bases: CmdShow

MREALM: show routercluster workergroup by UUID or name.

cluster[source]¶

async run(session)[source]¶

workergroup[source]¶

class CmdShowTransport(node, worker, transport)[source]¶

Bases: CmdShow

node[source]¶

async run(session)[source]¶

transport[source]¶

worker[source]¶

class CmdShowWebCluster(cluster)[source]¶

Bases: CmdShow

MREALM: show webcluster by UUID or name.

cluster[source]¶

async run(session)[source]¶

class CmdShowWebClusterNode(cluster, node)[source]¶

Bases: CmdShow

MREALM: show webcluster-node by (UUID, UUID).

cluster[source]¶

node[source]¶

async run(session)[source]¶

class CmdShowWebClusterWebService(cluster, path)[source]¶

Bases: CmdShow

MREALM: show webcluster-webservice by (UUID, UUID).

cluster[source]¶

path[source]¶

async run(session)[source]¶

class CmdShowWorker(node, worker)[source]¶

Bases: CmdShow

node[source]¶

async run(session)[source]¶

worker[source]¶

class CmdStart[source]¶: Bases: Cmd

class CmdStartApplicationRealm(arealm, routercluster, workergroup, webcluster)[source]¶

Bases: CmdStart

arealm[source]¶

routercluster[source]¶

async run(session)[source]¶

webcluster[source]¶

workergroup[source]¶

class CmdStartContainerComponent(node_id, worker_id, component_id, config=None)[source]¶

Bases: CmdStart

component_id[source]¶

node_id[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdStartContainerWorker(node_id, worker_id, process_title=None)[source]¶

Bases: CmdStart

node_id[source]¶

process_title = None[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdStartDockerContainer(node, container)[source]¶

Bases: CmdStart

container[source]¶

node[source]¶

async run(session)[source]¶

class CmdStartGuestWorker(node_id, worker_id, config=None)[source]¶

Bases: CmdStart

node_id[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdStartRouterCluster(routercluster)[source]¶

Bases: CmdStart

routercluster[source]¶

async run(session)[source]¶

class CmdStartRouterRealm(node_id, worker_id, realm_id, config=None)[source]¶

Bases: CmdStart

node_id[source]¶

realm_id[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdStartRouterTransport(node_id, worker_id, transport_id, config=None)[source]¶

Bases: CmdStart

node_id[source]¶

async run(session)[source]¶

transport_id[source]¶

worker_id[source]¶

class CmdStartRouterWorker(node_id, worker_id, process_title=None)[source]¶

Bases: CmdStart

node_id[source]¶

process_title = None[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdStartWebCluster(webcluster)[source]¶

Bases: CmdStart

async run(session)[source]¶

webcluster[source]¶

class CmdStartWebTransportService(node_id, worker_id, transport_id, path, config=None)[source]¶

Bases: CmdStart

node_id[source]¶

path[source]¶

async run(session)[source]¶

transport_id[source]¶

worker_id[source]¶

class CmdStartWorker(node_id, worker_id, worker_type, worker_options=None)[source]¶

Bases: CmdStart

node_id[source]¶

async run(session)[source]¶

worker_id[source]¶

worker_options = None[source]¶

worker_type[source]¶

class CmdStop[source]¶: Bases: Cmd

class CmdStopDockerContainer(node, container)[source]¶

Bases: CmdStop

container[source]¶

node[source]¶

async run(session)[source]¶

class CmdStopRouterCluster(routercluster)[source]¶

Bases: CmdStop

routercluster[source]¶

async run(session)[source]¶

class CmdStopRouterRealm(node_id, worker_id, realm_id)[source]¶

Bases: CmdStop

node_id[source]¶

realm_id[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdStopRouterTransport(node_id, worker_id, transport_id)[source]¶

Bases: CmdStop

node_id[source]¶

async run(session)[source]¶

transport_id[source]¶

worker_id[source]¶

class CmdStopWebCluster(webcluster)[source]¶

Bases: CmdStop

async run(session)[source]¶

webcluster[source]¶

class CmdStopWorker(node_id, worker_id)[source]¶

Bases: CmdStop

node_id[source]¶

async run(session)[source]¶

worker_id[source]¶

class CmdUnpair[source]¶: Bases: Cmd

class CmdUnpairNode(pubkey)[source]¶

Bases: CmdUnpair

GLOBAL REALM: Unpair a node currently paired to a management realm.

pubkey[source]¶

async run(session)[source]¶