R3 Docs R3 Docs Home

CENM Services Command-line Interface

The CENM Command-line Interface (CLI) allows you to perform key CENM tasks remotely and securely.

Once you have the required permissions to access the CENM service you require, you can use the CLI to perform tasks with the following services:

  • Identity Manager
  • Zone Service
  • Network Map
  • Signing Service

The CLI Tool comes as a part of CENM 1.5 as a JAR file. If you cannot access the JAR file, you can install via Docker image.

To install using Docker:

  1. Install Docker from the Docker website.

  2. Use the command line to download the Docker image with CENM CLI:

  docker pull corda/enterprise-cenm-cli:1.5.4-zulu-openjdk8u242

You have installed the Docker image with CENM CLI tool.

To get the tool ready to use from within the Docker container, check the Kubernetes deployment guide.

In order to use the CLI, you must have permission to access the CENM services you plan to use.

You should have an account that has been set up by a user administrator using the User Admin application. This account gives you the credentials, roles, and permissions you need to access CENM services via the CLI.

For the below example, the credentials of a sample CENM user are shown:

Name: Alice Barthes Username: alice.barthes Password: w34rfrt45g4y65EERTR5

Quickstart - outline of steps to set up a new network with the CLI heading-link-icon

You must set up any new network in a specific order, as some services rely on information that must be in place before they can be created. Most importantly, you must set the Signing Service configuration last - this is because you need to have configuration details for all the other services before you can access their signing requests.

In the example below, you can see the steps to set up a new network with the CLI. When setting up your own network, you need to replace the sample parameters, usernames, passwords, service addresses and other information as applicable to your deployment.

To set up a new network with the CLI:

  1. Login by setting the context login address, your username, and password:

    ./cenm context login http://10.230.41.12 -u alice.barthes -p w34rfrt45g4y65EERTR5

  2. Set the Identity Manager’s external admin address. This must be the address that the gateway Gateway service uses to communicate with the Identity Manager:

    ./cenm identity-manager config set-admin-address -a=identity-manager:5053

  3. Set the Identity Manager config. This command returns a Zone token which you should pass to your Angel Service:

    ./cenm identity-manager config set -f config/identitymanager.conf --zone-token

  4. Create a new subzone - including the admin address for Network Map. This must be the address that the gateway Gateway service uses to communicate with the Network Map:

    ./cenm zone create-subzone --config-file=config/networkmap.conf --label=Subzone --label-color="#000000" --network-map-address=networkmap:8080 --network-parameters=config/params.conf

  1. Set the Network Map configuration for a subzone (the entry 1 below comes from the response to the create-subzone command):

    ./cenm netmap config set -s 1 -f config/networkmap.conf --zone-token

  2. Set the Signing Service’s external admin address. This must be the address that the gateway Gateway service uses to communicate with the Identity Manager:

    ./cenm signer config set-admin-address -a=signer:9087

  3. Set the Signing Service configuration last, as it depends on the first two service’s locations for it to be complete:

    ./cenm signer config set -f config/signer.conf --zone-token

  4. Set up any notaries required for your network, and update your network parameters. This process includes steps you would follow for any Flag Day network update:

    a. Fetch the node info file from the notary.

    b. Upload the node info file to the Network Map - command: cenm netmap upload-node-info -f nodeInfo.

    c. Edit the network parameters configuration to add the notary to the list, specifying the path to the node info file from step b, and to set an update deadline in the near future. For example, 5 minutes from now.

    d. Update network parameters in the Network Map to include the notary information - command: cenm netmap netparams update submit -p config/parameters.conf.

    e. Advertise the network parameter update to the network - command: cenm netmap netparams update advertise.

    f. Fetch the unsigned network parameters - command: cenm signer netmap netparams unsigned.

    g. Sign the updated network parameters - command: cenm signer netmap netparams sign -h <hash>.

    h. Accept the update from inside the notary.

    i. Execute the network parameter updates - command: cenm netmap netparams update execute.

    j. Fetch the unsigned Network Map - command: cenm signer netmap unsigned.

    k. Sign the Network Map - command: cenm signer netmap sign -h <hash>.

To access help and get the version number, use the following command structure:

cenm [-hV] [COMMAND]

Options

h,--help See a list of available commands and descriptions.

v, --version See the current version of the CLI you are using.

You can use the CLI to:

  • Update the password you use to access CENM services.
  • Set up and switch between contexts - allowing you to perform tasks across multiple servers with minimum effort to switch between them.
  • Perform tasks in Identity Manager.
  • Access the Network Map.
  • Manage zones.
  • Perform tasks in Signing Services.

The main commands are:

change-password Change your CENM password.

context Login and logout of CENM service management.

zone Commands for zone-service management.

signer Signing commands.

identity-manager Identity-manager management features.

netmap Network-map management features.

Your interaction with CENM services through the CLI is managed by the Front-end Application for Remote Management (Gateway) service. This service handles security checks and HTTP translation during your session, and acts as a gateway between the CLI and CENM.

When you log in to each session, you specify the full endpoint address of the Gateway service instance you are accessing, for example: http://10.230.41.12. You do this using the argument <server> in the command line. This endpoint forms the context for your session.

Setting a context means that your session can last for the full session duration set in your Auth Service configuration, without being interrupted by any natural time-outs in your CENM service. It also means you can switch between servers, like staging and production servers, simply by switching from one context alias to another.

In most commands in the CLI, you can specify the context you want to use with the command option:

-c, --use-context=<useContext>

If you work on multiple services, or need to access the same service using multiple contexts, you can use the CLI to create context aliases. This means you can switch between sessions and back again by switching aliases.

This command allows you to change the password you use to access your CENM services.

Sample command structure

cenm change-password -n[=<newPassword>] -p[=<password>] -u=<username> <server>

Options

-n, --new-password[=<newPassword>] New password. Leave -n without a value to enter your password on the next line. This prevents your password being visible in the command line history.

-p, --password[=<password>] Current password. Leave -p without a value to enter your password on the next line. This prevents your password being visible in the command line history.

-u, --username=<username> Username for password based authentication.

Arguments

<server> URL for the targeted CENM API Gateway - the Gateway service.

When you log in to a CENM session using the CLI, you do so by setting the required Context for your session. This ensures you are able to stay logged in to the correct server address for the duration of your work.

For example, once you have accessed the correct server for the Signing Service, making this address the fixed context means that you no longer need to specify the server address for your subsequent commands.

-a, –alias= Optionally sets an alias for this session.

This can be used for setting the ‘current context’ and logging out later on.

-p, –password[=] Password for password based authentication. Leave -p without a value to enter your password on the next line. This prevents your password being visible in the command line history.

-s, –set-active-context Sets the active context to the configured url.

-u, –username= Username for password based authentication.

Url for the targeted CENM API Gateway (Gateway).

./cenm.sh context login http://localhost:8081 -u jenny-editor -p password

You can perform the following tasks:

  • Configure the Identity Manager Service.
  • Manage certificate signing requests.
  • Display the certificate path for a legal name.
  • Manage certificate revocation requests.
  • Get certificate revocation list and related details.
  • Check connectivity to the identity-manager service.
  • Display configured approval plugins.

You can use the CLI to configure the following elements of the Identity Manager Service for the context you are working on:

  • Update the Identity Manager’s service address.
  • Retrieve the Identity Manager configuration.
  • Update the Identity Manager’s configuration.

To update the service address of the Identity Manager, use the set-admin-address command. Changing the address of the Identity Manager Service also means you can update the Context of the current session to match the new address.

When entering the address, you must enter <host>-<port>. The port value must be the same as the value for adminListener in the services configuration file. [PLEASE CHECK THIS]

Sample command structure

cenm identity-manager config set-admin-address -a=<address> [-c=<useContext>] [-o=<outputType>]

Options

-a, --address=<address> The new address of the service, in the format <host>:<port>. The value for port must match the value for adminListener in the service configuration file.

-c, --use-context=<useContext> Sets the context of the command to override the current context you are using.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty

Use the command get to retrieve the current Identity Manager configuration. You can specify the output type, and request a Zone token in place of the config file if required.

Sample command structure

cenm identity-manager config get [--zone-token] [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command that overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty

Default value is pretty

--zone-token Indicates that the zone token should be printed instead of the config, when using the ‘pretty’ output type.

To update the configuration of the Identity Manager, you need to include a config file with the new settings. Then use the set command to update the Identity Manager.

Sample command structure

cenm identity-manager config set [--zone-token] [-c=<useContext>] -f=<configFile> [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command. This overrides the current context set.

-f, --config-file=<configFile> Configuration file.

`-o, `` Specifies output format. Valid values are: json, pretty. Default value is pretty

--zone-token Indicates that the zone token should be printed instead of the config, when using the ‘pretty’ output type.

You can use the CLI to see the approved and pending certificate signing requests for the Identity Manager Service.

To see the requests for a different context to the one you are on, you need to specify the context you require.

Sample command structure

cenm identity-manager csr approved [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm identity-manager csr pending [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Identity certificates allow parties to access the network managed by CENM. Using the CLI, you can:

  • Submit a certificate revocation request.
  • Get the list of approved certificate revocation requests.
  • Get the list of pending certificate revocation requests.

You can use the CLI to see the approved and pending certificate revocation requests for the Identity Manager Service.

To see the requests for a different context to the one you are on, you need to specify the context you require.

When making a request to revoke a certificate, you must provide only one of the following certificate identifiers:

  • Request ID of the certificate being revoked.
  • Legal name of the party whose certificate is being revoked.
  • The serial ID of the certificate being revoked.

To request that a certificate is revoked, you must provide a reason for the revocation, and one form of certificate identifier.

Sample command structure

cenm identity-manager crr submit (-n=<legalName> | -i=<requestId> | -s=<serial>) [-c=<useContext>] -e=<reporter> [-o=<outputType>] -r=<reason>

Options

-c, --use-context=<useContext> Sets the context of the command that overrides the current context set.

-e, --reporter=<reporter> Specifies the reporter who requested the certificate revocation.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-r, --reason=<reason> Reason for the revocation. Possible values:

  • KEY_COMPROMISE
  • CA_COMPROMISE
  • AFFILIATION_CHANGED
  • SUPERSEDED
  • CESSATION_OF_OPERATION
  • PRIVILEGE_WITHDRAWN

Certificate identifiers

Only use one certificate identifier per request.

-i, --request-id=<requestId> Submits a CRR using the request id. Can only be present if serial and legal name not set

-n, --legal-name=<legalName> Submits a CRR using the legal name. Can only be present if request id and serial not set

-s, --serial=<serial> Submits a CRR using the certificate serial.

Can only be present if request id and legal name not set

Sample command structure

cenm identity-manager crr approved [-c=] [-o=]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm identity-manager crr pending [-c=] [-o=]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

You can check the location path of an Identity Manager certificate attached to any legal name in the network.

Sample command structure

cenm identity-manager cert-path [-c=<useContext>] -n=<legalEntityName> [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-n, --legal-entity-name=<legalEntityName> The legal entity name of the certificate.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm identity-manager crl get [-c=<useContext>] [-i=<issuer>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context you have set.

-i, --issuer=<issuer> Issuer of the CRL to display.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm identity-manager crl issuers [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

You can use the CLI to check your connection to the Identity Manager Service, and see available plugins to the service.

Sample command structure

cenm identity-manager status [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm identity-manager plugins [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

You can use the CLI to perform the following tasks related to zone management:

status To check your connectivity to the Zone Service.

create-subzone To create a subzone.

get-subzones To list all subzones.

addresses To list all service addresses.

Sample command structure

cenm zone status [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

To create a subzone using the CLI, you need to provide:

  • A config file to configure the settings for the new subzone.
  • The Network Map address for the new subzone.
  • The parameters for the network.

Sample command structure

cenm zone create-subzone [--zone-token] [-c=<useContext>] --config-file=<networkMapConfigFile> --label=<label> --label-color=<labelColor> --network-map-address=<networkMapAddress> --network-parameters=<networkParameters> [-o=<outputType>]

Options

--zone-token Indicates that the zone token should be printed instead of the config, when using the ‘pretty’ output type.

--config-file=<networkMapConfigFile> Network Map configuration file.

--label=<label> Friendly name of the subzone.

--label-color=<labelColor> The label color for the subzone. Must be in hex format, like #FFFFFF.

--network-map-address=<networkMapAddress> Sets the address of the Network Map Service. Must be in a format of <hostname>:<port> The port should be the same as the one set for the adminListener in the network-map config.

--network-parameters=<networkParameters> Initial network parameters.

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

You can use the CLI to get a list of existing subzones and their basic details.

Sample command structure

cenm zone get-subzones [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

You can find the addresses of all the services on a specified subzone. If you only have access to one subzone, you do not need to specify the subzone option in your command.

Sample command structure

cenm zone addresses [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

You can use the CLI to perform the following tasks in the Signing Service:

  • See the list of pending certificate signing requests.
  • Get a full list of unsigned certificate revocation requests.
  • Sign Identity Manager certificates.
  • See pending Identity Manager certificate revocation requests.
  • Sign certificate revocation requests.
  • Get a list of unsigned network parameters.
  • Sign network parameters.
  • Get subzone material detailing parameters of a network.
  • See unsigned Network Map data.
  • Sign Network Map.
  • Set the Signing Service address.
  • Get the Signing Service configuration details.
  • Configure the Signing Service.
  • Check your connectivity to the Signing Service.
  • List all signers currently configured.
  • Get zone material relating to the Signing Service.

Sample command structure

cenm signer csr list [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

When you sign Identity Manager certificate requests using the CLI, you need to include the ID of the request you are signing.

Sample command structure

cenm signer csr sign [-c=<useContext>] [-o=<outputType>] REQUEST_ID

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Arguments

REQUEST_ID The ID of the request you wish to sign.

When using the CLI to sign a certificate revocation request, you have the option to update the list of revoked certificates. If you keep a list, you should always use this option to ensure your list remains up to date.

Sample command structure

cenm signer crl sign [-c=<useContext>] [-h=<crlHash>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-h, --crl-hash=<crlHash> Hash of the CRL to be appended or empty if non exists.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm signer crl get [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm signer crl crrs [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm signer netmap netparams sign [-c=<useContext>] -h=<hash> [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-h, --crl-hash=<crlHash> Hash of the network parameters to be signed.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm signer netmap netparams unsigned [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm signer netmap sign [-c=<useContext>] -h=<hash> [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-h, --crl-hash=<crlHash> Hash of the Network Map to be signed.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm signer netmap material [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm signer netmap unsigned [--node-infos] [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

--node-infos Allows you to print a list of node info from the Network Map.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

To configure the Signing Service, you must include a configuration file with the correct configuration data.

Sample command structure

cenm signer config set [--zone-token] [-c=<useContext>] -f=<configFile> [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-f, --config-file=<configFile> Configuration file.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

--zone-token Indicates that the zone token should be printed instead of the config, when using the pretty output type.

Sample command structure

cenm signer config set-admin-address -a=<address> [-c=<useContext>] [-o=<outputType>]

Options

-a, --address=<address> The new address of the service, in the format <host>:<port>. The value for port must match the value for adminListener in the service configuration file.

-c, --use-context=<useContext> Sets the context of the command to override the current context you are using.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm signer config get [--zone-token] [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

--zone-token Indicates that the zone token should be printed instead of the config, when using the pretty output type.

Sample command structure

cenm signer status [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm signer list [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm signer zone-material [-c=<useContext>] [-o=<outputType>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

You can use the CLI to perform the following tasks on Network Map Services:

  • Get network parameters.
  • Update network parameters.
  • Get the current Network Map configuration.
  • Get the label data for a subzone.
  • Update the configuration of a Network Map.
  • Set the address of a Network Map.
  • Update the labels for a Network Map.
  • Check the connection status of the Network Map Service.
  • Get the current Network Map data.
  • See a list of available node information.
  • Upload new node information to a Network Map.

Sample command structure

cenm netmap netparams get [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

To create a new parameters update, you must submit it to the Zone Service database. It can then be Advertised, and then Executed when the changes are brought into effect.

When using this command, you must include the new parameters using the option described below.

Sample command structure

cenm netmap netparams update submit [-c=<useContext>] [-o=<outputType>] -p=<networkParameters> [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-p, --network-parameters=<networkParameters> Updated network parameters.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

You can use the CLI to advertise upcoming changes to network parameters across the network.

Sample command structure

cenm netmap netparams update advertise [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Use this command to remove network parameter changes from the pending list. Canceled pending network parameter changes can no longer be executed and brought into effect.

Sample command structure

cenm netmap netparams update cancel [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Execute network parameters update - triggering a Flag day. heading-link-icon

When you execute pending changes to the network parameters, it triggers a Flag day. This causes all nodes in the network to shut down. On restart, they can accept the new network parameters and continue operating.

Sample command structure

cenm netmap netparams update execute [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm netmap netparams update status [--accepted] [-c=<useContext>] -h=<parameterHash> [-o=<outputType>] [-s=<subzoneId>]

Options

--accepted Add this option to see a list of nodes that accepted the change. To see a list of nodes that have not yet accepted, do not include this option.

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-h, --crl-hash=<crlHash> Hash of the network parameter.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

Sample command structure

cenm netmap netparams update pending [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm netmap netparams update get [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm netmap config get [--zone-token] [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

--zone-token Indicates that the zone token should be printed instead of the config, when using the pretty output type.

Use this command to see the assigned label data used in the current Network Map configuration.

Sample command structure

cenm netmap config get-label [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

To update the Network Map configuration with the CLI, you must include a new config file as one of the options in the command.

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-f, --config-file=<configFile> Configuration file.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

--zone-token Indicates that the zone token should be printed instead of the config, when using the pretty output type.

Sample command structure

cenm netmap config set-admin-address -a=<address> [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-a, --address=<address> The new address of the service, in the format <host>:<port>. The value for port must match the value for adminListener in the service configuration file.

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-f, --config-file=<configFile> Configuration file.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

--zone-token Indicates that the zone token should be printed instead of the config, when using the pretty output type.

Sample command structure

cenm netmap config set-label [-c=<useContext>] --label=<label> --label-color=<labelColor> [-o=<outputType>] [-s=<subzoneId>]

Options

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

--label=<label> Friendly name of the subzone.

--label-color=<labelColor> The label color for the subzone. Must be in hex format, like #FFFFFF.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

--zone-token Indicates that the zone token should be printed instead of the config, when using the pretty output type.

Sample command structure

cenm netmap status [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Sample command structure

cenm netmap node-infos [-c=<useContext>] [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

To upload node info to the Network Map, you must include an updated Node Info file.

Sample command structure

cenm netmap upload-node-info [-c=<useContext>] -f=<nodeInfoFile> [-o=<outputType>] [-s=<subzoneId>]

Options

-c, --use-context=<useContext> Sets the context of the command - overrides the current context set.

-f, --node-info-file=<nodeInfoFile> A file containing the new node information.

-o, <outputType> Specifies output format. Valid values are: json, pretty. Default value is pretty.

-s, --subzone-id=<subzoneId> Sets which subzone to operate on. If you are operating on just one subzone you do not need to include this option.

Previous
Setting Up A Notary Node
Next
CENM User Admin tool

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Chat with us
Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

Learn how

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Chat with us
Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Create a new issue
Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

Learn how