Project: YugabyteDB (App Definition and Development / Database)
File: yba_provider_onprem_create.md

Create an On-premises YugabyteDB Anywhere provider Create an On-premises provider in YugabyteDB Anywhere. To utilize the on-premises provider in universes, manage instance types and node instances using the "yba provider onprem instance-types/node [operation]" set of commands ``` yba provider onprem create [flags] ``` ``` yba provider onprem create --name <provider-name> \ --region region-name=region1 --region region-name=region2 \ --zone zone-name=zone1,region-name=region1 \ --zone zone-name=zone2,region-name=region2 \ --ssh-user centos \ --ssh-keypair-name <keypair-name> \ --ssh-keypair-file-path <path-to-ssh-key-file> ``` ``` --ssh-keypair-name string [Required] Provider key pair name to access YugabyteDB nodes. --ssh-keypair-file-path string [Optional] Provider key pair file path to access YugabyteDB nodes. One of ssh-keypair-file-path or ssh-keypair-file-contentsrequired with --ssh-keypair-name. --ssh-keypair-file-contents string [Optional] Provider key pair file contents to access YugabyteDB nodes. One of ssh-keypair-file-path or ssh-keypair-file-contentsrequired with --ssh-keypair-name. --ssh-user string [Required] SSH User. --ssh-port int [Optional] SSH Port. (default 22) --region stringArray [Required] Region associated with the On-premises provider. Minimum number of required regions = 1. Provide the following comma separated fields as key-value pairs:"region-name=<region-name>,latitude=<latitude>,longitude=<longitude>". Region name is a required key-value. Latitude and Longitude (Defaults to 0.0) are optional. Each region needs to be added using a separate --region flag. Example: --region region-name=us-west-1 --region region-name=us-west-2 --zone stringArray [Required] Zone associated to the On-premises Region defined. Provide the following comma separated fields as key-value pairs:"zone-name=<zone-name>,region-name=<region-name>". Zone name and Region name are required values. Each --region definition must have atleast one corresponding --zone definition. Multiple --zone definitions can be provided per region. Each zone needs to be added using a separate --zone flag. Example: --zone zone-name=us-west-1a,region-name=us-west-1 --zone zone-name=us-west-1b,region-name=us-west-1 --passwordless-sudo-access [Optional] Can sudo actions be carried out by user without a password. (default true) --skip-provisioning [Optional] Set to true if YugabyteDB nodes have been prepared manually, set to false to provision during universe creation. (default false) --airgap-install [Optional] Are YugabyteDB nodes installed in an air-gapped environment, lacking access to the public internet for package downloads. (default false) --install-node-exporter [Optional] Install Node exporter. (default true) --node-exporter-user string [Optional] Node Exporter User. (default "prometheus") --node-exporter-port int [Optional] Node Exporter Port. (default 9300) --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. -h, --help help for create ``` ``` -a, --apiToken string YugabyteDB Anywhere api token. --config string Config file, defaults to $HOME/.yba-cli.yaml --debug Use debug mode, same as --logLevel debug. --disable-color Disable colors in output. (default false) -H, --host string YugabyteDB Anywhere Host (default "http://localhost:9000") -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, instance-types and nodes. -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) ``` - Manage a YugabyteDB Anywhere on-premises provider