connectivity direct-access-agent benchmark create

qlik connectivity direct-access-agent benchmark create

Start an agent benchmark

Synopsis

Starts a background benchmark task that measures the throughput and latency of a Direct Access agent. Use the returned benchmarkId to monitor progress and retrieve performance metrics for capacity planning or performance optimization. The requestor must have the TenantAdmin role and be either the gateway’s space owner or a member of the gateway’s space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

qlik connectivity direct-access-agent benchmark create <direct-access-agentId> [flags]

Options

      --description string        The description for the benchmark task.
      --force                     Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution.
      --gigaBytesToTransfer int   The volume of data in GB to transfer during the throughput measurement part of the benchmark.
  -h, --help                      help for create
      --interval int              Duration in seconds to wait between retries, at least 1 (default 1)
      --name string               The name to assign to the benchmark task.
  -q, --quiet                     Return only IDs from the command
      --raw                       Return original response from server without any processing
      --retry int                 Number of retries to do before failing, max 10

Options inherited from parent commands

  -c, --config string            path/to/config.yml where parameters can be set instead of on the command line
      --context string           Name of the context used when connecting to Qlik Associative Engine
      --headers stringToString   HTTP headers to use when connecting to Qlik Associative Engine (default [])
      --insecure                 Allow connecting to hosts with self-signed certificates
      --json                     Returns output in JSON format, if possible. Disables verbose and traffic output
  -s, --server string            URL to Qlik Cloud or directly to a Qlik Associative Engine
      --server-type string       The type of server you are using: cloud, Windows (Enterprise on Windows) or engine
  -v, --verbose                  Log extra information