node
Usage: pmc node [OPTIONS] COMMAND [ARGS]...
Node commands
Options:
-h, --help Show this message and exit
Commands:
register Registers a node
update Update node information
replace Replace a node with a new one (Used to rotate keypairs). Add
the keys to the nodes to the client configuration as
comma-delimited list:
disable Disables node and removes it from clusters, cluster replicas,
blockchain replicas
enable Enables node
remove Removes disabled node
info Get node info for given node pubkey
blockchains List blockchains for node
containers List containers for node
list List all nodes
The node command (pmc node
) consists of sub-commands used to manage nodes.
register
To register a node, use the (pmc node register
) command.
Usage: pmc node register [OPTIONS]
Registers a node
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Node pubkey
-h, --host TEXT Host
-p, --port INT Port
-a, --api-url TEXT api url
-c, --cluster TEXT comma delimited list of clusters this node
belongs to
--capability [SYSTEM_MANAGED] Node capability
--help Show this message and exit
The register command (pmc node register
) registers a node to one or several clusters in the network. You have to provide information about the nodes pubkey
, api-url
, host
, and port
where the node is hosted and the clusters to which the node belongs. host
is your static IP (please note that the same IP should also be used in the api-url
).
- To register a node to a cluster, use the following:
pmc node register --pubkey <node-pub-key> --host <ip> -port 9870 --api-url <https://<ip>:7740> --cluster <example-cluster>
update
To update a node, use the (pmc node update
) command.
Usage: pmc node update [OPTIONS]
Update node information
Options:
-cfg, --config VALUE Configuration file for PMC (overrides
system configuration)
-pk, --pubkey VALUE Public key
-h, --host TEXT Host
-p, --port INT Port
-a, --api-url TEXT api url
-c, --cluster TEXT comma delimited list of clusters to add
this node to
--add-capability [SYSTEM_MANAGED]
Node capability
--remove-capability [SYSTEM_MANAGED]
Node capability
--help Show this message and exit
The update command (pmc node update
) updates information regarding the node to the network.
Example usage:
pmc node update --api-url https://node0-delta.chromia.dev:7740 --pubkey 000000000
replace
To replace a node, use the (pmc node replace
) command.
Usage: pmc node replace [OPTIONS]
Replace a node with a new one (Used to rotate keypairs). Add the keys to the
nodes to the client configuration as comma-delimited list:
pubkey=<key>,<old-node-key>,<new-node-key>
privkey=<key>,<old-node-key>,<new-node-key>
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
--old-key VALUE Public key of the node to replace
--new-key VALUE Public key of the new node
-h, --host TEXT Host
-p, --port INT Port
-a, --api-url TEXT api url
--help Show this message and exit
The replace command (pmc node replace
) replaces a node given by its public key with a new node. It adds the keys to the nodes in the configuration.
Example usage:
pmc node replace --old-key 00000D --new-key 00008
disable
To disable a node, use the (pmc node disable
) command.
Usage: pmc node disable [OPTIONS]
Disables node and removes it from clusters, cluster replicas, blockchain
replicas
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Public key
-h, --help Show this message and exit
The disable command (pmc node disable
) disables a node and removes it from clusters as well as cluster and blockchain replicas.
enable
Usage: pmc node enable [OPTIONS]
Enables node
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Public key
-h, --help Show this message and exit
The enable command (pmc node enable
) enables a disabled node.
remove
Usage: pmc node remove [OPTIONS]
Removes disabled node
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Public key
-h, --help Show this message and exit
The remove command (pmc node remove
) removes a node from a network. The node has to be disabled (pmc node disable
) before it can be removed.
info
Usage: pmc node info [OPTIONS]
Get node info for given node pubkey
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Public key
-h, --help Show this message and exit
The info command (pmc node info
) shows information about a given node by its public key.
Example usage:
pmc node info --pubkey 0000B
blockchains
Usage: pmc node blockchains [OPTIONS]
List blockchains for node
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Public key
-h, --help Show this message and exit
The blockchains command (pmc node blockchians
) lists blockchains running on a node.
containers
Usage: pmc node containers [OPTIONS]
List containers for node
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-pk, --pubkey VALUE Public key
-h, --help Show this message and exit
The containers command (pmc node containers
) gives a list of containers the node is part of.
list
Usage: pmc node list [OPTIONS]
List all nodes
Options:
-cfg, --config VALUE Configuration file for PMC (overrides system
configuration)
-h, --help Show this message and exit
The list command (pmc node list
) lists all nodes in the network.