Skip to main content

Hyperledger Besu plugins command line options

This reference describes the syntax of the Hyperledger Besu command line interface (CLI) options and subcommands for plugins that extend Hyperledger Besu. All plugin options are prefixed with plugin.

important

Only the plugin CLI options are listed here. Visit the Hyperledger Besu documentation to view the CLI options for the besu command.

Only the CLI options for the plugins you have installed are displayed in the CLI help.

Options​

metrics-category​

--metrics-category=<metrics-category>[,metrics-category...]...

Comma-separated list of categories for which to track Besu metrics. An additional category for when using the validator monitoring plugin is POA.

plugin-encrypted-storage-cipher-provider​

--plugin-encrypted-storage-cipher-provider=<cipherProvider>

Cipher provider used to encrypt data at rest. The default is the first available provider that supports AES/CTR/NoPadding.

Use this option to specify a cipher provider based on performance requirements, or for compliance. For example, to specify a cipher provider that complies with Federal Information Processing Standards (FIPS).

Data is encrypted using the 256-bit AES encryption key.

plugin-encrypted-storage-hashicorp-config​

--plugin-encrypted-storage-hashicorp-config=<hashicorpConfig>

Configuration file used to retrieve the 256-bit AES encryption key in HashiCorp Vault.

plugin-encrypted-storage-key​

--plugin-encrypted-storage-key=<encryptionKey>

File containing the 256-bit AES encryption key to encrypt the blockchain data at rest.

Use this option when a local file stores the encryption key.

plugin-kafka-enabled​

--plugin-kafka-enabled[=<true|false>]

Enables or disables the Kafka event streaming plugin. The default is false.

plugin-kafka-enabled-topic​

--plugin-kafka-enabled-topic=<topicName>[,<topicName>...]...

Topics to enable in the event stream. By default, all topics are enabled. Use this option to enable only specific topics.

plugin-kafka-log-filter-addresses​

--plugin-kafka-log-filter-addresses=<ContractAddress>[,<ContractAddress>...]...

Smart contract addresses to filter events from.

You can create a schema file to decode the events that are published to Kafka, and present it in a more readable format.

plugin-kafka-log-filter-topics​

--plugin-kafka-log-filter-topics=<topicFilter>

Filter event logs emitted by smart contracts by topic.

You can create a schema file to decode the events that are published to Kafka and present it in a more readable format.

plugin-kafka-log-schema-file​

--plugin-kafka-log-schema-file=<schemaFile>

Schema file used to decode events specified using the --plugin-kafka-log-filter-addresses and --plugin-kafka-log-filter-topics options.

plugin-kafka-metadata-db-enabled​

--plugin-kafka-metadata-db-enabled[=<true|false>]

Enables or disables the storing of event metadata in a local database. The default is true.

plugin-kafka-producer-config-override-enabled​

--plugin-kafka-producer-config-override-enabled[=<true|false>]

Enables or disables overriding Kafka Producer configuration properties. The default is false.

plugin-kafka-producer-property​

--plugin-kafka-producer-property=<property=value>

The Kafka Producer configuration property. Can be specified multiple times if multiple properties are required.

plugin-kafka-stream​

--plugin-kafka-stream=<STRING>

Prefix of the Hyperledger Besu data stream displayed in the Kafka platform. The default is pegasys-stream.

plugin-kafka-url​

--plugin-kafka-url=<URL>

URL of the Kafka streaming platform. The default is 127.0.0.1:9092

plugin-luna-hsm-connectivity-check-interval​

--plugin-luna-hsm-connectivity-check-interval=<INTERVAL>

Period in milliseconds to check the HSM connection. Re-establishes the connection if required.

The default is 30000.

plugin-luna-hsm-password-file​

--plugin-luna-hsm-password-file=<FILE>

Plain text file containing the HSM password to access the partition.

plugin-luna-hsm-private-key-alias​

--plugin-luna-hsm-private-key-alias=<ALIAS>

Alias of the private key in the HSM.

plugin-luna-hsm-public-key-alias​

--plugin-luna-hsm-private-key-alias=<ALIAS>

Alias of the public key in the HSM.

plugin-luna-hsm-slot​

--plugin-luna-hsm-slot=<SLOT>

Slot on the HSM to use the keys.

plugin-metrics-recent-block-count​

--plugin-metrics-recent-block-count=<INTEGER>

Number of recently added blocks in which to check when metrics are calculated. The default is 100.