Copy page

Commands

Documentation for `scw searchdb`

Cloud Essentials for Opensearch API.

Manage your Cloud Essentials for OpenSearch deployment.

Create a new Cloud Essentials for OpenSearch deployment

Create a new Cloud Essentials for OpenSearch deployment.

Usage:

Code
scw searchdb deployment create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
name	Name of the deployment
tags.{index}	Tags
node-amount	DEPRECATED: Use node_count instead. Number of nodes	Deprecated
node-count	Number of nodes.
node-type	Node type
user-name	Username for the deployment user
password	Password for the deployment user
volume.type	Define the type of the Volume	One of: unknown_type, sbs_5k, sbs_15k
volume.size-bytes	Define the size of the Volume
endpoints.{index}.public
endpoints.{index}.private-network.private-network-id
version	The Opensearch version to use
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Delete a Cloud Essentials for OpenSearch deployment

Delete a Cloud Essentials for OpenSearch deployment.

Usage:

Code
scw searchdb deployment delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Retrieve a specific Cloud Essentials for OpenSearch deployment

Retrieve a specific Cloud Essentials for OpenSearch deployment.

Usage:

Code
scw searchdb deployment get [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Retrieve a list of Cloud Essentials for OpenSearch deployments

Retrieve a list of Cloud Essentials for OpenSearch deployments.

Usage:

Code
scw searchdb deployment list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	ID of the Project containing the deployments
order-by	Define the order of the returned deployments	One of: created_at_asc, created_at_desc, name_asc, name_desc, updated_at_asc, updated_at_desc
tags.{index}	Filter by tag, only deployments with one or more matching tags will be returned
name	Deployment name to filter for
organization-id	ID of the Organization containing the deployments
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Update a Cloud Essentials for OpenSearch deployment

Update a Cloud Essentials for OpenSearch deployment.

Usage:

Code
scw searchdb deployment update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment to update	Required
name	Name of the deployment
tags.{index}	Tags of a deployment
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Upgrade a Cloud Essentials for OpenSearch deployment

Upgrade a Cloud Essentials for OpenSearch deployment.

Usage:

Code
scw searchdb deployment upgrade [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the Deployment to upgrade	Required
node-amount	DEPRECATED: Use node_count instead. Amount of node upgrade target	Deprecated
node-count	The target number of nodes for the upgrade.
volume-size-bytes	Volume size upgrade target
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Manage your Cloud Essentials for OpenSearch deployment endpoint.

Create a new endpoint on a deployment

Create a new endpoint on a deployment.

Usage:

Code
scw searchdb endpoint create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment for which to create an endpoint
endpoint-spec.public
endpoint-spec.private-network.private-network-id
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Delete an existing endpoint

Delete an existing endpoint.

Usage:

Code
scw searchdb endpoint delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
endpoint-id	ID of the endpoint to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

List available node types.

Retrieve a list of available node types

Retrieve a list of available node types.

Usage:

Code
scw searchdb node-types list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order of nodes in the response (name, vcpus or memory)	One of: name_asc, name_desc, vcpus_asc, vcpus_desc, memory_asc, memory_desc
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Manage your Cloud Essentials for OpenSearch deployment users.

Create a new user

Create a new user.

Usage:

Code
scw searchdb user create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment in which to create the user	Required
username	Username of the deployment user
password	Password of the deployment user
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Delete an existing user

Delete an existing user.

Usage:

Code
scw searchdb user delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment in which to create the user	Required
username	Username of the deployment user	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Retrieve a list of deployment users

Retrieve a list of deployment users.

Usage:

Code
scw searchdb user list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by		One of: name_asc, name_desc
name
deployment-id		Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Update an existing user

Update an existing user.

Usage:

Code
scw searchdb user update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment in which to create the user	Required
username	Username of the deployment user	Required
password	Password of the deployment user
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

List your Cloud Essentials for OpenSearch versions.

List available Cloud Essentials for OpenSearch versions

List available Cloud Essentials for OpenSearch versions.

Usage:

Code
scw searchdb versions list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Define the order of the returned version	One of: version_asc, version_desc
version	Filter by version
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all