sahara

dataprocessing cluster create

Creates cluster

openstack dataprocessing cluster create
    [--name <name>]
    [--cluster-template <cluster-template>]
    [--image <image>]
    [--description <description>]
    [--user-keypair <keypair>]
    [--neutron-network <network>]
    [--count <count>]
    [--public]
    [--protected]
    [--transient]
    [--json <filename>]
    [--wait]
--name <name>

Name of the cluster [REQUIRED if JSON is not provided]

--cluster-template <cluster-template>

Cluster template name or ID [REQUIRED if JSON is not provided]

--image <image>

Image that will be used for cluster deployment (Name or ID) [REQUIRED if JSON is not provided]

--description <description>

Description of the cluster

--user-keypair <keypair>

User keypair to get acces to VMs after cluster creation

--neutron-network <network>

Instances of the cluster will get fixed IP addresses in this network. (Name or ID should be provided)

--count <count>

Number of clusters to be created

--public

Make the cluster public (Visible from other projects)

--protected

Make the cluster protected

--transient

Create transient cluster

--json <filename>

JSON representation of the cluster. Other arguments (except for –wait) will not be taken into account if this one is provided

--wait

Wait for the cluster creation to complete

This command is provided by the python-saharaclient plugin.

dataprocessing cluster delete

Deletes cluster

openstack dataprocessing cluster delete
    [--wait]
    <cluster>
    [<cluster> ...]
--wait

Wait for the cluster(s) delete to complete

cluster

Name(s) or id(s) of the cluster(s) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing cluster list

Lists clusters

openstack dataprocessing cluster list
    [--sort-column SORT_COLUMN]
    [--long]
    [--plugin <plugin>]
    [--plugin-version <plugin_version>]
    [--name <name-substring>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--plugin <plugin>

List clusters with specific plugin

--plugin-version <plugin_version>

List clusters with specific version of the plugin

--name <name-substring>

List clusters with specific substring in the name

This command is provided by the python-saharaclient plugin.

dataprocessing cluster scale

Scales cluster

openstack dataprocessing cluster scale
    [--instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]]
    [--json <filename>]
    [--wait]
    <cluster>
--instances <node-group-template:instances_count>

Node group templates and number of their instances to be scale to [REQUIRED if JSON is not provided]

--json <filename>

JSON representation of the cluster scale object. Other arguments (except for –wait) will not be taken into account if this one is provided

--wait

Wait for the cluster scale to complete

cluster

Name or ID of the cluster

This command is provided by the python-saharaclient plugin.

dataprocessing cluster show

Display cluster details

openstack dataprocessing cluster show
    [--verification]
    [--show-progress]
    [--full-dump-events]
    <cluster>
--verification

List additional fields for verifications

--show-progress

Provides ability to show brief details of event logs.

--full-dump-events

Provides ability to make full dump with event log details.

cluster

Name or id of the cluster to display

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template create

Creates cluster template

openstack dataprocessing cluster template create
    [--name <name>]
    [--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
    [--anti-affinity <anti-affinity> [<anti-affinity> ...]]
    [--description <description>]
    [--autoconfig]
    [--public]
    [--protected]
    [--json <filename>]
    [--shares <filename>]
    [--configs <filename>]
    [--domain-name <domain-name>]
--name <name>

Name of the cluster template [REQUIRED if JSON is not provided]

--node-groups <node-group:instances_count>

List of the node groups(names or IDs) and numbers of instances for each one of them [REQUIRED if JSON is not provided]

--anti-affinity <anti-affinity>

List of processes that should be added to an anti-affinity group

--description <description>

Description of the cluster template

--autoconfig

If enabled, instances of the cluster will be automatically configured

--public

Make the cluster template public (Visible from other projects)

--protected

Make the cluster template protected

--json <filename>

JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided

--shares <filename>

JSON representation of the manila shares

--configs <filename>

JSON representation of the cluster template configs

--domain-name <domain-name>

Domain name for instances of this cluster template. This option is available if ‘use_designate’ config is True

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template delete

Deletes cluster template

openstack dataprocessing cluster template delete
    <cluster-template>
    [<cluster-template> ...]
cluster-template

Name(s) or id(s) of the cluster template(s) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template export

Export cluster template to JSON

openstack dataprocessing cluster template export
    [--file <filename>]
    <cluster-template>
--file <filename>

Name of the file cluster template should be exported to If not provided, print to stdout

cluster-template

Name or id of the cluster template to export

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template import

Imports cluster template

openstack dataprocessing cluster template import
    [--name <name>]
    [--default-image-id <default_image_id>]
    --node-groups <node-group
    :instances_count>
    [<node-group:instances_count> ...]
    <json>
--name <name>

Name of the cluster template

--default-image-id <default_image_id>

Default image ID to be used

--node-groups <node-group:instances_count>

List of the node groups(names or IDs) and numbers of instances for each one of them

json

JSON containing cluster template

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template list

Lists cluster templates

openstack dataprocessing cluster template list
    [--sort-column SORT_COLUMN]
    [--long]
    [--plugin <plugin>]
    [--plugin-version <plugin_version>]
    [--name <name-substring>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--plugin <plugin>

List cluster templates for specific plugin

--plugin-version <plugin_version>

List cluster templates with specific version of the plugin

--name <name-substring>

List cluster templates with specific substring in the name

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template show

Display cluster template details

openstack dataprocessing cluster template show <cluster-template>
cluster-template

Name or id of the cluster template to display

This command is provided by the python-saharaclient plugin.

dataprocessing cluster template update

Updates cluster template

openstack dataprocessing cluster template update
    [--name <name>]
    [--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
    [--anti-affinity <anti-affinity> [<anti-affinity> ...]]
    [--description <description>]
    [--autoconfig-enable | --autoconfig-disable]
    [--public | --private]
    [--protected | --unprotected]
    [--json <filename>]
    [--shares <filename>]
    [--configs <filename>]
    [--domain-name <domain-name>]
    <cluster-template>
--name <name>

New name of the cluster template

--node-groups <node-group:instances_count>

List of the node groups(names or IDs) and numbers ofinstances for each one of them

--anti-affinity <anti-affinity>

List of processes that should be added to an anti-affinity group

--description <description>

Description of the cluster template

--autoconfig-enable

Instances of the cluster will be automatically configured

--autoconfig-disable

Instances of the cluster will not be automatically configured

--public

Make the cluster template public (Visible from other projects)

--private

Make the cluster template private (Visible only from this tenant)

--protected

Make the cluster template protected

--unprotected

Make the cluster template unprotected

--json <filename>

JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided

--shares <filename>

JSON representation of the manila shares

--configs <filename>

JSON representation of the cluster template configs

--domain-name <domain-name>

Domain name for instances of this cluster template. This option is available if ‘use_designate’ config is True

cluster-template

Name or ID of the cluster template [REQUIRED]

This command is provided by the python-saharaclient plugin.

dataprocessing cluster update

Updates cluster

openstack dataprocessing cluster update
    [--name <name>]
    [--description <description>]
    [--shares <filename>]
    [--public | --private]
    [--protected | --unprotected]
    <cluster>
--name <name>

New name of the cluster

--description <description>

Description of the cluster

--shares <filename>

JSON representation of the manila shares

--public

Make the cluster public (Visible from other projects)

--private

Make the cluster private (Visible only from this tenant)

--protected

Make the cluster protected

--unprotected

Make the cluster unprotected

cluster

Name or ID of the cluster

This command is provided by the python-saharaclient plugin.

dataprocessing cluster verification

Updates cluster verifications

openstack dataprocessing cluster verification
    (--start | --show)
    <cluster>
--start

Start health verification for the cluster

--show

Show health of the cluster

cluster

Name or ID of the cluster

This command is provided by the python-saharaclient plugin.

dataprocessing data source create

Creates data source

openstack dataprocessing data source create
    --type <type>
    --url <url>
    [--username <username> | --access-key <accesskey>]
    [--password <password> | --secret-key <secretkey>]
    [--s3-endpoint <endpoint>]
    [--enable-s3-ssl | --disable-s3-ssl]
    [--enable-s3-bucket-in-path | --disable-s3-bucket-in-path]
    [--description <description>]
    [--public]
    [--protected]
    <name>
--type <type>

Type of the data source (swift, hdfs, maprfs, manila, s3) [REQUIRED]

--url <url>

URL for the data source [REQUIRED]

--username <username>

Username for accessing the data source URL

--access-key <accesskey>

S3 access key for accessing the data source URL

--password <password>

Password for accessing the data source URL

--secret-key <secretkey>

S3 secret key for accessing the data source URL

--s3-endpoint <endpoint>

S3 endpoint for accessing the data source URL (ignored if data source not in S3)

--enable-s3-ssl

Enable access to S3 endpoint using SSL (ignored if data source not in S3)

--disable-s3-ssl

Disable access to S3 endpoint using SSL (ignored if data source not in S3)

--enable-s3-bucket-in-path

Access S3 endpoint using bucket name in path (ignored if data source not in S3)

--disable-s3-bucket-in-path

Access S3 endpoint using bucket name in path (ignored if data source not in S3)

--description <description>

Description of the data source

--public

Make the data source public

--protected

Make the data source protected

name

Name of the data source

This command is provided by the python-saharaclient plugin.

dataprocessing data source delete

Delete data source

openstack dataprocessing data source delete
    <data-source>
    [<data-source> ...]
data-source

Name(s) or id(s) of the data source(s) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing data source list

Lists data sources

openstack dataprocessing data source list
    [--sort-column SORT_COLUMN]
    [--long]
    [--type <type>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--type <type>

List data sources of specific type (swift, hdfs, maprfs, manila, s3)

This command is provided by the python-saharaclient plugin.

dataprocessing data source show

Display data source details

openstack dataprocessing data source show <data-source>
data-source

Name or id of the data source to display

This command is provided by the python-saharaclient plugin.

dataprocessing data source update

Update data source

openstack dataprocessing data source update
    [--name <name>]
    [--type <type>]
    [--url <url>]
    [--username <username> | --access-key <accesskey>]
    [--password <password> | --secret-key <secretkey>]
    [--s3-endpoint <endpoint>]
    [--enable-s3-ssl | --disable-s3-ssl]
    [--enable-s3-bucket-in-path | --disable-s3-bucket-in-path]
    [--description <description>]
    [--public | --private]
    [--protected | --unprotected]
    <data-source>
--name <name>

New name of the data source

--type <type>

Type of the data source (swift, hdfs, maprfs, manila, s3)

--url <url>

URL for the data source

--username <username>

Username for accessing the data source URL

--access-key <accesskey>

S3 access key for accessing the data source URL

--password <password>

Password for accessing the data source URL

--secret-key <secretkey>

S3 secret key for accessing the data source URL

--s3-endpoint <endpoint>

S3 endpoint for accessing the data source URL (ignored if data source not in S3)

--enable-s3-ssl

Enable access to S3 endpoint using SSL (ignored if data source not in S3)

--disable-s3-ssl

Disable access to S3 endpoint using SSL (ignored if data source not in S3)

--enable-s3-bucket-in-path

Access S3 endpoint using bucket name in path (ignored if data source not in S3)

--disable-s3-bucket-in-path

Access S3 endpoint using bucket name in path (ignored if data source not in S3)

--description <description>

Description of the data source

--public

Make the data source public (Visible from other projects)

--private

Make the data source private (Visible only from this tenant)

--protected

Make the data source protected

--unprotected

Make the data source unprotected

data-source

Name or id of the data source

This command is provided by the python-saharaclient plugin.

dataprocessing image list

Lists registered images

openstack dataprocessing image list
    [--sort-column SORT_COLUMN]
    [--long]
    [--name <name-regex>]
    [--tags <tag> [<tag> ...]]
    [--username <username>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--name <name-regex>

Regular expression to match image name

--tags <tag>

List images with specific tag(s)

--username <username>

List images with specific username

This command is provided by the python-saharaclient plugin.

dataprocessing image register

Register an image

openstack dataprocessing image register
    --username <username>
    [--description <description>]
    <image>
--username <username>

Username of privileged user in the image [REQUIRED]

--description <description>

Description of the image. If not provided, description of the image will be reset to empty

image

Name or ID of the image to register

This command is provided by the python-saharaclient plugin.

dataprocessing image show

Display image details

openstack dataprocessing image show <image>
image

Name or id of the image to display

This command is provided by the python-saharaclient plugin.

dataprocessing image tags add

Add image tags

openstack dataprocessing image tags add
    --tags <tag>
    [<tag> ...]
    <image>
--tags <tag>

Tag(s) to add [REQUIRED]

image

Name or id of the image

This command is provided by the python-saharaclient plugin.

dataprocessing image tags remove

Remove image tags

openstack dataprocessing image tags remove
    [--tags <tag> [<tag> ...]
    |
    --all
    ]
    <image>
--tags <tag>

Tag(s) to remove

--all

Remove all tags from image

image

Name or id of the image

This command is provided by the python-saharaclient plugin.

dataprocessing image tags set

Set image tags (Replace current image tags with provided ones)

openstack dataprocessing image tags set
    --tags <tag>
    [<tag> ...]
    <image>
--tags <tag>

Tag(s) to set [REQUIRED]

image

Name or id of the image

This command is provided by the python-saharaclient plugin.

dataprocessing image unregister

Unregister image(s)

openstack dataprocessing image unregister <image> [<image> ...]
image

Name(s) or id(s) of the image(s) to unregister

This command is provided by the python-saharaclient plugin.

dataprocessing job binary create

Creates job binary

openstack dataprocessing job binary create
    [--name <name>]
    [--data <file> | --url <url>]
    [--description <description>]
    [--username <username> | --access-key <accesskey>]
    [--password <password> | --secret-key <secretkey> | --password-prompt | --secret-key-prompt]
    [--s3-endpoint <endpoint>]
    [--public]
    [--protected]
    [--json <filename>]
--name <name>

Name of the job binary [REQUIRED if JSON is not provided]

--data <file>

File that will be stored in the internal DB [REQUIRED if JSON and URL are not provided]

--url <url>

URL for the job binary [REQUIRED if JSON and file are not provided]

--description <description>

Description of the job binary

--username <username>

Username for accessing the job binary URL

--access-key <accesskey>

S3 access key for accessing the job binary URL

--password <password>

Password for accessing the job binary URL

--secret-key <secretkey>

S3 secret key for accessing the job binary URL

--password-prompt

Prompt interactively for password

--secret-key-prompt

Prompt interactively for S3 secret key

--s3-endpoint <endpoint>

S3 endpoint for accessing the job binary URL (ignored if binary not in S3

--public

Make the job binary public

--protected

Make the job binary protected

--json <filename>

JSON representation of the job binary. Other arguments will not be taken into account if this one is provided

This command is provided by the python-saharaclient plugin.

dataprocessing job binary delete

Deletes job binary

openstack dataprocessing job binary delete
    <job-binary>
    [<job-binary> ...]
job-binary

Name(s) or id(s) of the job binary(ies) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing job binary download

Downloads job binary

openstack dataprocessing job binary download
    [--file <file>]
    <job-binary>
--file <file>

Destination file (defaults to job binary name)

job-binary

Name or ID of the job binary to download

This command is provided by the python-saharaclient plugin.

dataprocessing job binary list

Lists job binaries

openstack dataprocessing job binary list
    [--sort-column SORT_COLUMN]
    [--long]
    [--name <name-substring>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--name <name-substring>

List job binaries with specific substring in the name

This command is provided by the python-saharaclient plugin.

dataprocessing job binary show

Display job binary details

openstack dataprocessing job binary show <job-binary>
job-binary

Name or ID of the job binary to display

This command is provided by the python-saharaclient plugin.

dataprocessing job binary update

Updates job binary

openstack dataprocessing job binary update
    [--name <name>]
    [--url <url>]
    [--description <description>]
    [--username <username> | --access-key <accesskey>]
    [--password <password> | --secret-key <secretkey> | --password-prompt | --secret-key-prompt]
    [--s3-endpoint <endpoint>]
    [--public | --private]
    [--protected | --unprotected]
    [--json <filename>]
    <job-binary>
--name <name>

New name of the job binary

--url <url>

URL for the job binary [Internal DB URL can not be updated]

--description <description>

Description of the job binary

--username <username>

Username for accessing the job binary URL

--access-key <accesskey>

S3 access key for accessing the job binary URL

--password <password>

Password for accessing the job binary URL

--secret-key <secretkey>

S3 secret key for accessing the job binary URL

--password-prompt

Prompt interactively for password

--secret-key-prompt

Prompt interactively for S3 secret key

--s3-endpoint <endpoint>

S3 endpoint for accessing the job binary URL (ignored if binary not in S3

--public

Make the job binary public (Visible from other projects)

--private

Make the job binary private (Visible only from this project)

--protected

Make the job binary protected

--unprotected

Make the job binary unprotected

--json <filename>

JSON representation of the update object. Other arguments will not be taken into account if this one is provided

job-binary

Name or ID of the job binary

This command is provided by the python-saharaclient plugin.

dataprocessing job delete

Deletes job

openstack dataprocessing job delete [--wait] <job> [<job> ...]
--wait

Wait for the job(s) delete to complete

job

ID(s) of the job(s) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing job execute

Executes job

openstack dataprocessing job execute
    [--job-template <job-template>]
    [--cluster <cluster>]
    [--input <input>]
    [--output <output>]
    [--params <name:value> [<name:value> ...]]
    [--args <argument> [<argument> ...]]
    [--public]
    [--protected]
    [--config-json <filename> | --configs <name:value> [<name:value> ...]]
    [--interface <filename>]
    [--json <filename>]
--job-template <job-template>

Name or ID of the job template [REQUIRED if JSON is not provided]

--cluster <cluster>

Name or ID of the cluster [REQUIRED if JSON is not provided]

--input <input>

Name or ID of the input data source

--output <output>

Name or ID of the output data source

--params <name:value>

Parameters to add to the job

--args <argument>

Arguments to add to the job

--public

Make the job public

--protected

Make the job protected

--config-json <filename>

JSON representation of the job configs

--configs <name:value>

Configs to add to the job

--interface <filename>

JSON representation of the interface

--json <filename>

JSON representation of the job. Other arguments will not be taken into account if this one is provided

This command is provided by the python-saharaclient plugin.

dataprocessing job list

Lists jobs

openstack dataprocessing job list
    [--sort-column SORT_COLUMN]
    [--long]
    [--status <status>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--status <status>

List jobs with specific status

This command is provided by the python-saharaclient plugin.

dataprocessing job show

Display job details

openstack dataprocessing job show <job>
job

ID of the job to display

This command is provided by the python-saharaclient plugin.

dataprocessing job template create

Creates job template

openstack dataprocessing job template create
    [--name <name>]
    [--type <type>]
    [--mains <main> [<main> ...]]
    [--libs <lib> [<lib> ...]]
    [--description <description>]
    [--public]
    [--protected]
    [--interface <filename>]
    [--json <filename>]
--name <name>

Name of the job template [REQUIRED if JSON is not provided]

--type <type>

Type of the job (Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark) [REQUIRED if JSON is not provided]

--mains <main>

Name(s) or ID(s) for job’s main job binary(s)

--libs <lib>

Name(s) or ID(s) for job’s lib job binary(s)

--description <description>

Description of the job template

--public

Make the job template public

--protected

Make the job template protected

--interface <filename>

JSON representation of the interface

--json <filename>

JSON representation of the job template

This command is provided by the python-saharaclient plugin.

dataprocessing job template delete

Deletes job template

openstack dataprocessing job template delete
    <job-template>
    [<job-template> ...]
job-template

Name(s) or id(s) of the job template(s) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing job template list

Lists job templates

openstack dataprocessing job template list
    [--sort-column SORT_COLUMN]
    [--long]
    [--type <type>]
    [--name <name-substring>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--type <type>

List job templates of specific type

--name <name-substring>

List job templates with specific substring in the name

This command is provided by the python-saharaclient plugin.

dataprocessing job template show

Display job template details

openstack dataprocessing job template show <job-template>
job-template

Name or ID of the job template to display

This command is provided by the python-saharaclient plugin.

dataprocessing job template update

Updates job template

openstack dataprocessing job template update
    [--name <name>]
    [--description <description>]
    [--public | --private]
    [--protected | --unprotected]
    <job-template>
--name <name>

New name of the job template

--description <description>

Description of the job template

--public

Make the job template public (Visible from other projects)

--private

Make the job_template private (Visible only from this tenant)

--protected

Make the job template protected

--unprotected

Make the job template unprotected

job-template

Name or ID of the job template

This command is provided by the python-saharaclient plugin.

dataprocessing job type configs get

Get job type configs

openstack dataprocessing job type configs get
    [--file <file>]
    <job-type>
--file <file>

Destination file (defaults to job type)

job-type

Type of the job to provide config information about

This command is provided by the python-saharaclient plugin.

dataprocessing job type list

Lists job types supported by plugins

openstack dataprocessing job type list
    [--sort-column SORT_COLUMN]
    [--type <type>]
    [--plugin <plugin>]
    [--plugin-version <plugin_version>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--type <type>

Get information about specific job type

--plugin <plugin>

Get only job types supported by this plugin

--plugin-version <plugin_version>

Get only job types supported by specific version of the plugin. This parameter will be taken into account only if plugin is provided

This command is provided by the python-saharaclient plugin.

dataprocessing job update

Updates job

openstack dataprocessing job update
    [--public | --private]
    [--protected | --unprotected]
    <job>
--public

Make the job public (Visible from other projects)

--private

Make the job private (Visible only from this project)

--protected

Make the job protected

--unprotected

Make the job unprotected

job

ID of the job to update

This command is provided by the python-saharaclient plugin.

dataprocessing node group template create

Creates node group template

openstack dataprocessing node group template create
    [--name <name>]
    [--plugin <plugin>]
    [--plugin-version <plugin_version>]
    [--processes <processes> [<processes> ...]]
    [--flavor <flavor>]
    [--security-groups <security-groups> [<security-groups> ...]]
    [--auto-security-group]
    [--availability-zone <availability-zone>]
    [--floating-ip-pool <floating-ip-pool>]
    [--volumes-per-node <volumes-per-node>]
    [--volumes-size <volumes-size>]
    [--volumes-type <volumes-type>]
    [--volumes-availability-zone <volumes-availability-zone>]
    [--volumes-mount-prefix <volumes-mount-prefix>]
    [--volumes-locality]
    [--description <description>]
    [--autoconfig]
    [--proxy-gateway]
    [--public]
    [--protected]
    [--json <filename>]
    [--shares <filename>]
    [--configs <filename>]
--name <name>

Name of the node group template [REQUIRED if JSON is not provided]

--plugin <plugin>

Name of the plugin [REQUIRED if JSON is not provided]

--plugin-version <plugin_version>

Version of the plugin [REQUIRED if JSON is not provided]

--processes <processes>

List of the processes that will be launched on each instance [REQUIRED if JSON is not provided]

--flavor <flavor>

Name or ID of the flavor [REQUIRED if JSON is not provided]

--security-groups <security-groups>

List of the security groups for the instances in this node group

--auto-security-group

Indicates if an additional security group should be created for the node group

--availability-zone <availability-zone>

Name of the availability zone where instances will be created

--floating-ip-pool <floating-ip-pool>

ID of the floating IP pool

--volumes-per-node <volumes-per-node>

Number of volumes attached to every node

--volumes-size <volumes-size>

Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-type <volumes-type>

Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-availability-zone <volumes-availability-zone>

Name of the availability zone where volumes will be created. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-mount-prefix <volumes-mount-prefix>

Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-locality

If enabled, instance and attached volumes will be created on the same physical host. This parameter will be taken into account only if volumes-per-node is set and non-zero

--description <description>

Description of the node group template

--autoconfig

If enabled, instances of the node group will be automatically configured

--proxy-gateway

If enabled, instances of the node group will be used to access other instances in the cluster

--public

Make the node group template public (Visible from other projects)

--protected

Make the node group template protected

--json <filename>

JSON representation of the node group template. Other arguments will not be taken into account if this one is provided

--shares <filename>

JSON representation of the manila shares

--configs <filename>

JSON representation of the node group template configs

This command is provided by the python-saharaclient plugin.

dataprocessing node group template delete

Deletes node group template

openstack dataprocessing node group template delete
    <node-group-template>
    [<node-group-template> ...]
node-group-template

Name(s) or id(s) of the node group template(s) to delete

This command is provided by the python-saharaclient plugin.

dataprocessing node group template export

Export node group template to JSON

openstack dataprocessing node group template export
    [--file <filename>]
    <node-group-template>
--file <filename>

Name of the file node group template should be exported to.If not provided, print to stdout

node-group-template

Name or id of the node group template to export

This command is provided by the python-saharaclient plugin.

dataprocessing node group template import

Imports node group template

openstack dataprocessing node group template import
    [--name <name>]
    [--security_groups <security_groups>]
    [--floating_ip_pool <floating_ip_pool>]
    --image_id <image_id>
    --flavor_id <flavor_id>
    <json>
--name <name>

Name of the node group template

--security_groups <security_groups>

Security groups of the node group template

--floating_ip_pool <floating_ip_pool>

Floating IP pool of the node group template

--image_id <image_id>

Image ID of the node group template

--flavor_id <flavor_id>

Flavor ID of the node group template

json

JSON containing node group template

This command is provided by the python-saharaclient plugin.

dataprocessing node group template list

Lists node group templates

openstack dataprocessing node group template list
    [--sort-column SORT_COLUMN]
    [--long]
    [--plugin <plugin>]
    [--plugin-version <plugin_version>]
    [--name <name-substring>]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

--plugin <plugin>

List node group templates for specific plugin

--plugin-version <plugin_version>

List node group templates with specific version of the plugin

--name <name-substring>

List node group templates with specific substring in the name

This command is provided by the python-saharaclient plugin.

dataprocessing node group template show

Display node group template details

openstack dataprocessing node group template show <node-group-template>
node-group-template

Name or id of the node group template to display

This command is provided by the python-saharaclient plugin.

dataprocessing node group template update

Updates node group template

openstack dataprocessing node group template update
    [--name <name>]
    [--plugin <plugin>]
    [--plugin-version <plugin_version>]
    [--processes <processes> [<processes> ...]]
    [--security-groups <security-groups> [<security-groups> ...]]
    [--auto-security-group-enable | --auto-security-group-disable]
    [--availability-zone <availability-zone>]
    [--flavor <flavor>]
    [--floating-ip-pool <floating-ip-pool>]
    [--volumes-per-node <volumes-per-node>]
    [--volumes-size <volumes-size>]
    [--volumes-type <volumes-type>]
    [--volumes-availability-zone <volumes-availability-zone>]
    [--volumes-mount-prefix <volumes-mount-prefix>]
    [--volumes-locality-enable | --volumes-locality-disable]
    [--description <description>]
    [--autoconfig-enable | --autoconfig-disable]
    [--proxy-gateway-enable | --proxy-gateway-disable]
    [--public | --private]
    [--protected | --unprotected]
    [--json <filename>]
    [--shares <filename>]
    [--configs <filename>]
    <node-group-template>
--name <name>

New name of the node group template

--plugin <plugin>

Name of the plugin

--plugin-version <plugin_version>

Version of the plugin

--processes <processes>

List of the processes that will be launched on each instance

--security-groups <security-groups>

List of the security groups for the instances in this node group

--auto-security-group-enable

Additional security group should be created for the node group

--auto-security-group-disable

Additional security group should not be created for the node group

--availability-zone <availability-zone>

Name of the availability zone where instances will be created

--flavor <flavor>

Name or ID of the flavor

--floating-ip-pool <floating-ip-pool>

ID of the floating IP pool

--volumes-per-node <volumes-per-node>

Number of volumes attached to every node

--volumes-size <volumes-size>

Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-type <volumes-type>

Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-availability-zone <volumes-availability-zone>

Name of the availability zone where volumes will be created. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-mount-prefix <volumes-mount-prefix>

Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-locality-enable

Instance and attached volumes will be created on the same physical host. This parameter will be taken into account only if volumes-per-node is set and non-zero

--volumes-locality-disable

Instance and attached volumes creation on the same physical host will not be regulated. This parameter will be takeninto account only if volumes-per-node is set and non-zero

--description <description>

Description of the node group template

--autoconfig-enable

Instances of the node group will be automatically configured

--autoconfig-disable

Instances of the node group will not be automatically configured

--proxy-gateway-enable

Instances of the node group will be used to access other instances in the cluster

--proxy-gateway-disable

Instances of the node group will not be used to access other instances in the cluster

--public

Make the node group template public (Visible from other projects)

--private

Make the node group template private (Visible only from this project)

--protected

Make the node group template protected

--unprotected

Make the node group template unprotected

--json <filename>

JSON representation of the node group template update fields. Other arguments will not be taken into account if this one is provided

--shares <filename>

JSON representation of the manila shares

--configs <filename>

JSON representation of the node group template configs

node-group-template

Name or ID of the node group template

This command is provided by the python-saharaclient plugin.

dataprocessing plugin configs get

Get plugin configs

openstack dataprocessing plugin configs get
    [--file <file>]
    <plugin>
    <plugin_version>
--file <file>

Destination file (defaults to a combination of plugin name and plugin version)

plugin

Name of the plugin to provide config information about

plugin_version

Version of the plugin to provide config information about

This command is provided by the python-saharaclient plugin.

dataprocessing plugin list

Lists plugins

openstack dataprocessing plugin list
    [--sort-column SORT_COLUMN]
    [--long]
--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--long

List additional fields in output

This command is provided by the python-saharaclient plugin.

dataprocessing plugin show

Display plugin details

openstack dataprocessing plugin show
    [--plugin-version <plugin_version>]
    <plugin>
--plugin-version <plugin_version>

Version of the plugin to display

plugin

Name of the plugin to display

This command is provided by the python-saharaclient plugin.

dataprocessing plugin update

Command base class for displaying data about a single object.

openstack dataprocessing plugin update <plugin> <json>
plugin

Name of the plugin to provide config information about

json

JSON representation of the plugin update dictionary

This command is provided by the python-saharaclient plugin.