brokers

Usage

$brokers


Operations about brokers

$ pulsar-admin brokers subcommand

list

List active brokers of the cluster

Usage


$ pulsar-admin brokers list options

namespaces

List namespaces owned by the broker

Usage


$ pulsar-admin brokers namespaces options

Options

Flag Description Default
--url broker-url null

update-dynamic-config

Update dynamic-serviceConfiguration of broker

Usage


$ pulsar-admin brokers update-dynamic-config options

Options

Flag Description Default
--config service-configuration name null
--value service-configuration value null

delete-dynamic-config

Delete dynamic-serviceConfiguration of broker

Usage


$ pulsar-admin brokers delete-dynamic-config options

Options

Flag Description Default
--config service-configuration name null

list-dynamic-config

Get list of updatable configuration name

Usage


$ pulsar-admin brokers list-dynamic-config options

get-all-dynamic-config

Get all overridden dynamic-configuration values

Usage


$ pulsar-admin brokers get-all-dynamic-config options

get-internal-config

Get internal configuration information

Usage


$ pulsar-admin brokers get-internal-config options

get-runtime-config

Get runtime configuration values

Usage


$ pulsar-admin brokers get-runtime-config options

healthcheck

Run a health check against the broker

Usage


$ pulsar-admin brokers healthcheck options

broker-stats

Usage

$broker-stats


Operations to collect broker statistics

$ pulsar-admin broker-stats subcommand

monitoring-metrics

dump metrics for Monitoring

Usage


$ pulsar-admin broker-stats monitoring-metrics options

Options

Flag Description Default
-i, --indent Indent JSON output false

mbeans

dump mbean stats

Usage


$ pulsar-admin broker-stats mbeans options

Options

Flag Description Default
-i, --indent Indent JSON output false

topics

dump topics stats

Usage


$ pulsar-admin broker-stats topics options

Options

Flag Description Default
-i, --indent Indent JSON output false

allocator-stats

dump allocator stats

Usage


$ pulsar-admin broker-stats allocator-stats options

load-report

dump broker load-report

Usage


$ pulsar-admin broker-stats load-report options

clusters

Usage

$clusters


Operations about clusters

$ pulsar-admin clusters subcommand

get

Get the configuration data for the specified cluster

Usage


$ pulsar-admin clusters get options

create

Provisions a new cluster. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin clusters create options

Options

Flag Description Default
--url-secure service-url for secure connection null
--proxy-url Proxy-service url when client would like to connect to broker via proxy. null
--url service-url null
--broker-url-secure broker-service-url for secure connection null
--broker-url broker-service-url null
--proxy-protocol protocol to decide type of proxy routing eg: SNI null

update

Update the configuration for a cluster

Usage


$ pulsar-admin clusters update options

Options

Flag Description Default
--url service-url null
--broker-url broker-service-url null
--broker-url-secure broker-service-url for secure connection null
--url-secure service-url for secure connection null

delete

Deletes an existing cluster

Usage


$ pulsar-admin clusters delete options

list

List the existing clusters

Usage


$ pulsar-admin clusters list options

update-peer-clusters

Update peer cluster names

Usage


$ pulsar-admin clusters update-peer-clusters options

Options

Flag Description Default
--peer-clusters Comma separated peer-cluster names [Pass empty string "" to delete list] null

get-peer-clusters

Get list of peer-clusters

Usage


$ pulsar-admin clusters get-peer-clusters options

get-failure-domain

Get the configuration brokers of a failure-domain

Usage


$ pulsar-admin clusters get-failure-domain options

Options

Flag Description Default
--domain-name domain-name null

create-failure-domain

Create a new failure-domain for a cluster. updates it if already created.

Usage


$ pulsar-admin clusters create-failure-domain options

Options

Flag Description Default
--domain-name domain-name null
--broker-list Comma separated broker list null

update-failure-domain

Update failure-domain for a cluster. Creates a new one if not exist.

Usage


$ pulsar-admin clusters update-failure-domain options

Options

Flag Description Default
--domain-name domain-name null
--broker-list Comma separated broker list null

delete-failure-domain

Deletes an existing failure-domain

Usage


$ pulsar-admin clusters delete-failure-domain options

Options

Flag Description Default
--domain-name domain-name null

list-failure-domains

List the existing failure-domains for a cluster

Usage


$ pulsar-admin clusters list-failure-domains options

functions

Usage

$functions


Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar)

$ pulsar-admin functions subcommand

localrun

Run a Pulsar Function locally, rather than deploy to a Pulsar cluster)

Usage


$ pulsar-admin functions localrun options

Options

Flag Description Default
--hostname_verification_enabled Enable hostname verification null
--custom-schema-outputs The map of input topics to Schema properties (as a JSON string) null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the function null
--window-length-duration-ms The time duration of the window in milliseconds null
--custom-schema-inputs The map of input topics to Schema properties (as a JSON string) null
--window-length-count The number of messages per window null
--forward-source-message-property Forwarding input message's properties to output topic when processing true
--brokerServiceUrl The URL for Pulsar broker null
--tls_allow_insecure Allow insecure tls connection null
--instanceIdOffset Start the instanceIds from this offset null
--ram The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime) null
--use_tls Use tls connection null
--function-config-file The path to a YAML config file that specifies the configuration of a Pulsar Function null
--topicsPattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only) null
--tls_trust_cert_path tls trust cert file path null
--subs-name Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--clientAuthPlugin Client authentication plugin using which function-process can connect to broker null
--use-tls Use tls connection false
--dead-letter-topic The topic where messages that are not processed successfully are sent to null
-i, --inputs The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function null
--auto-ack Whether or not the framework acknowledges messages automatically null
--user-config User-defined config key/values null
--py Path to the main Python file/Python Wheel file for the function (if the function is written in Python) null
--broker-service-url The URL for Pulsar broker null
--functionConfigFile The path to a YAML config file that specifies the configuration of a Pulsar Function null
--clientAuthParams Client authentication param null
--retainOrdering Function consumes and processes messages in order null
--slidingIntervalDurationMs The time duration after which the window slides null
--go Path to the main Go executable binary for the function (if the function is written in Go) null
--parallelism The parallelism factor of a Pulsar Function (i.e. the number of function instances to run) null
--tenant The tenant of a Pulsar Function null
--tls-trust-cert-path tls trust cert file path null
--log-topic The topic to which the logs of a Pulsar Function are produced null
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the function null
--className The class name of a Pulsar Function null
-o, --output The output topic of a Pulsar Function (If none is specified, no output is written) null
--jar Path to the JAR file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null
--autoAck Whether or not the framework acknowledges messages automatically null
--retain-ordering Function consumes and processes messages in order null
--state-storage-service-url The URL for the state storage service (the default is Apache BookKeeper) null
--logTopic The topic to which the logs of a Pulsar Function are produced null
-st, --schema-type The builtin schema type or custom schema class name to be used for messages output by the function
--client-auth-plugin Client authentication plugin using which function-process can connect to broker null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--sliding-interval-count The number of messages after which the window slides null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--custom-serde-inputs The map of input topics to SerDe class names (as a JSON string) null
--windowLengthDurationMs The time duration of the window in milliseconds null
--timeout-ms The message timeout in milliseconds null
--max-message-retries How many times should we try to process a message before giving up null
--cpu The cpu in cores that need to be allocated per function instance(applicable only to docker runtime) null
--userConfig User-defined config key/values null
--topics-pattern The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only) null
--tls-allow-insecure Allow insecure tls connection false
--slidingIntervalCount The number of messages after which the window slides null
--outputSerdeClassName The SerDe class to be used for messages output by the function null
--hostname-verification-enabled Enable hostname verification false
--instance-id-offset Start the instanceIds from this offset 0
--customSerdeInputs The map of input topics to SerDe class names (as a JSON string) null
--name The name of a Pulsar Function null
--stateStorageServiceUrl The URL for the state storage service (the default is Apache BookKeeper) null
--classname The class name of a Pulsar Function null
--client-auth-params Client authentication param null
--disk The disk in bytes that need to be allocated per function instance(applicable only to docker runtime) null
--timeoutMs The message timeout in milliseconds null
--output-serde-classname The SerDe class to be used for messages output by the function null
--windowLengthCount The number of messages per window null
--sliding-interval-duration-ms The time duration after which the window slides null
--namespace The namespace of a Pulsar Function null

create

Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster)

Usage


$ pulsar-admin functions create options

Options

Flag Description Default
--custom-schema-outputs The map of input topics to Schema properties (as a JSON string) null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the function null
--window-length-duration-ms The time duration of the window in milliseconds null
--custom-schema-inputs The map of input topics to Schema properties (as a JSON string) null
--window-length-count The number of messages per window null
--forward-source-message-property Forwarding input message's properties to output topic when processing true
--ram The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime) null
--function-config-file The path to a YAML config file that specifies the configuration of a Pulsar Function null
--topicsPattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only) null
--subs-name Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--dead-letter-topic The topic where messages that are not processed successfully are sent to null
-i, --inputs The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function null
--auto-ack Whether or not the framework acknowledges messages automatically null
--user-config User-defined config key/values null
--py Path to the main Python file/Python Wheel file for the function (if the function is written in Python) null
--functionConfigFile The path to a YAML config file that specifies the configuration of a Pulsar Function null
--retainOrdering Function consumes and processes messages in order null
--slidingIntervalDurationMs The time duration after which the window slides null
--go Path to the main Go executable binary for the function (if the function is written in Go) null
--parallelism The parallelism factor of a Pulsar Function (i.e. the number of function instances to run) null
--tenant The tenant of a Pulsar Function null
--log-topic The topic to which the logs of a Pulsar Function are produced null
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the function null
--className The class name of a Pulsar Function null
-o, --output The output topic of a Pulsar Function (If none is specified, no output is written) null
--jar Path to the JAR file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null
--autoAck Whether or not the framework acknowledges messages automatically null
--retain-ordering Function consumes and processes messages in order null
--logTopic The topic to which the logs of a Pulsar Function are produced null
-st, --schema-type The builtin schema type or custom schema class name to be used for messages output by the function
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--sliding-interval-count The number of messages after which the window slides null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--custom-serde-inputs The map of input topics to SerDe class names (as a JSON string) null
--windowLengthDurationMs The time duration of the window in milliseconds null
--timeout-ms The message timeout in milliseconds null
--max-message-retries How many times should we try to process a message before giving up null
--cpu The cpu in cores that need to be allocated per function instance(applicable only to docker runtime) null
--userConfig User-defined config key/values null
--topics-pattern The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only) null
--slidingIntervalCount The number of messages after which the window slides null
--outputSerdeClassName The SerDe class to be used for messages output by the function null
--customSerdeInputs The map of input topics to SerDe class names (as a JSON string) null
--name The name of a Pulsar Function null
--classname The class name of a Pulsar Function null
--disk The disk in bytes that need to be allocated per function instance(applicable only to docker runtime) null
--timeoutMs The message timeout in milliseconds null
--output-serde-classname The SerDe class to be used for messages output by the function null
--windowLengthCount The number of messages per window null
--sliding-interval-duration-ms The time duration after which the window slides null
--namespace The namespace of a Pulsar Function null

delete

Delete a Pulsar Function that is running on a Pulsar cluster

Usage


$ pulsar-admin functions delete options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null

update

Update a Pulsar Function that has been deployed to a Pulsar cluster

Usage


$ pulsar-admin functions update options

Options

Flag Description Default
--custom-schema-outputs The map of input topics to Schema properties (as a JSON string) null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the function null
--window-length-duration-ms The time duration of the window in milliseconds null
--custom-schema-inputs The map of input topics to Schema properties (as a JSON string) null
--window-length-count The number of messages per window null
--forward-source-message-property Forwarding input message's properties to output topic when processing true
--ram The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime) null
--function-config-file The path to a YAML config file that specifies the configuration of a Pulsar Function null
--topicsPattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only) null
--subs-name Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--dead-letter-topic The topic where messages that are not processed successfully are sent to null
-i, --inputs The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function null
--auto-ack Whether or not the framework acknowledges messages automatically null
--user-config User-defined config key/values null
--update-auth-data Whether or not to update the auth data false
--py Path to the main Python file/Python Wheel file for the function (if the function is written in Python) null
--functionConfigFile The path to a YAML config file that specifies the configuration of a Pulsar Function null
--retainOrdering Function consumes and processes messages in order null
--slidingIntervalDurationMs The time duration after which the window slides null
--go Path to the main Go executable binary for the function (if the function is written in Go) null
--parallelism The parallelism factor of a Pulsar Function (i.e. the number of function instances to run) null
--tenant The tenant of a Pulsar Function null
--log-topic The topic to which the logs of a Pulsar Function are produced null
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the function null
--className The class name of a Pulsar Function null
-o, --output The output topic of a Pulsar Function (If none is specified, no output is written) null
--jar Path to the JAR file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null
--autoAck Whether or not the framework acknowledges messages automatically null
--retain-ordering Function consumes and processes messages in order null
--logTopic The topic to which the logs of a Pulsar Function are produced null
-st, --schema-type The builtin schema type or custom schema class name to be used for messages output by the function
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--sliding-interval-count The number of messages after which the window slides null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--custom-serde-inputs The map of input topics to SerDe class names (as a JSON string) null
--windowLengthDurationMs The time duration of the window in milliseconds null
--timeout-ms The message timeout in milliseconds null
--max-message-retries How many times should we try to process a message before giving up null
--cpu The cpu in cores that need to be allocated per function instance(applicable only to docker runtime) null
--userConfig User-defined config key/values null
--topics-pattern The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only) null
--slidingIntervalCount The number of messages after which the window slides null
--outputSerdeClassName The SerDe class to be used for messages output by the function null
--customSerdeInputs The map of input topics to SerDe class names (as a JSON string) null
--name The name of a Pulsar Function null
--classname The class name of a Pulsar Function null
--disk The disk in bytes that need to be allocated per function instance(applicable only to docker runtime) null
--timeoutMs The message timeout in milliseconds null
--output-serde-classname The SerDe class to be used for messages output by the function null
--windowLengthCount The number of messages per window null
--sliding-interval-duration-ms The time duration after which the window slides null
--namespace The namespace of a Pulsar Function null

get

Fetch information about a Pulsar Function

Usage


$ pulsar-admin functions get options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null

restart

Restart function instance

Usage


$ pulsar-admin functions restart options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null
--instance-id The function instanceId (restart all instances if instance-id is not provided) null

stop

Stops function instance

Usage


$ pulsar-admin functions stop options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--instance-id The function instanceId (stop all instances if instance-id is not provided) null
--tenant The tenant of a Pulsar Function null

start

Starts a stopped function instance

Usage


$ pulsar-admin functions start options

Options

Flag Description Default
--name The name of a Pulsar Function null
--instance-id The function instanceId (start all instances if instance-id is not provided) null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null

status

Check the current status of a Pulsar Function

Usage


$ pulsar-admin functions status options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null
--instance-id The function instanceId (Get-status of all instances if instance-id is not provided) null

stats

Get the current stats of a Pulsar Function

Usage


$ pulsar-admin functions stats options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--instance-id The function instanceId (Get-stats of all instances if instance-id is not provided) null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null

list

List all Pulsar Functions running under a specific tenant and namespace

Usage


$ pulsar-admin functions list options

Options

Flag Description Default
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null

querystate

Fetch the current state associated with a Pulsar Function

Usage


$ pulsar-admin functions querystate options

Options

Flag Description Default
--name The name of a Pulsar Function null
-k, --key Key name of State null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
-w, --watch Watch for changes in the value associated with a key for a Pulsar Function false
--tenant The tenant of a Pulsar Function null

putstate

Put the state associated with a Pulsar Function

Usage


$ pulsar-admin functions putstate options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--tenant The tenant of a Pulsar Function null
-s, --state The FunctionState that needs to be put null

trigger

Trigger the specified Pulsar Function with a supplied value

Usage


$ pulsar-admin functions trigger options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--trigger-value The value with which you want to trigger the function null
--trigger-file The path to the file that contains the data with which you want to trigger the function null
--topic The specific topic name that the function consumes from that you want to inject the data to null
--triggerFile The path to the file that contains the data with which you want to trigger the function null
--tenant The tenant of a Pulsar Function null
--triggerValue The value with which you want to trigger the function null

upload

Upload File Data to Pulsar

Usage


$ pulsar-admin functions upload options

Options

Flag Description Default
--source-file The file whose contents need to be uploaded null
--sourceFile The file whose contents need to be uploaded null
--path Path where the contents need to be stored null

download

Download File Data from Pulsar

Usage


$ pulsar-admin functions download options

Options

Flag Description Default
--name The name of a Pulsar Function null
--fqfn The Fully Qualified Function Name (FQFN) for the function null
--namespace The namespace of a Pulsar Function null
--destinationFile The file to store downloaded content null
--path Path to store the content null
--destination-file The file to store downloaded content null
--tenant The tenant of a Pulsar Function null

namespaces

Usage

$namespaces


Operations about namespaces

$ pulsar-admin namespaces subcommand

list

Get the namespaces for a tenant

Usage


$ pulsar-admin namespaces list options

list-cluster

Get the namespaces for a tenant in a cluster

Usage


$ pulsar-admin namespaces list-cluster options

topics

Get the list of topics for a namespace

Usage


$ pulsar-admin namespaces topics options

destinations

Get the list of destinations for a namespace

Usage


$ pulsar-admin namespaces destinations options

policies

Get the configuration policies of a namespace

Usage


$ pulsar-admin namespaces policies options

create

Creates a new namespace

Usage


$ pulsar-admin namespaces create options

Options

Flag Description Default
--clusters, -c List of clusters this namespace will be assigned null
--bundles, -b number of bundles to activate 0

delete

Deletes a namespace. The namespace needs to be empty

Usage


$ pulsar-admin namespaces delete options

permissions

Get the permissions on a namespace

Usage


$ pulsar-admin namespaces permissions options

grant-permission

Grant permissions on a namespace

Usage


$ pulsar-admin namespaces grant-permission options

Options

Flag Description Default
--actions Actions to be granted (produce,consume) null
--role Client role to which grant permissions null

revoke-permission

Revoke permissions on a namespace

Usage


$ pulsar-admin namespaces revoke-permission options

Options

Flag Description Default
--role Client role to which revoke permissions null

grant-subscription-permission

Grant permissions to access subscription admin-api

Usage


$ pulsar-admin namespaces grant-subscription-permission options

Options

Flag Description Default
--roles Client roles to which grant permissions (comma separated roles) null
--subscription Subscription name for which permission will be granted to roles null

revoke-subscription-permission

Revoke permissions to access subscription admin-api

Usage


$ pulsar-admin namespaces revoke-subscription-permission options

Options

Flag Description Default
--subscription Subscription name for which permission will be revoked to roles null
--role Client role to which revoke permissions null

set-clusters

Set replication clusters for a namespace

Usage


$ pulsar-admin namespaces set-clusters options

Options

Flag Description Default
--clusters, -c Replication Cluster Ids list (comma separated values) null

get-clusters

Get replication clusters for a namespace

Usage


$ pulsar-admin namespaces get-clusters options

get-backlog-quotas

Get the backlog quota policies for a namespace

Usage


$ pulsar-admin namespaces get-backlog-quotas options

set-backlog-quota

Set a backlog quota policy for a namespace

Usage


$ pulsar-admin namespaces set-backlog-quota options

Options

Flag Description Default
-l, --limit Size limit (eg: 10M, 16G) null
-p, --policy Retention policy to enforce when the limit is reached. Valid options are: [producer_request_hold, producer_exception, consumer_backlog_eviction] null

remove-backlog-quota

Remove a backlog quota policy from a namespace

Usage


$ pulsar-admin namespaces remove-backlog-quota options

get-persistence

Get the persistence policies for a namespace

Usage


$ pulsar-admin namespaces get-persistence options

set-persistence

Set the persistence policies for a namespace

Usage


$ pulsar-admin namespaces set-persistence options

Options

Flag Description Default
-e, --bookkeeper-ensemble Number of bookies to use for a topic 0
-a, --bookkeeper-ack-quorum Number of acks (garanteed copies) to wait for each entry 0
-w, --bookkeeper-write-quorum How many writes to make of each entry 0
-r, --ml-mark-delete-max-rate Throttling rate of mark-delete operation (0 means no throttle) 0.0

get-message-ttl

Get message TTL for a namespace

Usage


$ pulsar-admin namespaces get-message-ttl options

set-message-ttl

Set Message TTL for a namespace

Usage


$ pulsar-admin namespaces set-message-ttl options

Options

Flag Description Default
--messageTTL, -ttl Message TTL in seconds 0

get-subscription-expiration-time

Get subscription expiration time for a namespace

Usage


$ pulsar-admin namespaces get-subscription-expiration-time options

set-subscription-expiration-time

Set subscription expiration time for a namespace

Usage


$ pulsar-admin namespaces set-subscription-expiration-time options

Options

Flag Description Default
-t, --time Subscription expiration time in minutes 0

get-anti-affinity-group

Get Anti-affinity group name for a namespace

Usage


$ pulsar-admin namespaces get-anti-affinity-group options

set-anti-affinity-group

Set Anti-affinity group name for a namespace

Usage


$ pulsar-admin namespaces set-anti-affinity-group options

Options

Flag Description Default
--group, -g Anti-affinity group name null

get-anti-affinity-namespaces

Get Anti-affinity namespaces grouped with the given anti-affinity group name

Usage


$ pulsar-admin namespaces get-anti-affinity-namespaces options

Options

Flag Description Default
--cluster, -c Cluster name null
--group, -g Anti-affinity group name null
--tenant, -p tenant is only used for authorization. Client has to be admin of any of the tenant to access this api null

delete-anti-affinity-group

Remove Anti-affinity group name for a namespace

Usage


$ pulsar-admin namespaces delete-anti-affinity-group options

set-deduplication

Enable or disable deduplication for a namespace

Usage


$ pulsar-admin namespaces set-deduplication options

Options

Flag Description Default
--enable, -e Enable deduplication false
--disable, -d Disable deduplication false

set-auto-topic-creation

Enable or disable autoTopicCreation for a namespace, overriding broker settings

Usage


$ pulsar-admin namespaces set-auto-topic-creation options

Options

Flag Description Default
--enable, -e Enable allowAutoTopicCreation on namespace false
--num-partitions, -n Default number of partitions of topic to be auto-created, applicable to partitioned topics only null
--disable, -d Disable allowAutoTopicCreation on namespace false
--type, -t Type of topic to be auto-created. Possible values: (partitioned, non-partitioned). Default value: non-partitioned non-partitioned

remove-auto-topic-creation

Remove override of autoTopicCreation for a namespace

Usage


$ pulsar-admin namespaces remove-auto-topic-creation options

set-auto-subscription-creation

Enable autoSubscriptionCreation for a namespace, overriding broker settings

Usage


$ pulsar-admin namespaces set-auto-subscription-creation options

Options

Flag Description Default
--enable, -e Enable allowAutoSubscriptionCreation on namespace false

remove-auto-subscription-creation

Remove override of autoSubscriptionCreation for a namespace

Usage


$ pulsar-admin namespaces remove-auto-subscription-creation options

get-retention

Get the retention policy for a namespace

Usage


$ pulsar-admin namespaces get-retention options

set-retention

Set the retention policy for a namespace

Usage


$ pulsar-admin namespaces set-retention options

Options

Flag Description Default
--size, -s Retention size limit (eg: 10M, 16G, 3T). 0 or less than 1MB means no retention and -1 means infinite size retention null
--time, -t Retention time in minutes (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w). 0 means no retention and -1 means infinite time retention null

set-bookie-affinity-group

Set the bookie-affinity group name

Usage


$ pulsar-admin namespaces set-bookie-affinity-group options

Options

Flag Description Default
--primary-group, -pg Bookie-affinity primary-groups (comma separated) name where namespace messages should be written null
--secondary-group, -sg Bookie-affinity secondary-group (comma separated) name where namespace messages should be written null

get-bookie-affinity-group

Get the bookie-affinity group name

Usage


$ pulsar-admin namespaces get-bookie-affinity-group options

delete-bookie-affinity-group

Set the bookie-affinity group name

Usage


$ pulsar-admin namespaces delete-bookie-affinity-group options

unload

Unload a namespace from the current serving broker

Usage


$ pulsar-admin namespaces unload options

Options

Flag Description Default
--bundle, -b {start-boundary}_{end-boundary} null

split-bundle

Split a namespace-bundle from the current serving broker

Usage


$ pulsar-admin namespaces split-bundle options

Options

Flag Description Default
--unload, -u Unload newly split bundles after splitting old bundle false
--split-algorithm-name, -san Algorithm name for split namespace bundle. Valid options are: [range_equally_divide, topic_count_equally_divide]. Use broker side config if absent null
--bundle, -b {start-boundary}_{end-boundary} null

set-dispatch-rate

Set message-dispatch-rate for all topics of the namespace

Usage


$ pulsar-admin namespaces set-dispatch-rate options

Options

Flag Description Default
--msg-dispatch-rate, -md message-dispatch-rate (default -1 will be overwrite if not passed) -1
--dispatch-rate-period, -dt dispatch-rate-period in second type (default 1 second will be overwrite if not passed) 1
--relative-to-publish-rate, -rp dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) false
--byte-dispatch-rate, -bd byte-dispatch-rate (default -1 will be overwrite if not passed) -1

get-dispatch-rate

Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)

Usage


$ pulsar-admin namespaces get-dispatch-rate options

set-subscribe-rate

Set subscribe-rate per consumer for all topics of the namespace

Usage


$ pulsar-admin namespaces set-subscribe-rate options

Options

Flag Description Default
--subscribe-rate, -sr subscribe-rate (default -1 will be overwrite if not passed) -1
--subscribe-rate-period, -st subscribe-rate-period in second type (default 30 second will be overwrite if not passed) 30

get-subscribe-rate

Get configured subscribe-rate per consumer for all topics of the namespace

Usage


$ pulsar-admin namespaces get-subscribe-rate options

set-subscription-dispatch-rate

Set subscription message-dispatch-rate for all subscription of the namespace

Usage


$ pulsar-admin namespaces set-subscription-dispatch-rate options

Options

Flag Description Default
--byte-dispatch-rate, -bd byte-dispatch-rate (default -1 will be overwrite if not passed) -1
--dispatch-rate-period, -dt dispatch-rate-period in second type (default 1 second will be overwrite if not passed) 1
--relative-to-publish-rate, -rp dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) false
--msg-dispatch-rate, -md message-dispatch-rate (default -1 will be overwrite if not passed) -1

get-subscription-dispatch-rate

Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)

Usage


$ pulsar-admin namespaces get-subscription-dispatch-rate options

set-publish-rate

Set publish-rate for all topics of the namespace

Usage


$ pulsar-admin namespaces set-publish-rate options

Options

Flag Description Default
--byte-publish-rate, -b byte-publish-rate (default -1 will be overwrite if not passed) -1
--msg-publish-rate, -m message-publish-rate (default -1 will be overwrite if not passed) -1

get-publish-rate

Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0)

Usage


$ pulsar-admin namespaces get-publish-rate options

set-replicator-dispatch-rate

Set replicator message-dispatch-rate for all topics of the namespace

Usage


$ pulsar-admin namespaces set-replicator-dispatch-rate options

Options

Flag Description Default
--dispatch-rate-period, -dt dispatch-rate-period in second type (default 1 second will be overwrite if not passed) 1
--byte-dispatch-rate, -bd byte-dispatch-rate (default -1 will be overwrite if not passed) -1
--msg-dispatch-rate, -md message-dispatch-rate (default -1 will be overwrite if not passed) -1

get-replicator-dispatch-rate

Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)

Usage


$ pulsar-admin namespaces get-replicator-dispatch-rate options

clear-backlog

Clear backlog for a namespace

Usage


$ pulsar-admin namespaces clear-backlog options

Options

Flag Description Default
--sub, -s subscription name null
--bundle, -b {start-boundary}_{end-boundary} null
--force, -force Whether to force clear backlog without prompt false

unsubscribe

Unsubscribe the given subscription on all topics on a namespace

Usage


$ pulsar-admin namespaces unsubscribe options

Options

Flag Description Default
--bundle, -b {start-boundary}_{end-boundary} null
--sub, -s subscription name null

set-encryption-required

Enable or disable message encryption required for a namespace

Usage


$ pulsar-admin namespaces set-encryption-required options

Options

Flag Description Default
--disable, -d Disable message encryption required false
--enable, -e Enable message encryption required false

set-subscription-auth-mode

Set subscription auth mode on a namespace

Usage


$ pulsar-admin namespaces set-subscription-auth-mode options

Options

Flag Description Default
-m, --subscription-auth-mode Subscription authorization mode for Pulsar policies. Valid options are: [None, Prefix] null

set-delayed-delivery

Set the delayed delivery policy on a namespace

Usage


$ pulsar-admin namespaces set-delayed-delivery options

Options

Flag Description Default
--disable, -d Disable delayed delivery messages false
--time, -t The tick time for when retrying on delayed delivery messages, affecting the accuracy of the delivery time compared to the scheduled time. (eg: 1s, 10s, 1m, 5h, 3d) 1s
--enable, -e Enable delayed delivery messages false

get-delayed-delivery

Get the delayed delivery policy for a namespace

Usage


$ pulsar-admin namespaces get-delayed-delivery options

get-max-producers-per-topic

Get maxProducersPerTopic for a namespace

Usage


$ pulsar-admin namespaces get-max-producers-per-topic options

set-max-producers-per-topic

Set maxProducersPerTopic for a namespace

Usage


$ pulsar-admin namespaces set-max-producers-per-topic options

Options

Flag Description Default
--max-producers-per-topic, -p maxProducersPerTopic for a namespace 0

get-max-consumers-per-topic

Get maxConsumersPerTopic for a namespace

Usage


$ pulsar-admin namespaces get-max-consumers-per-topic options

set-max-consumers-per-topic

Set maxConsumersPerTopic for a namespace

Usage


$ pulsar-admin namespaces set-max-consumers-per-topic options

Options

Flag Description Default
--max-consumers-per-topic, -c maxConsumersPerTopic for a namespace 0

get-max-consumers-per-subscription

Get maxConsumersPerSubscription for a namespace

Usage


$ pulsar-admin namespaces get-max-consumers-per-subscription options

set-max-consumers-per-subscription

Set maxConsumersPerSubscription for a namespace

Usage


$ pulsar-admin namespaces set-max-consumers-per-subscription options

Options

Flag Description Default
--max-consumers-per-subscription, -c maxConsumersPerSubscription for a namespace 0

get-max-unacked-messages-per-subscription

Get maxUnackedMessagesPerSubscription for a namespace

Usage


$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options

set-max-unacked-messages-per-subscription

Set maxUnackedMessagesPerSubscription for a namespace

Usage


$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options

Options

Flag Description Default
--max-unacked-messages-per-subscription, -c maxUnackedMessagesPerSubscription for a namespace 0

get-max-unacked-messages-per-consumer

Get maxUnackedMessagesPerConsumer for a namespace

Usage


$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options

set-max-unacked-messages-per-consumer

Set maxUnackedMessagesPerConsumer for a namespace

Usage


$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options

Options

Flag Description Default
--max-unacked-messages-per-topic, -c maxUnackedMessagesPerConsumer for a namespace 0

get-compaction-threshold

Get compactionThreshold for a namespace

Usage


$ pulsar-admin namespaces get-compaction-threshold options

set-compaction-threshold

Set compactionThreshold for a namespace

Usage


$ pulsar-admin namespaces set-compaction-threshold options

Options

Flag Description Default
--threshold, -t Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction 0

get-offload-threshold

Get offloadThreshold for a namespace

Usage


$ pulsar-admin namespaces get-offload-threshold options

set-offload-threshold

Set offloadThreshold for a namespace

Usage


$ pulsar-admin namespaces set-offload-threshold options

Options

Flag Description Default
--size, -s Maximum number of bytes stored in the pulsar cluster for a topic before data will start being automatically offloaded to longterm storage (eg: 10M, 16G, 3T, 100). -1 falls back to the cluster's namespace default. Negative values disable automatic offload. 0 triggers offloading as soon as possible. -1

get-offload-deletion-lag

Get offloadDeletionLag, in minutes, for a namespace

Usage


$ pulsar-admin namespaces get-offload-deletion-lag options

set-offload-deletion-lag

Set offloadDeletionLag for a namespace

Usage


$ pulsar-admin namespaces set-offload-deletion-lag options

Options

Flag Description Default
--lag, -l Duration to wait after offloading a ledger segment, before deleting the copy of that segment from cluster local storage. (eg: 10m, 5h, 3d, 2w). -1

clear-offload-deletion-lag

Clear offloadDeletionLag for a namespace

Usage


$ pulsar-admin namespaces clear-offload-deletion-lag options

get-schema-autoupdate-strategy

Get the schema auto-update strategy for a namespace

Usage


$ pulsar-admin namespaces get-schema-autoupdate-strategy options

set-schema-autoupdate-strategy

Set the schema auto-update strategy for a namespace

Usage


$ pulsar-admin namespaces set-schema-autoupdate-strategy options

Options

Flag Description Default
--compatibility, -c Compatibility level required for new schemas created via a Producer. Possible values (Full, Backward, Forward). null
--disabled, -d Disable automatic schema updates false

get-schema-compatibility-strategy

Get the schema compatibility strategy for a namespace

Usage


$ pulsar-admin namespaces get-schema-compatibility-strategy options

set-schema-compatibility-strategy

Set the schema compatibility strategy for a namespace

Usage


$ pulsar-admin namespaces set-schema-compatibility-strategy options

Options

Flag Description Default
--compatibility, -c Compatibility level required for new schemas created via a Producer. Possible values (FULL, BACKWARD, FORWARD, UNDEFINED, BACKWARD_TRANSITIVE, FORWARD_TRANSITIVE, FULL_TRANSITIVE, ALWAYS_INCOMPATIBLE,ALWAYS_COMPATIBLE). null

get-is-allow-auto-update-schema

Get the namespace whether allow auto update schema

Usage


$ pulsar-admin namespaces get-is-allow-auto-update-schema options

set-is-allow-auto-update-schema

Set the namespace whether allow auto update schema

Usage


$ pulsar-admin namespaces set-is-allow-auto-update-schema options

Options

Flag Description Default
--disable, -d Disable schema validation enforced false
--enable, -e Enable schema validation enforced false

get-schema-validation-enforce

Get the schema validation enforced

Usage


$ pulsar-admin namespaces get-schema-validation-enforce options

set-schema-validation-enforce

Set the schema whether open schema validation enforced

Usage


$ pulsar-admin namespaces set-schema-validation-enforce options

Options

Flag Description Default
--disable, -d Disable schema validation enforced false
--enable, -e Enable schema validation enforced false

set-offload-policies

Set the offload policies for a namespace

Usage


$ pulsar-admin namespaces set-offload-policies options

Options

Flag Description Default
--offloadAfterThreshold, -oat Offload after threshold size (eg: 1M, 5M) null
--bucket, -b Bucket to place offloaded ledger into null
--maxBlockSize, -mbs Max block size (eg: 32M, 64M), default is 64MB null
--readBufferSize, -rbs Read buffer size (eg: 1M, 5M), default is 1MB null
--driver, -d Driver to use to offload old data to long term storage, (Possible values: S3, aws-s3, google-cloud-storage) null
--endpoint, -e Alternative endpoint to connect to, s3 default is s3ManagedLedgerOffloadServiceEndpoint in broker.conf null
--offloadAfterElapsed, -oae Offload after elapsed in minutes (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w). null
--region, -r The long term storage region, default is s3ManagedLedgerOffloadRegion or gcsManagedLedgerOffloadRegion in broker.conf null

get-offload-policies

Get the offload policies for a namespace

Usage


$ pulsar-admin namespaces get-offload-policies options

ns-isolation-policy

Usage

$ns-isolation-policy


Operations about namespace isolation policy

$ pulsar-admin ns-isolation-policy subcommand

set

Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin ns-isolation-policy set options

Options

Flag Description Default
--auto-failover-policy-type auto failover policy type name ['min_available'] null
--namespaces comma separated namespaces-regex list null
--primary comma separated primary-broker-regex list null
--secondary comma separated secondary-broker-regex list []
--auto-failover-policy-params comma separated name=value auto failover policy parameters null

get

Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin ns-isolation-policy get options

list

List all namespace isolation policies of a cluster. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin ns-isolation-policy list options

delete

Delete namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin ns-isolation-policy delete options

brokers

List all brokers with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin ns-isolation-policy brokers options

broker

Get broker with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges

Usage


$ pulsar-admin ns-isolation-policy broker options

Options

Flag Description Default
--broker Broker-name to get namespace-isolation policies attached to it null

sources

Usage

$sources


Interface for managing Pulsar IO Sources (ingress data into Pulsar)

$ pulsar-admin sources subcommand

create

Submit a Pulsar IO source connector to run in a Pulsar cluster

Usage


$ pulsar-admin sources create options

Options

Flag Description Default
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the source null
--deserialization-classname The SerDe classname for the source null
--cpu The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime) null
--disk The disk (in bytes) that need to be allocated per source instance (applicable only to Docker runtime) null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--className The source's class name if archive is file-url-path (file://) null
-a, --archive The path to the NAR archive for the Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null
--sourceConfigFile The path to a YAML config file specifying the source's configuration null
--source-config-file The path to a YAML config file specifying the source's configuration null
--source-config Source config key/values null
--parallelism The source's parallelism factor (i.e. the number of source instances to run) null
--ram The RAM (in bytes) that need to be allocated per source instance (applicable only to the process and Docker runtimes) null
--namespace The source's namespace null
--deserializationClassName The SerDe classname for the source null
--name The source's name null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the Source null
--destination-topic-name The Pulsar topic to which data is sent null
--sourceConfig Source config key/values null
-o, --destinationTopicName The Pulsar topic to which data is sent null
-t, --source-type The source's connector provider null
-st, --schema-type The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the source null
--classname The source's class name if archive is file-url-path (file://) null
--tenant The source's tenant null

update

Update a Pulsar IO source connector

Usage


$ pulsar-admin sources update options

Options

Flag Description Default
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the source null
--deserialization-classname The SerDe classname for the source null
--cpu The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime) null
--disk The disk (in bytes) that need to be allocated per source instance (applicable only to Docker runtime) null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--className The source's class name if archive is file-url-path (file://) null
-a, --archive The path to the NAR archive for the Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null
--sourceConfigFile The path to a YAML config file specifying the source's configuration null
--source-config-file The path to a YAML config file specifying the source's configuration null
--source-config Source config key/values null
--parallelism The source's parallelism factor (i.e. the number of source instances to run) null
--ram The RAM (in bytes) that need to be allocated per source instance (applicable only to the process and Docker runtimes) null
--namespace The source's namespace null
--deserializationClassName The SerDe classname for the source null
--name The source's name null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the Source null
--destination-topic-name The Pulsar topic to which data is sent null
--sourceConfig Source config key/values null
-o, --destinationTopicName The Pulsar topic to which data is sent null
-t, --source-type The source's connector provider null
--update-auth-data Whether or not to update the auth data false
-st, --schema-type The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the source null
--classname The source's class name if archive is file-url-path (file://) null
--tenant The source's tenant null

delete

Stops a Pulsar IO source connector

Usage


$ pulsar-admin sources delete options

Options

Flag Description Default
--namespace The source's namespace null
--name The source's name null
--tenant The source's tenant null

get

Gets the information about a Pulsar IO source connector

Usage


$ pulsar-admin sources get options

Options

Flag Description Default
--namespace The source's namespace null
--name The source's name null
--tenant The source's tenant null

status

Check the current status of a Pulsar Source

Usage


$ pulsar-admin sources status options

Options

Flag Description Default
--instance-id The source instanceId (Get-status of all instances if instance-id is not provided null
--namespace The source's namespace null
--name The source's name null
--tenant The source's tenant null

list

List all running Pulsar IO source connectors

Usage


$ pulsar-admin sources list options

Options

Flag Description Default
--namespace The sink's namespace null
--tenant The sink's tenant null

stop

Stop source instance

Usage


$ pulsar-admin sources stop options

Options

Flag Description Default
--instance-id The source instanceId (stop all instances if instance-id is not provided null
--namespace The source's namespace null
--name The source's name null
--tenant The source's tenant null

start

Start source instance

Usage


$ pulsar-admin sources start options

Options

Flag Description Default
--instance-id The source instanceId (start all instances if instance-id is not provided null
--namespace The source's namespace null
--name The source's name null
--tenant The source's tenant null

restart

Restart source instance

Usage


$ pulsar-admin sources restart options

Options

Flag Description Default
--instance-id The source instanceId (restart all instances if instance-id is not provided null
--namespace The source's namespace null
--name The source's name null
--tenant The source's tenant null

localrun

Run a Pulsar IO source connector locally (rather than deploying it to the Pulsar cluster)

Usage


$ pulsar-admin sources localrun options

Options

Flag Description Default
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the source null
--disk The disk (in bytes) that need to be allocated per source instance (applicable only to Docker runtime) null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--className The source's class name if archive is file-url-path (file://) null
--sourceConfigFile The path to a YAML config file specifying the source's configuration null
--broker-service-url The URL for the Pulsar broker null
--tls-allow-insecure Allow insecure tls connection false
--clientAuthParams Client authentication param null
--source-config Source config key/values null
--ram The RAM (in bytes) that need to be allocated per source instance (applicable only to the process and Docker runtimes) null
--tls_allow_insecure Allow insecure tls connection null
--deserializationClassName The SerDe classname for the source null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the Source null
--use_tls Use tls connection null
--use-tls Use tls connection false
--sourceConfig Source config key/values null
-st, --schema-type The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the source null
--deserialization-classname The SerDe classname for the source null
--hostname-verification-enabled Enable hostname verification false
--cpu The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime) null
--client-auth-plugin Client authentication plugin using which function-process can connect to broker null
--tls_trust_cert_path tls trust cert file path null
-a, --archive The path to the NAR archive for the Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null
--source-config-file The path to a YAML config file specifying the source's configuration null
--tls-trust-cert-path tls trust cert file path null
--parallelism The source's parallelism factor (i.e. the number of source instances to run) null
--namespace The source's namespace null
--client-auth-params Client authentication param null
--brokerServiceUrl The URL for the Pulsar broker null
--name The source's name null
--destination-topic-name The Pulsar topic to which data is sent null
--clientAuthPlugin Client authentication plugin using which function-process can connect to broker null
-o, --destinationTopicName The Pulsar topic to which data is sent null
-t, --source-type The source's connector provider null
--hostname_verification_enabled Enable hostname verification null
--classname The source's class name if archive is file-url-path (file://) null
--tenant The source's tenant null

available-sources

Get the list of Pulsar IO connector sources supported by Pulsar cluster

Usage


$ pulsar-admin sources available-sources options

reload

Reload the available built-in connectors

Usage


$ pulsar-admin sources reload options

sinks

Usage

$sinks


Interface for managing Pulsar IO sinks (egress data from Pulsar)

$ pulsar-admin sinks subcommand

create

Submit a Pulsar IO sink connector to run in a Pulsar cluster

Usage


$ pulsar-admin sinks create options

Options

Flag Description Default
--customSerdeInputs The map of input topics to SerDe class names (as a JSON string) null
--name The sink's name null
--topics-pattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in --customSerdeInputs (supported for java fun only) null
--retainOrdering Sink consumes and sinks messages in order null
--sink-config-file The path to a YAML config file specifying the sink's configuration null
--sink-config User defined configs key/values null
--topicsPattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in --customSerdeInputs (supported for java fun only) null
--sinkConfigFile The path to a YAML config file specifying the sink's configuration null
--cpu The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime) null
--tenant The sink's tenant null
--disk The disk (in bytes) that need to be allocated per sink instance (applicable only to Docker runtime) null
--sinkConfig User defined configs key/values null
--dead-letter-topic Name of the dead topic where the failing messages will be sent. null
-i, --inputs The sink's input topic or topics (multiple topics can be specified as a comma-separated list) null
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the sink null
--className The sink's class name if archive is file-url-path (file://) null
--subs-position Pulsar source subscription position if user wants to consume messages from the specified location null
--ram The RAM (in bytes) that need to be allocated per sink instance (applicable only to the process and Docker runtimes) null
--custom-serde-inputs The map of input topics to SerDe class names (as a JSON string) null
-t, --sink-type The sinks's connector provider null
--subsName Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--custom-schema-inputs The map of input topics to Schema types or class names (as a JSON string) null
--namespace The sink's namespace null
--retain-ordering Sink consumes and sinks messages in order null
--parallelism The sink's parallelism factor (i.e. the number of sink instances to run) null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the sink null
--classname The sink's class name if archive is file-url-path (file://) null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--timeout-ms The message timeout in milliseconds null
--negative-ack-redelivery-delay-ms The negative ack message redelivery delay in milliseconds null
--subs-name Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--auto-ack Whether or not the framework will automatically acknowledge messages null
--max-redeliver-count Maximum number of times that a message will be redelivered before being sent to the dead letter queue null
-a, --archive Path to the archive file for the sink. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null

update

Update a Pulsar IO sink connector

Usage


$ pulsar-admin sinks update options

Options

Flag Description Default
--customSerdeInputs The map of input topics to SerDe class names (as a JSON string) null
--name The sink's name null
--topics-pattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in --customSerdeInputs (supported for java fun only) null
--retainOrdering Sink consumes and sinks messages in order null
--sink-config-file The path to a YAML config file specifying the sink's configuration null
--sink-config User defined configs key/values null
--topicsPattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in --customSerdeInputs (supported for java fun only) null
--sinkConfigFile The path to a YAML config file specifying the sink's configuration null
--cpu The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime) null
--tenant The sink's tenant null
--update-auth-data Whether or not to update the auth data false
--disk The disk (in bytes) that need to be allocated per sink instance (applicable only to Docker runtime) null
--sinkConfig User defined configs key/values null
--dead-letter-topic Name of the dead topic where the failing messages will be sent. null
-i, --inputs The sink's input topic or topics (multiple topics can be specified as a comma-separated list) null
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the sink null
--className The sink's class name if archive is file-url-path (file://) null
--subs-position Pulsar source subscription position if user wants to consume messages from the specified location null
--ram The RAM (in bytes) that need to be allocated per sink instance (applicable only to the process and Docker runtimes) null
--custom-serde-inputs The map of input topics to SerDe class names (as a JSON string) null
-t, --sink-type The sinks's connector provider null
--subsName Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--custom-schema-inputs The map of input topics to Schema types or class names (as a JSON string) null
--namespace The sink's namespace null
--retain-ordering Sink consumes and sinks messages in order null
--parallelism The sink's parallelism factor (i.e. the number of sink instances to run) null
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the sink null
--classname The sink's class name if archive is file-url-path (file://) null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--timeout-ms The message timeout in milliseconds null
--negative-ack-redelivery-delay-ms The negative ack message redelivery delay in milliseconds null
--subs-name Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--auto-ack Whether or not the framework will automatically acknowledge messages null
--max-redeliver-count Maximum number of times that a message will be redelivered before being sent to the dead letter queue null
-a, --archive Path to the archive file for the sink. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null

delete

Stops a Pulsar IO sink connector

Usage


$ pulsar-admin sinks delete options

Options

Flag Description Default
--name The sink's name null
--namespace The sink's namespace null
--tenant The sink's tenant null

list

List all running Pulsar IO sink connectors

Usage


$ pulsar-admin sinks list options

Options

Flag Description Default
--tenant The sink's tenant null
--namespace The sink's namespace null

get

Gets the information about a Pulsar IO sink connector

Usage


$ pulsar-admin sinks get options

Options

Flag Description Default
--name The sink's name null
--namespace The sink's namespace null
--tenant The sink's tenant null

status

Check the current status of a Pulsar Sink

Usage


$ pulsar-admin sinks status options

Options

Flag Description Default
--name The sink's name null
--namespace The sink's namespace null
--instance-id The sink instanceId (Get-status of all instances if instance-id is not provided null
--tenant The sink's tenant null

stop

Stops sink instance

Usage


$ pulsar-admin sinks stop options

Options

Flag Description Default
--name The sink's name null
--namespace The sink's namespace null
--tenant The sink's tenant null
--instance-id The sink instanceId (stop all instances if instance-id is not provided null

start

Starts sink instance

Usage


$ pulsar-admin sinks start options

Options

Flag Description Default
--name The sink's name null
--namespace The sink's namespace null
--tenant The sink's tenant null
--instance-id The sink instanceId (start all instances if instance-id is not provided null

restart

Restart sink instance

Usage


$ pulsar-admin sinks restart options

Options

Flag Description Default
--instance-id The sink instanceId (restart all instances if instance-id is not provided null
--name The sink's name null
--namespace The sink's namespace null
--tenant The sink's tenant null

localrun

Run a Pulsar IO sink connector locally (rather than deploying it to the Pulsar cluster)

Usage


$ pulsar-admin sinks localrun options

Options

Flag Description Default
--customSerdeInputs The map of input topics to SerDe class names (as a JSON string) null
--tls-allow-insecure Allow insecure tls connection false
--name The sink's name null
--topics-pattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in --customSerdeInputs (supported for java fun only) null
--retainOrdering Sink consumes and sinks messages in order null
--sink-config-file The path to a YAML config file specifying the sink's configuration null
--sink-config User defined configs key/values null
--topicsPattern TopicsPattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in --customSerdeInputs (supported for java fun only) null
--sinkConfigFile The path to a YAML config file specifying the sink's configuration null
--cpu The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime) null
--tenant The sink's tenant null
--disk The disk (in bytes) that need to be allocated per sink instance (applicable only to Docker runtime) null
--tls_trust_cert_path tls trust cert file path null
--sinkConfig User defined configs key/values null
--dead-letter-topic Name of the dead topic where the failing messages will be sent. null
--client-auth-params Client authentication param null
-i, --inputs The sink's input topic or topics (multiple topics can be specified as a comma-separated list) null
--clientAuthPlugin Client authentication plugin using which function-process can connect to broker null
--processing-guarantees The processing guarantees (aka delivery semantics) applied to the sink null
--className The sink's class name if archive is file-url-path (file://) null
--tls_allow_insecure Allow insecure tls connection null
--client-auth-plugin Client authentication plugin using which function-process can connect to broker null
--subs-position Pulsar source subscription position if user wants to consume messages from the specified location null
--ram The RAM (in bytes) that need to be allocated per sink instance (applicable only to the process and Docker runtimes) null
--custom-serde-inputs The map of input topics to SerDe class names (as a JSON string) null
--hostname-verification-enabled Enable hostname verification false
-t, --sink-type The sinks's connector provider null
--clientAuthParams Client authentication param null
--subsName Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--custom-schema-inputs The map of input topics to Schema types or class names (as a JSON string) null
--namespace The sink's namespace null
--retain-ordering Sink consumes and sinks messages in order null
--parallelism The sink's parallelism factor (i.e. the number of sink instances to run) null
--use-tls Use tls connection false
--processingGuarantees The processing guarantees (aka delivery semantics) applied to the sink null
--classname The sink's class name if archive is file-url-path (file://) null
--custom-runtime-options A string that encodes options to customize the runtime, see docs for configured runtime for details null
--timeout-ms The message timeout in milliseconds null
--negative-ack-redelivery-delay-ms The negative ack message redelivery delay in milliseconds null
--broker-service-url The URL for the Pulsar broker null
--subs-name Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer null
--tls-trust-cert-path tls trust cert file path null
--brokerServiceUrl The URL for the Pulsar broker null
--auto-ack Whether or not the framework will automatically acknowledge messages null
--hostname_verification_enabled Enable hostname verification null
--use_tls Use tls connection null
--max-redeliver-count Maximum number of times that a message will be redelivered before being sent to the dead letter queue null
-a, --archive Path to the archive file for the sink. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. null

available-sinks

Get the list of Pulsar IO connector sinks supported by Pulsar cluster

Usage


$ pulsar-admin sinks available-sinks options

reload

Reload the available built-in connectors

Usage


$ pulsar-admin sinks reload options

topics

Usage

$topics


Operations on persistent topics

$ pulsar-admin topics subcommand

list

Get the list of topics under a namespace.

Usage


$ pulsar-admin topics list options

list-partitioned-topics

Get the list of partitioned topics under a namespace.

Usage


$ pulsar-admin topics list-partitioned-topics options

permissions

Get the permissions on a topic Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic.

Usage


$ pulsar-admin topics permissions options

grant-permission

Grant a new permission to a client role on a single topic.

Usage


$ pulsar-admin topics grant-permission options

Options

Flag Description Default
--role Client role to which grant permissions null
--actions Actions to be granted (produce,consume) null

revoke-permission

Revoke permissions on a topic Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412).

Usage


$ pulsar-admin topics revoke-permission options

Options

Flag Description Default
--role Client role to which revoke permissions null

lookup

Lookup a topic from the current serving broker

Usage


$ pulsar-admin topics lookup options

bundle-range

Get Namespace bundle range of a topic

Usage


$ pulsar-admin topics bundle-range options

delete

Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.

Usage


$ pulsar-admin topics delete options

Options

Flag Description Default
-f, --force Close all producer/consumer/replicator and delete topic forcefully false
-d, --deleteSchema Delete schema while deleting topic false

unload

Unload a topic.

Usage


$ pulsar-admin topics unload options

subscriptions

Get the list of subscriptions on the topic

Usage


$ pulsar-admin topics subscriptions options

unsubscribe

Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it

Usage


$ pulsar-admin topics unsubscribe options

Options

Flag Description Default
-f, --force Disconnect and close all consumers and delete subscription forcefully false
-s, --subscription Subscription to be deleted null

create-subscription

Create a new subscription on a topic

Usage


$ pulsar-admin topics create-subscription options

Options

Flag Description Default
-s, --subscription Subscription to reset position on null
--messageId, -m messageId where to create the subscription. It can be either 'latest', 'earliest' or (ledgerId:entryId) latest

stats

Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.

Usage


$ pulsar-admin topics stats options

Options

Flag Description Default
-gpb, --get-precise-backlog Set true to get precise backlog false

stats-internal

Get the internal stats for the topic

Usage


$ pulsar-admin topics stats-internal options

info-internal

Get the internal metadata info for the topic

Usage


$ pulsar-admin topics info-internal options

partitioned-stats

Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.

Usage


$ pulsar-admin topics partitioned-stats options

Options

Flag Description Default
-gpb, --get-precise-backlog Set true to get precise backlog false
--per-partition Get per partition stats false

partitioned-stats-internal

Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.

Usage


$ pulsar-admin topics partitioned-stats-internal options

skip

Skip some messages for the subscription

Usage


$ pulsar-admin topics skip options

Options

Flag Description Default
-s, --subscription Subscription to be skip messages on null
-n, --count Number of messages to skip 0

clear-backlog

Skip all the messages for the subscription

Usage


$ pulsar-admin topics clear-backlog options

Options

Flag Description Default
-s, --subscription Subscription to be cleared null

expire-messages

Expire messages that older than given expiry time (in seconds) for the subscription

Usage


$ pulsar-admin topics expire-messages options

Options

Flag Description Default
-t, --expireTime Expire messages older than time in seconds 0
-s, --subscription Subscription to be skip messages on null

expire-messages-all-subscriptions

Expire messages that older than given expiry time (in seconds) for all subscriptions

Usage


$ pulsar-admin topics expire-messages-all-subscriptions options

Options

Flag Description Default
-t, --expireTime Expire messages older than time in seconds 0

create-partitioned-topic

Create a partitioned topic. The partitioned topic has to be created before creating a producer on it.

Usage


$ pulsar-admin topics create-partitioned-topic options

Options

Flag Description Default
-p, --partitions Number of partitions for the topic 0

create-missed-partitions

Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled

Usage


$ pulsar-admin topics create-missed-partitions options

create

Create a non-partitioned topic.

Usage


$ pulsar-admin topics create options

update-partitioned-topic

Update existing non-global partitioned topic. New updating number of partitions must be greater than existing number of partitions.

Usage


$ pulsar-admin topics update-partitioned-topic options

Options

Flag Description Default
-p, --partitions Number of partitions for the topic 0

get-partitioned-topic-metadata

Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions

Usage


$ pulsar-admin topics get-partitioned-topic-metadata options

delete-partitioned-topic

Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.

Usage


$ pulsar-admin topics delete-partitioned-topic options

Options

Flag Description Default
-d, --deleteSchema Delete schema while deleting topic false
-f, --force Close all producer/consumer/replicator and delete topic forcefully false

peek-messages

Peek some messages for the subscription

Usage


$ pulsar-admin topics peek-messages options

Options

Flag Description Default
-n, --count Number of messages (default 1) 1
-s, --subscription Subscription to get messages from null

get-message-by-id

Get message by its ledgerId and entryId

Usage


$ pulsar-admin topics get-message-by-id options

Options

Flag Description Default
-l, --ledgerId ledger id pointing to the desired ledger 0
-e, --entryId entry id pointing to the desired entry 0

reset-cursor

Reset position for subscription to a position that is closest to timestamp or messageId.

Usage


$ pulsar-admin topics reset-cursor options

Options

Flag Description Default
--time, -t time in minutes to reset back to (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w) null
-s, --subscription Subscription to reset position on null
--messageId, -m messageId to reset back to (ledgerId:entryId) null

terminate

Terminate a topic and don't allow any more messages to be published

Usage


$ pulsar-admin topics terminate options

compact

Compact a topic

Usage


$ pulsar-admin topics compact options

compaction-status

Status of compaction on a topic

Usage


$ pulsar-admin topics compaction-status options

Options

Flag Description Default
-w, --wait-complete Wait for compaction to complete false

offload

Trigger offload of data from a topic to long-term storage (e.g. Amazon S3)

Usage


$ pulsar-admin topics offload options

Options

Flag Description Default
-s, --size-threshold Maximum amount of data to keep in BookKeeper for the specified topic (e.g. 10M, 5G). null

offload-status

Check the status of data offloading from a topic to long-term storage

Usage


$ pulsar-admin topics offload-status options

Options

Flag Description Default
-w, --wait-complete Wait for offloading to complete false

last-message-id

get the last commit message id of topic

Usage


$ pulsar-admin topics last-message-id options

tenants

Usage

$tenants


Operations about tenants

$ pulsar-admin tenants subcommand

list

List the existing tenants

Usage


$ pulsar-admin tenants list options

get

Gets the configuration of a tenant

Usage


$ pulsar-admin tenants get options

create

Creates a new tenant

Usage


$ pulsar-admin tenants create options

Options

Flag Description Default
--allowed-clusters, -c Comma separated allowed clusters. If empty, the tenant will have access to all clusters null
--admin-roles, -r Comma separated list of auth principal allowed to administrate the tenant null

update

Updates the configuration for a tenant

Usage


$ pulsar-admin tenants update options

Options

Flag Description Default
--allowed-clusters, -c Comma separated allowed clusters. If omitted, the current set of clusters will be preserved null
--admin-roles, -r Comma separated list of auth principal allowed to administrate the tenant. If empty the current set of roles won't be modified null

delete

Deletes an existing tenant

Usage


$ pulsar-admin tenants delete options

resource-quotas

Usage

$resource-quotas


Operations about resource quotas

$ pulsar-admin resource-quotas subcommand

get

Get the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified.

Usage


$ pulsar-admin resource-quotas get options

Options

Flag Description Default
--namespace, -n property/cluster/namespace, must be specified together with '--bundle' null
--bundle, -b {start-boundary}_{end-boundary}, must be specified together with '--namespace' null

set

Set the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified.

Usage


$ pulsar-admin resource-quotas set options

Options

Flag Description Default
--msgRateIn, -mi expected incoming messages per second 0
--bandwidthIn, -bi expected inbound bandwidth (bytes/second) 0
--msgRateOut, -mo expected outgoing messages per second 0
--namespace, -n property/cluster/namespace, must be specified together with '--bundle' null
--bundle, -b {start-boundary}_{end-boundary}, must be specified together with '--namespace' null
--memory, -mem expected memory usage (Mbytes) 0
--dynamic, -d dynamic (allow to be dynamically re-calculated) or not false
--bandwidthOut, -bo expected outbound bandwidth (bytes/second) 0

reset-namespace-bundle-quota

Reset the specified namespace bundle's resource quota to default value.

Usage


$ pulsar-admin resource-quotas reset-namespace-bundle-quota options

Options

Flag Description Default
--bundle, -b {start-boundary}_{end-boundary} null
--namespace, -n property/cluster/namespace null

schemas

Usage

$schemas


Operations about schemas

$ pulsar-admin schemas subcommand

get

Get the schema for a topic

Usage


$ pulsar-admin schemas get options

Options

Flag Description Default
--version version null

delete

Delete the latest schema for a topic

Usage


$ pulsar-admin schemas delete options

upload

Update the schema for a topic

Usage


$ pulsar-admin schemas upload options

Options

Flag Description Default
-f, --filename filename null

extract

Provide the schema via a topic

Usage


$ pulsar-admin schemas extract options

Options

Flag Description Default
-n, --dry-run dost not apply to schema registry, just prints the post schema payload false
-c, --classname class name of pojo null
-j, --jar jar filepath null
--always-allow-null set schema whether always allow null or not true
-t, --type type avro or json null