vnode heading-link-icon

This section lists the Corda CLI A command line tool that supports various Corda-related tasks, including Corda Package Installer (CPI) creation and Corda cluster management. vnode sub-commands. You can use these commands to reset or upgrade virtual nodes. For more information see, Upgrading from 5.1.

ArgumentDescription
resetUploads and overwrites a previous CPI in a development environment; see reset.
platform-migrationGenerates the required SQL commands to migrate the database schema of virtual nodes from one version of Corda Platform to the next; see platform-migration.

The reset command is only intended for development use. It allows you to replace the virtual node CPI without bumping the version.

The following table lists the reset sub-commands and arguments:

ArgumentDescription
-c, --cpiThe path to the CPI file used to overwrite the virtual node.
-k, --insecureAllows insecure server connections with SSL. The default value is false.
-p, --passwordThe REST API password.
-r, --resyncThe short hash holding IDs of the virtual nodes to reset.
-t, --targetThe URL of the REST API.
-u, --userThe REST API user.
-w, --waitPolls for the result.
-y, --yieldDuration in seconds to wait for the REST connection to become available. Defaults to 10 seconds if missing.

The following table lists the platform-migration sub-commands and arguments:

ArgumentDescription
-i, --input-filenameThe path to a file containing the list of short hash holding IDs of the virtual nodes to migrate. The file must only contain one ID per line. The default value is ./holdingIds.
--jdbc-urlThe JDBC URL for the connection. Read access is required for Liquibase tracking tables to determine the current version of the platform schemas of each virtual node.
-o, --output-filenameThe path to the generated SQL file. The default value is ./vnodes.sql.
-p, --passwordThe database password.
-u, --userThe database user.
corda-cli.sh vnode platform-migration --jdbc-url=jdbc:postgresql://host.docker.internal:5432/cordacluster -u postgres -i /sql_updates/holdingIds -o /sql_updates/vnodes.sql
corda-cli.cmd vnode platform-migration --jdbc-url=jdbc:postgresql://host.docker.internal:5432/cordacluster -u postgres -i /sql_updates/holdingIds -o /sql_updates/vnodes.sql

For more information about upgrading from Corda 5.1 to Corda 5.2, see Upgrading from 5.1.

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.

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.

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.

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.

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.