PegaSys Plus Command Line

This reference describes the syntax of the PegaSys Plus Command Line Interface (CLI) options and subcommands. All PegaSys Plus options are prefixed with plugin

Important

Only the PegaSys Plus CLI options are listed here, visit the Hyperledger Besu documentation to view the CLI options for the besu command.

Options

plugin-encrypted-storage-cipher-provider

--plugin-encrypted-storage-cipher-provider=<cipherProvider>
--plugin-encrypted-storage-cipher-provider=SunJCE
BESU_PLUGIN_ENCRYPTED-STORAGE_CIPHER_PROVIDER=SunJCE
plugin-encrypted-storage-cipher-provider="SunJCE"

Cipher provider used to encrypt data at rest. Defaults to using 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>
--plugin-encrypted-storage-hashicorp-config=/home/hashicorp/config.toml
BESU_PLUGIN_ENCRYPTED-STORAGE_HASHICORP_CONFIG=/home/hashicorp/config.toml
plugin-encrypted-storage-hashicorp-config="/home/hashicorp/config.toml"

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

plugin-encrypted-storage-key

--plugin-encrypted-storage-key=<encryptionKey>
--plugin-encrypted-storage-key=/home/encrypt/encryptionKey
BESU_PLUGIN_ENCRYPTED-STORAGE_KEY=/home/encrypt/encryptionKey
plugin-encrypted-storage-key="/home/encrypt/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>]
--plugin-kafka-enabled=true
BESU_PLUGIN_KAFKA_ENABLED=true
plugin-kafka-enabled="true"

Enables or disables the Kafka event streaming plugin. Default is false.

plugin-kafka-stream

--plugin-kafka-stream=<STRING>
--plugin-kafka-stream=my-pegasys-stream
BESU_PLUGIN_KAFKA_STREAM=my-pegasys-stream
plugin-kafka-stream="my-pegasys-stream"

Name of the PegaSys Plus data stream displayed in the Kafka platform. Default is pegasys-stream.

plugin-kafka-url

--plugin-kafka-url=<URL>
--plugin-kafka-url=127.0.0.1:9090
BESU_PLUGIN_KAFKA_URL=127.0.0.1:9090
plugin-kafka-url"127.0.0.1:9090"

URL of the Kafka streaming platform. Default is 127.0.0.1:9092

plugin-kinesis-enabled

--plugin-kinesis-enabled[=<true|false>]
--plugin-kinesis-enabled=true
BESU_PLUGIN_KINESIS_ENABLED=true
plugin-kinesis-enabled="true"

Enables or disables the Kinesis event streaming plugin. Default is false.

plugin-kinesis-stream

--plugin-kinesis-stream=<STRING>
--plugin-kinesis-stream=my-pegasys-stream
BESU_PLUGIN_KINESIS_STREAM=my-pegasys-stream
plugin-kinesis-stream"my-pegasys-stream"

Name of the PegaSys Plus data stream displayed in the Amazon Kinesis platform. Default is pegasys-stream.

plugin-kinesis-aws-region

--plugin-kinesis-aws-region-stream=<STRING>
--plugin-kinesis-aws-region=us-east-1
BESU_PLUGIN_KINESIS_AWS_REGION_STREAM=us-east-1
plugin-kinesis-aws-region="us-east-1"

AWS region code of the Amazon Kinesis broker. Default is us-east-2.

plugin-kinesis-aws-access-key-id

--plugin-kinesis-aws-access-key-id=<STRING>
--plugin-kinesis-aws-access-key-id=ABCDEF12356XYZ6DENPQ
BESU_PLUGIN_KINESIS_AWS_ACCESS_KEY_ID=ABCDEF12356XYZ6DENPQ
plugin-kinesis-aws-access-key-id="ABCDEF12356XYZ6DENPQ"

AWS access key ID.

plugin-kinesis-aws-secret-key

--plugin-kinesis-aws-secret-key=<STRING>
--plugin-kinesis-aws-secret-key=AluX9paN+Ms95SGLUGtuZi8h1P27v9fFq0uP4Rzn
BESU_PLUGIN_KINESIS_AWS_REGION_STREAM=AluX9paN+Ms95SGLUGtuZi8h1P27v9fFq0uP4Rzn
plugin-kinesis-aws-secret-key="AluX9paN+Ms95SGLUGtuZi8h1P27v9fFq0uP4Rzn"

AWS secret key.

plugin-metrics-recent-block-proposer-count

--plugin-metrics-recent-block-proposer-count=<INTEGER>
--plugin-metrics-recent-block-proposer-count=50
BESU_PLUGIN_METRICS_RECENT_BLOCK_PROPOSER_COUNT=50
plugin-metrics-recent-block-proposer-count="50"

Number of recently added blocks in which to check for unique validators proposing blocks. Default is 100.