OS Manuals

/usr/bin/vtctlclient

All the binaries built by Vitess

From vitess-23-binaries 23.0.4-r5 (os), captured 2026-11-05 by running vtctlclient --help (exit 0). permalink

Usage of /usr/bin/vtctlclient:
      --action-timeout duration                                     timeout for the total command (default 1h0m0s)
      --alsologtostderr                                             log to standard error as well as files
      --config-file string                                          Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
      --config-file-not-found-handling ConfigFileNotFoundHandling   Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
      --config-name string                                          Name of the config file (without extension) to search for. (default "vtconfig")
      --config-path strings                                         Paths to search for config files in. (default [/tmp])
      --config-persistence-min-interval duration                    minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
      --config-type string                                          Config file type (omit to infer config type from file extension).
      --datadog-agent-host string                                   host to send spans to. if empty, no tracing will be done
      --datadog-agent-port string                                   port to send spans to. if empty, no tracing will be done
      --datadog-trace-debug-mode                                    enable debug mode for datadog tracing
      --grpc-auth-static-client-creds string                        When using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.
      --grpc-compression string                                     Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
      --grpc-dial-concurrency-limit int                             Maximum concurrency of grpc dial operations. This should be less than the golang max thread limit of 10000. (default 1024)
      --grpc-enable-tracing                                         Enable gRPC tracing.
      --grpc-initial-conn-window-size int                           gRPC initial connection window size
      --grpc-initial-window-size int                                gRPC initial window size
      --grpc-keepalive-time duration                                After a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive. (default 10s)
      --grpc-keepalive-timeout duration                             After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s)
      --grpc-max-message-size int                                   Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216)
      --grpc-prometheus                                             Enable gRPC monitoring with Prometheus.
  -h, --help                                                        display usage and exit
      --jaeger-agent-host string                                    host and port to send spans to. if empty, no tracing will be done
      --keep-logs duration                                          keep logs for this long (using ctime) (zero to keep forever)
      --keep-logs-by-mtime duration                                 keep logs for this long (using mtime) (zero to keep forever)
      --log-err-stacks                                              log stack traces for errors
      --log-rotate-max-size uint                                    size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
      --log_backtrace_at traceLocations                             when logging hits line file:N, emit a stack trace
      --log_dir string                                              If non-empty, write log files in this directory
      --log_link string                                             If non-empty, add symbolic links in this directory to the log files
      --logbuflevel int                                             Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; ...). Has limited applicability on non-prod platforms.
      --logtostderr                                                 log to standard error instead of files
      --pprof strings                                               enable profiling
      --pprof-http                                                  enable pprof http endpoints
      --purge-logs-interval duration                                how often try to remove old logs (default 1h0m0s)
      --security-policy string                                      the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
      --server string                                               server to use for connection
      --stderrthreshold severityFlag                                logs at or above this threshold go to stderr (default 1)
      --tracer string                                               tracing service to use (default "noop")
      --tracing-enable-logging                                      whether to enable logging in the tracing service
      --tracing-sampling-rate float                                 sampling rate for the probabilistic jaeger sampler (default 0.1)
      --tracing-sampling-type string                                sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default "const")
      --v Level                                                     log level for V logs
  -v, --version                                                     print binary version
      --vmodule vModuleFlag                                         comma-separated list of pattern=N settings for file-filtered logging
      --vtctl-client-protocol string                                Protocol to use to talk to the vtctl server. (default "grpc")
      --vtctld-grpc-ca string                                       the server ca to use to validate servers when connecting
      --vtctld-grpc-cert string                                     the cert to use to connect
      --vtctld-grpc-crl string                                      the server crl to use to validate server certificates when connecting
      --vtctld-grpc-key string                                      the key to use to connect
      --vtctld-grpc-server-name string                              the server name to use to validate server certificate
Options (51)
OptionDescriptionSource
--action-timeout durationtimeout for the total command (default 1h0m0s)help
--alsologtostderrlog to standard error as well as fileshelp
--config-file stringFull path of the config file (with extension) to use.help
--config-file-not-found-handling ConfigFileNotFoundHandlingBehavior when a config file is not found.help
--config-name stringName of the config file (without extension) to search for.help
--config-path stringsPaths to search for config files in.help
--config-persistence-min-interval durationminimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done).help
--config-type stringConfig file type (omit to infer config type from file extension).help
--datadog-agent-host stringhost to send spans to.help
--datadog-agent-port stringport to send spans to.help
--datadog-trace-debug-modeenable debug mode for datadog tracinghelp
--grpc-auth-static-client-creds stringWhen using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.help
--grpc-compression stringWhich protocol to use for compressing gRPC.help
--grpc-dial-concurrency-limit intMaximum concurrency of grpc dial operations.help
--grpc-enable-tracingEnable gRPC tracing.help
--grpc-initial-conn-window-size intgRPC initial connection window sizehelp
--grpc-initial-window-size intgRPC initial window sizehelp
--grpc-keepalive-time durationAfter a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive.help
--grpc-keepalive-timeout durationAfter having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed.help
--grpc-max-message-size intMaximum allowed RPC message size.help
--grpc-prometheusEnable gRPC monitoring with Prometheus.help
-h, --helpdisplay usage and exithelp
--jaeger-agent-host stringhost and port to send spans to.help
--keep-logs durationkeep logs for this long (using ctime) (zero to keep forever)help
--keep-logs-by-mtime durationkeep logs for this long (using mtime) (zero to keep forever)help
--log-err-stackslog stack traces for errorshelp
--log-rotate-max-size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)help
--log_backtrace_at traceLocationswhen logging hits line file:N, emit a stack tracehelp
--log_dir stringIf non-empty, write log files in this directoryhelp
--log_link stringIf non-empty, add symbolic links in this directory to the log fileshelp
--logbuflevel intBuffer log messages logged at this level or lower (-1 means don't buffer;help
--logtostderrlog to standard error instead of fileshelp
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--purge-logs-interval durationhow often try to remove old logs (default 1h0m0s)help
--security-policy stringthe name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)help
--server stringserver to use for connectionhelp
--stderrthreshold severityFlaglogs at or above this threshold go to stderr (default 1)help
--tracer stringtracing service to use (default "noop")help
--tracing-enable-loggingwhether to enable logging in the tracing servicehelp
--tracing-sampling-rate floatsampling rate for the probabilistic jaeger sampler (default 0.1)help
--tracing-sampling-type stringsampling strategy to use for jaeger.help
--v Levellog level for V logshelp
-v, --versionprint binary versionhelp
--vmodule vModuleFlagcomma-separated list of pattern=N settings for file-filtered logginghelp
--vtctl-client-protocol stringProtocol to use to talk to the vtctl server.help
--vtctld-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--vtctld-grpc-cert stringthe cert to use to connecthelp
--vtctld-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--vtctld-grpc-key stringthe key to use to connecthelp
--vtctld-grpc-server-name stringthe server name to use to validate server certificatehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.