install_vertica options
The table below describes all
install_vertica
script options. Most options have a long and short form—for example, --hosts
and -s
.
install_vertica
minimally requires two options:
-
--hosts
/-s
-
--rpm
/-r
|--deb
For example:
# /opt/vertica/sbin/install_vertica --hosts node0001,node0002,node0003 \
--rpm /tmp/vertica-10.1.1-0.x86_64.RHEL6.rpm
For details on minimal installation requirements, see Perform a basic install.
Option | Description |
---|---|
--help |
Display help for this script. |
--accept-eula -Y |
Silently accepts the EULA agreement. On multi-node installations, this option is propagated across the cluster at the end of the installation, at the same time as the Administration Tools metadata. Combine this option with |
--add-hosts host-list -A host-list |
A comma-separated list of hosts to add to an existing Vertica cluster.
ImportantIf you used
You can also use this option with the |
--broadcast -U |
Specifies that Vertica use UDP broadcast traffic by spread between nodes on the subnet. This option is automatically used by default. No more than 80 spread daemons are supported by broadcast traffic. It is possible to have more than 80 nodes by using large cluster mode, which does not install a spread daemon on each node (see Large cluster). Do not combine this option with ImportantWhen changing the configuration from--broadcast (-U ) (the default) to --point-to-point (-T ) or vice-versa, you must also specify --control-network (-S ).
|
--clean |
Forcibly cleans previously stored configuration files. Use this option if you need to change the hosts that are included in your cluster. Only use this option when no database is defined. This option cannot be combined with |
--config-file file -z file |
Accepts an existing properties file created by --record-config . This properties file contains key/value settings that map to options in the
install_vertica script, many with Boolean arguments that default to false. |
--control-network { bcast-addess | default } -S { bcast-addess | default } |
Set to one of the following arguments:
Important
Ideally, the value for
You can also use this option to force a cluster-wide spread reconfiguration when changing spread related options. |
--data-dir data-directory -d data-directory |
Specifies the directory for database data and catalog files. For more information, see Specifying disk storage location during installation. CautionDo not use a shared directory over more than one host for this setting. Data and catalog directories must be distinct for each node. Multiple nodes must not be allowed to write to the same data or catalog directory. Default: |
--dba-group group -g group |
The UNIX group for DBA users. Default: |
--dba-user dba-username -u dba-username |
The name of the database superuser system account to create. Only this account can run the Administration Tools. If you omit this option, then the default database administrator account name is This option is optional for new installations done as root but must be specified when upgrading or when installing using sudo. If upgrading, use this option to specify the same DBA account name that you used previously. If installing using sudo, NoteIf you manually create the user, modify the user's |
--dba-user-home dba-home-directory -l dba-home-directory |
The home directory for the database administrator. Default: |
--dba-user-password dba-password -p dba-password |
The password for the database administrator account. If not supplied, the script prompts for a password and does not echo the input. |
--dba-user-password-disabled |
Disables the password for --dba-user . This argument stops the installer from prompting for a password for --dba-user . You can assign a password later using standard user management tools such as passwd . |
--failure-threshold [ threshold-arg ] |
Stops the installation when the specified failure threshold is encountered, where
Default: |
--hosts host-list -s host-list |
A comma-separated list of host names or IP addresses to include in the cluster, where
The following requirements apply:
|
--ipv4 |
Hosts in the cluster are identified by IPv4 network addresses. This is the default behavior. |
--ipv6 |
Hosts in the cluster are identified by IPv6 network addresses. You must specify this option when you pass IPv6 addresses in the --hosts list. If you use host names in the --hosts option, the names must resolve to IPv6 addresses. This option automatically enables the -- point-to-point option. |
--large-cluster [ num-control-nodes | default] |
Enables the large cluster feature, where a subset of nodes called control nodes connect to Spread to send and receive broadcast messages. Consider using this option for a cluster with more than 50 nodes in Enterprise Mode. Vertica automatically enables this feature if you install onto 120 or more nodes in Enterprise Mode, or 16 or more nodes in Eon Mode. Supply this option with one of the following arguments:
NoteVertica sets the number of control nodes for the database to the value you specify here or the number of nodes in the
See Enable Large Cluster When Installing Vertica for more information. Default: |
--license { licensefile | CE } -L { licensefile | CE } |
Silently and automatically deploys the license key to If specified with For example:
|
--no-system-configuration |
Specifies that the installer makes no changes to system properties. By default, the installer makes system configuration changes to meet server requirements. If you use this option, the installer posts warnings or failures for configuration settings that do not meet requirements that it otherwise configures automatically. NoteThis option has no effect on creating or updating user accounts. |
--point-to-point -T |
Configures spread to use direct point-to-point communication between all Vertica nodes. Use this option if your nodes are not located on the same subnet. Also use this option for all virtual environment installations, whether the virtual servers are on the same subnet or not. The maximum number of spread daemons supported in point-to-point communication in Vertica is 80. It is possible to have more than 80 nodes by using large cluster mode, which does not install a spread daemon on each node. Do not combine this option with This option is automatically enabled when you enable the ImportantWhen changing the configuration from--broadcast (-U ) (the default) to --point-to-point (-T ) or vice-versa, you must also specify --control-network (-S ).
|
--record-config filename -B filename |
Accepts a file name, which when used in conjunction with command line options, creates a properties file that can be used with --config-file (-z ). This option creates the properties file and exits; it does not affect installation. |
--remove-hosts host-list -R host-list |
A comma-separated list of hosts to remove from an existing Vertica cluster.
Notes:
|
--rpm * package-name* -r * package-name* --deb * package-name* |
The name of the RPM or Debian package. For example:
The install package must be provided if installing or upgrading multiple nodes and the nodes do not have the latest server package installed, or if you are adding a new node. The TipIf installing or upgrading a large number of nodes, consider manually installing the package on all nodes before running the upgrade script, as the script runs faster if it does not need to serially upload and install the package on each node. |
--spread-logging -w |
Configures spread to output logging to NoteDo not enable spread logging unless so directed by Vertica technical support. |
--ssh-identity file -i file |
The root private-key Vertica accepts the following:
|
--ssh-password password -P password |
The password to use by default for each cluster host. If you omit this option, and you also omit specifying Do not use this option together with ImportantSpecify the password as follows:
|
--temp-dir directory |
The temporary directory used for administrative purposes. If it is a directory within NoteThis is not a temporary data location for the database. Default: |