Copy page

Commands

Documentation for `scw messageq`

MessageQ API.

Manage your MessageQ deployment

Manage your MessageQ deployment.

Create a new MessageQ deployment

Create a new MessageQ deployment.

Usage:

Code
scw messageq 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-count	Number of nodes
node-type	Node type to use
user-name	Username for the deployment user
password	Password for the deployment user
volume.type	Type of the Volume	One of: unknown_type, sbs_5k, sbs_15k
volume.size-bytes	Size of the Volume
endpoints.{index}.public
endpoints.{index}.private-network.private-network-id
version	The MessageQ 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 MessageQ deployment

Delete a MessageQ deployment.

Usage:

Code
scw messageq 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 MessageQ deployment

Retrieve a specific MessageQ deployment.

Usage:

Code
scw messageq 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 MessageQ deployments

Retrieve a list of MessageQ deployments.

Usage:

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

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to filter for, only deployments from this Project will be returned
order-by	Sort order for deployments in the response	One of: created_at_asc, created_at_desc, name_asc, name_desc, updated_at_asc, updated_at_desc
tags.{index}	Tags to filter for, only deployments with one or more matching tags will be returned
name	Deployment name to filter for, only deployments with this string within their name will be returned
organization-id	Organization ID to filter for, only deployments from this Organization will be returned
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 MessageQ deployment

Update a MessageQ deployment.

Usage:

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

Arguments:

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

Upgrade a MessageQ deployment

Upgrade a MessageQ deployment.

Usage:

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

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment	Required
node-count	Target number of nodes
volume-size-bytes	Target volume size
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Manage your MessageQ deployment endpoints

Manage your MessageQ deployment endpoints.

Create a new endpoint for a deployment

Create a new endpoint for a deployment.

Usage:

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

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment
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 messageq endpoint delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
endpoint-id	ID of the endpoint	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

List available node types.

Retrieve a list of available node types

Retrieve a list of available node types.

Usage:

Code
scw messageq node-type list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for versions in the response	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 MessageQ deployment users

Manage your MessageQ deployment users.

Create a new user

Create a new user.

Usage:

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

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment	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 messageq user delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment	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 messageq 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 messageq user update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	ID of the deployment	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 MessageQ versions

List your MessageQ versions.

List available MessageQ versions

List available MessageQ versions.

Usage:

Code
scw messageq version list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for versions in the response	One of: version_asc, version_desc
version	Engine version to filter for, only versions with this version will be returned
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all