Back to Yugabyte Db

Yba Provider Onprem Update

managed/yba-cli/docs/yba_provider_onprem_update.md

2026.1.0.0-b295.3 KB
Original Source

yba provider onprem update

Update an On-premises YugabyteDB Anywhere provider

Synopsis

Update an On-premises provider in YugabyteDB Anywhere

yba provider onprem update [flags]

Examples

yba provider onprem update --name <provider-name> \
	--new-name <new-provider-name>

Options

      --new-name string             [Optional] Updating provider name.
      --add-region stringArray      [Optional] Add region associated with the On-premises provider. Provide the following double colon (::) separated fields as key-value pairs: "region-name=<region-name>::latitude=<latitude>::longitude=<longitude>". Region name is a required key-value. Latitude and Longitude are optional. Each region needs to be added using a separate --add-region flag.
      --add-zone stringArray        [Optional] Zone associated to the On-premises Region defined. Provide the following double colon (::) separated fields as key-value pairs: "zone-name=<zone-name>::region-name=<region-name>". Zone name and Region name are required values. Each --add-region definition must have atleast one corresponding --add-zone definition. Multiple --add-zone definitions can be provided per region.Each zone needs to be added using a separate --add-zone flag.
      --remove-region stringArray   [Optional] Region name to be removed from the provider. Each region to be removed needs to be provided using a separate --remove-region definition. Removing a region removes the corresponding zones.
      --remove-zone stringArray     [Optional] Remove zone associated to the On-premises Region defined. Provide the following double colon (::) separated fields as key-value pairs: "zone-name=<zone-name>::region-name=<region-name>". Zone name, Region name are required values. Each zone needs to be removed using a separate --remove-zone flag.
      --edit-region stringArray     [Optional] Edit region details associated with the On-premises provider. Provide the following double colon (::) separated fields as key-value pairs: "region-name=<region-name>::latitude=<latitude>::longitude=<longitude>". Region name is a required key-value. Latitude and Longitude are optional. Each region needs to be modified using a separate --edit-region flag.
      --ssh-user string             [Optional] Updating SSH User to access the YugabyteDB nodes.
      --ssh-port int                [Optional] Updating SSH Port to access the YugabyteDB nodes.
      --airgap-install              [Optional] Are YugabyteDB nodes installed in an air-gapped environment, lacking access to the public internet for package downloads. (default false)
      --passwordless-sudo-access    [Optional] Can sudo actions be carried out by user without a password.
      --skip-provisioning           [Optional] Set to true if YugabyteDB nodes have been prepared manually, set to false to provision during universe creation.
      --install-node-exporter       [Optional] Install Node exporter.
      --node-exporter-user string   [Optional] Node Exporter User.
      --node-exporter-port int      [Optional] Node Exporter Port.
      --ntp-servers stringArray     [Optional] List of NTP Servers. Can be provided as separate flags or as comma-separated values.
      --yb-home-dir string          [Optional] YB Home directory.
      --use-clockbound              [Optional] Configure and use ClockBound for clock synchronization. Requires ClockBound to be set up on the nodes.
  -h, --help                        help for update

Options inherited from parent commands

  -a, --apiToken string    YugabyteDB Anywhere api token.
      --ca-cert string     CA certificate file path for secure connection to YugabyteDB Anywhere. Required when the endpoint is https and --insecure is not set.
      --config string      Full path to a specific configuration file for YBA CLI. If provided, this takes precedence over the directory specified via --directory, and the generated files are added to the same path. If not provided, the CLI will look for '.yba-cli.yaml' in the directory specified by --directory. Defaults to '$HOME/.yba-cli/.yba-cli.yaml'.
      --debug              Use debug mode, same as --logLevel debug.
      --directory string   Directory containing YBA CLI configuration and generated files. If specified, the CLI will look for a configuration file named '.yba-cli.yaml' in this directory. Defaults to '$HOME/.yba-cli/'.
      --disable-color      Disable colors in output. (default false)
  -H, --host string        YugabyteDB Anywhere Host (default "http://localhost:9000")
      --insecure           Allow insecure connections to YugabyteDB Anywhere. Value ignored for http endpoints. Defaults to false for https.
  -l, --logLevel string    Select the desired log level format. Allowed values: debug, info, warn, error, fatal. (default "info")
  -n, --name string        [Optional] The name of the provider for the action. Required for create, delete, describe, update, instance-type and node.
  -o, --output string      Select the desired output format. Allowed values: table, json, pretty. (default "table")
      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
      --wait               Wait until the task is completed, otherwise it will exit immediately. (default true)

SEE ALSO