OpenSearch index installation script parameters

A list of parameters that you typically need to set for your OpenSearch index installation script. Additional parameters are available for setting maximum connections and timeout periods. To display a list of all the available parameters and examples, use the script's help parameter.

ParameterValue descriptionDefault if not specified
os-host

The name of the host on which your OpenSearch instance runs

localhost

os-port

The number of the port on which your OpenSearch instance runs

9200

os-username

If the OpenSearch instance is secured, the name of a user who can access the OpenSearch instance

none (OpenSearch instance is not secured)

os-password

If the OpenSearch instance is secured, the password of the user above

none (OpenSearch instance is not secured)

os-scheme

Indicates whether OpenSearch will connect over the HTTP protocol or the secure HTTPS protocol.

http

os-ingest-username

If you connect to the OpenSearch instance through Basic Authentication (typically to connect to an external OpenSearch like Elastic Cloud), the name of a user who can access the OpenSearch ingest node

none (no Basic Authentication set up for the OpenSearch instance)

os-ingest-password

If you connect to the OpenSearch instance through Basic Authentication, the password of the user above

none (no Basic Authentication set up for the OpenSearch instance)