Skip to main content

node

Usage: pmc node [OPTIONS] COMMAND [ARGS]...

  Node commands

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  register          Registers a node                                         │
│  register-replica  Registers a replica node                                 │
│  update            Update node information                                  │
│  replace           Replace a node with a new one (used to rotate keypairs)  │
│  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                      │
│  verify            Verify node status                                       │
│  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.

node register​

To register a node, use the (pmc node register) command.

Usage: pmc node register [OPTIONS]

  Registers a node

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE        Node pubkey                                     │
│* -h, --host=TEXT            Host                                            │
│* -p, --port=INT             Port                                            │
│* -a, --api-url=TEXT         api url                                         │
│* -t, --territory=TEXT       ISO 3166-1 alpha-2 code                         │
│  -clu, --cluster-units=INT  Cluster Units (minimum 1) (default: 1)          │
│  -es, --extra-storage=INT   Extra Storage (MiB) (default: 0)                │
│  -c, --cluster=TEXT         Comma delimited list of clusters this node      │
│                             belongs to (default: [])                        │
│                                                                             │
│--capability=(SYSTEM_MANAGED|ETHEREUM_BRIDGE|ETHEREUM_TESTNET_BRIDGE|BCS_BRID│
│                             Node capability (deprecated)                    │
│  --disable-access-checks    Disable node and REST API access checks         │
│  --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>

node register-replica​

Usage: pmc node register-replica [OPTIONS]

  Registers a replica node

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE   Node pubkey                                          │
│  -h, --host=TEXT       Host                                                 │
│  -p, --port=INT        Port (default: 0)                                    │
│  -a, --api-url=TEXT    api url                                              │
│  -t, --territory=TEXT  ISO 3166-1 alpha-2 code                              │
│  --help                Show this message and exit                           │
╰─────────────────────────────────────────────────────────────────────────────╯

The register-replica command (pmc node register-replica) registers a replica node.

node update​

Usage: pmc node update [OPTIONS]

  Update node information

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE        Public key                                      │
│  -h, --host=TEXT            Host                                            │
│  -p, --port=INT             Port                                            │
│  -a, --api-url=TEXT         api url                                         │
│  -t, --territory=TEXT       ISO 3166-1 alpha-2 code                         │
│  -clu, --cluster-units=INT  Cluster Units (minimum 1)                       │
│  -es, --extra-storage=INT   Extra Storage (MiB)                             │
│  -c, --cluster=TEXT         Comma delimited list of clusters to add this    │
│                             node to                                         │
│                                                                             │
│--add-capability=(SYSTEM_MANAGED|ETHEREUM_BRIDGE|ETHEREUM_TESTNET_BRIDGE|BCS_│
│                             Node capability (deprecated)                    │
│                                                                             │
│--remove-capability=(SYSTEM_MANAGED|ETHEREUM_BRIDGE|ETHEREUM_TESTNET_BRIDGE|B│
│                             Node capability (deprecated)                    │
│  --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

node replace​

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>

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* --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                                         │
│  -t, --territory=TEXT       ISO 3166-1 alpha-2 code                         │
│  -clu, --cluster-units=INT  Cluster Units (minimum 1)                       │
│  -es, --extra-storage=INT   Extra Storage (MiB)                             │
│  --keep-as-replica          Keep replaced node as a replica node            │
│  --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

node disable​

Usage: pmc node disable [OPTIONS]

  Disables node and removes it from clusters, cluster replicas, blockchain
  replicas

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -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.

node enable​

Usage: pmc node enable [OPTIONS]

  Enables node

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE  Public key                                            │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The enable command (pmc node enable) enables a disabled node.

node remove​

Usage: pmc node remove [OPTIONS]

  Removes disabled node

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -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.

node info​

Usage: pmc node info [OPTIONS]

  Get node info for given node pubkey

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -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

node verify​

Usage: pmc node verify [OPTIONS]

  Verify node status

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE  Public key                                            │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The verify command (pmc node verify) verifies the status of a specific node identified by its public key.

node blockchains​

Usage: pmc node blockchains [OPTIONS]

  List blockchains for node

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE  Public key                                            │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The blockchains command (pmc node blockchians) lists blockchains running on a node.

node containers​

Usage: pmc node containers [OPTIONS]

  List containers for node

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -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.

node list​

Usage: pmc node list [OPTIONS]

  List all nodes

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -i, --interactive  Prompt for item to show details for                     │
│  -h, --help         Show this message and exit                              │
╰─────────────────────────────────────────────────────────────────────────────╯

The list command (pmc node list) lists all nodes in the network.