atlas clusters search nodes create
On this page
Create a search node for a cluster.
To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role.
Syntax
atlas clusters search nodes create [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. |
-f, --file | string | true | Name of the JSON index configuration file to use. To learn about the Atlas Search Nodes configuration file, see https://dochub.mongodb.org/core/search-nodes-config-file-atlascli. |
-h, --help | false | help for create | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
-w, --watch | false | Flag that indicates whether to watch the command until it completes its execution or the watch times out. | |
--watchTimeout | int | false | Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Search nodes are being created.
Examples
# Create a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: atlas clusters search nodes create --clusterName myCluster --file spec.json --output json