Chapter 26. dataprocessing


This chapter describes the commands under the dataprocessing command.

26.1. dataprocessing cluster create

Usage:

openstack dataprocessing cluster create [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [--name <name>]
                                             [--cluster-template <cluster-template>]
                                             [--image <image>]
                                             [--description <description>]
                                             [--user-keypair <keypair>]
                                             [--neutron-network <network>]
                                             [--count <count>] [--public]
                                             [--protected] [--transient]
                                             [--json <filename>] [--wait]
Copy to Clipboard Toggle word wrap

Creates cluster

Expand
Table 26.1. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.2. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.3. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.5. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.2. dataprocessing cluster delete

Usage:

openstack dataprocessing cluster delete [-h] [--wait]

                                             <cluster> [<cluster> ...]
Copy to Clipboard Toggle word wrap

Deletes cluster

Expand
Table 26.6. Positional Arguments
ValueSummary

<cluster>

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

Expand
Table 26.7. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for the cluster(s) delete to complete

This command is provided by the python-saharaclient plugin.

26.3. dataprocessing cluster list

Usage:

openstack dataprocessing cluster list [-h]

                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--long] [--plugin <plugin>]
                                           [--plugin-version <plugin_version>]
                                           [--name <name-substring>]
Copy to Clipboard Toggle word wrap

Lists clusters

Expand
Table 26.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.9. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.10. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.11. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.12. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.4. dataprocessing cluster scale

Usage:

openstack dataprocessing cluster scale [-h]

                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            [--instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]]
                                            [--json <filename>] [--wait]
                                            <cluster>
Copy to Clipboard Toggle word wrap

Scales cluster

Expand
Table 26.13. Positional Arguments
ValueSummary

<cluster>

Name or id of the cluster

Expand
Table 26.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--instances <node-group-template:instances_count> [<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

Expand
Table 26.15. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.16. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.17. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.18. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.5. dataprocessing cluster show

Usage:

openstack dataprocessing cluster show [-h]

                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN]
                                           [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--verification]
                                           [--show-progress]
                                           [--full-dump-events]
                                           <cluster>
Copy to Clipboard Toggle word wrap

Display cluster details

Expand
Table 26.19. Positional Arguments
ValueSummary

<cluster>

Name or id of the cluster to display

Expand
Table 26.20. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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.

Expand
Table 26.21. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.22. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.23. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.24. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.6. dataprocessing cluster template create

Usage:

openstack dataprocessing cluster template create [-h]

                                                      [-f {json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      [--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>]
Copy to Clipboard Toggle word wrap

Creates cluster template

Expand
Table 26.25. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the cluster template [required if json is not provided]

--node-groups <node-group:instances_count> [<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> [<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

Expand
Table 26.26. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.27. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.28. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.29. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.7. dataprocessing cluster template delete

Usage:

openstack dataprocessing cluster template delete [-h]

                                                      <cluster-template>
                                                      [<cluster-template> ...]
Copy to Clipboard Toggle word wrap

Deletes cluster template

Expand
Table 26.30. Positional Arguments
ValueSummary

<cluster-template>

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

Expand
Table 26.31. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-saharaclient plugin.

26.8. dataprocessing cluster template export

Usage:

openstack dataprocessing cluster template export [-h]

                                                      [--file <filename>]
                                                      <cluster-template>
Copy to Clipboard Toggle word wrap

Export cluster template to JSON

Expand
Table 26.32. Positional Arguments
ValueSummary

<cluster-template>

Name or id of the cluster template to export

Expand
Table 26.33. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

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

This command is provided by the python-saharaclient plugin.

26.9. dataprocessing cluster template import

Usage:

openstack dataprocessing cluster template import [-h]

                                                      [-f {json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      [--name <name>]
                                                      [--default-image-id <default_image_id>]
                                                      --node-groups
                                                      <node-group:instances_count>
                                                      [<node-group:instances_count> ...]
                                                      <json>
Copy to Clipboard Toggle word wrap

Imports cluster template

Expand
Table 26.34. Positional Arguments
ValueSummary

<json>

Json containing cluster template

Expand
Table 26.35. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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> [<node-group:instances_count> …​]

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

Expand
Table 26.36. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.37. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.38. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.39. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.10. dataprocessing cluster template list

Usage:

openstack dataprocessing cluster template list [-h]

                                                    [-f {csv,json,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--noindent]
                                                    [--quote {all,minimal,none,nonnumeric}]
                                                    [--sort-column SORT_COLUMN]
                                                    [--long]
                                                    [--plugin <plugin>]
                                                    [--plugin-version <plugin_version>]
                                                    [--name <name-substring>]
Copy to Clipboard Toggle word wrap

Lists cluster templates

Expand
Table 26.40. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.41. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.42. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.43. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.44. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.11. dataprocessing cluster template show

Usage:

openstack dataprocessing cluster template show [-h]

                                                    [-f {json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--fit-width]
                                                    [--print-empty]
                                                    [--noindent]
                                                    [--prefix PREFIX]
                                                    <cluster-template>
Copy to Clipboard Toggle word wrap

Display cluster template details

Expand
Table 26.45. Positional Arguments
ValueSummary

<cluster-template>

Name or id of the cluster template to display

Expand
Table 26.46. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.47. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.48. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.49. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.50. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.12. dataprocessing cluster template update

Usage:

openstack dataprocessing cluster template update [-h]

                                                      [-f {json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--fit-width]
                                                      [--print-empty]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      [--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>
Copy to Clipboard Toggle word wrap

Updates cluster template

Expand
Table 26.51. Positional Arguments
ValueSummary

<cluster-template>

Name or id of the cluster template [required]

Expand
Table 26.52. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

New name of the cluster template

--node-groups <node-group:instances_count> [<node-group:instances_count> …​]

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

--anti-affinity <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

Expand
Table 26.53. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.54. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.55. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.56. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.13. dataprocessing cluster update

Usage:

openstack dataprocessing cluster update [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             [--name <name>]
                                             [--description <description>]
                                             [--shares <filename>]
                                             [--public | --private]
                                             [--protected | --unprotected]
                                             <cluster>
Copy to Clipboard Toggle word wrap

Updates cluster

Expand
Table 26.57. Positional Arguments
ValueSummary

<cluster>

Name or id of the cluster

Expand
Table 26.58. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.59. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.60. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.61. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.62. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.14. dataprocessing cluster verification

Usage:

openstack dataprocessing cluster verification [-h]

                                                   [-f {json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--fit-width]
                                                   [--print-empty]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   (--start | --show)
                                                   <cluster>
Copy to Clipboard Toggle word wrap

Updates cluster verifications

Expand
Table 26.63. Positional Arguments
ValueSummary

<cluster>

Name or id of the cluster

Expand
Table 26.64. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--start

Start health verification for the cluster

--show

Show health of the cluster

Expand
Table 26.65. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.66. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.67. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.68. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.15. dataprocessing data source create

Usage:

openstack dataprocessing data source create [-h]

                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width]
                                                 [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX] --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>
Copy to Clipboard Toggle word wrap

Creates data source

Expand
Table 26.69. Positional Arguments
ValueSummary

<name>

Name of the data source

Expand
Table 26.70. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.71. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.72. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.73. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.74. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.16. dataprocessing data source delete

Usage:

openstack dataprocessing data source delete [-h]

                                                 <data-source>
                                                 [<data-source> ...]
Copy to Clipboard Toggle word wrap

Delete data source

Expand
Table 26.75. Positional Arguments
ValueSummary

<data-source>

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

Expand
Table 26.76. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-saharaclient plugin.

26.17. dataprocessing data source list

Usage:

openstack dataprocessing data source list [-h]

                                               [-f {csv,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--sort-column SORT_COLUMN]
                                               [--long] [--type <type>]
Copy to Clipboard Toggle word wrap

Lists data sources

Expand
Table 26.77. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--type <type>

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

Expand
Table 26.78. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.79. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.80. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.81. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.18. dataprocessing data source show

Usage:

openstack dataprocessing data source show [-h]

                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent]
                                               [--prefix PREFIX]
                                               <data-source>
Copy to Clipboard Toggle word wrap

Display data source details

Expand
Table 26.82. Positional Arguments
ValueSummary

<data-source>

Name or id of the data source to display

Expand
Table 26.83. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.84. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.85. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.86. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.87. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.19. dataprocessing data source update

Usage:

openstack dataprocessing data source update [-h]

                                                 [-f {json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width]
                                                 [--print-empty]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 [--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>
Copy to Clipboard Toggle word wrap

Update data source

Expand
Table 26.88. Positional Arguments
ValueSummary

<data-source>

Name or id of the data source

Expand
Table 26.89. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.90. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.91. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.92. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.93. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.20. dataprocessing image list

Usage:

openstack dataprocessing image list [-h]

                                         [-f {csv,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--sort-column SORT_COLUMN]
                                         [--long] [--name <name-regex>]
                                         [--tags <tag> [<tag> ...]]
                                         [--username <username>]
Copy to Clipboard Toggle word wrap

Lists registered images

Expand
Table 26.94. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--name <name-regex>

Regular expression to match image name

--tags <tag> [<tag> …​]

List images with specific tag(s)

--username <username>

List images with specific username

Expand
Table 26.95. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.96. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.97. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.98. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.21. dataprocessing image register

Usage:

openstack dataprocessing image register [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --username <username>
                                             [--description <description>]
                                             <image>
Copy to Clipboard Toggle word wrap

Register an image

Expand
Table 26.99. Positional Arguments
ValueSummary

<image>

Name or id of the image to register

Expand
Table 26.100. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.101. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.102. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.103. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.104. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.22. dataprocessing image show

Usage:

openstack dataprocessing image show [-h]

                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <image>
Copy to Clipboard Toggle word wrap

Display image details

Expand
Table 26.105. Positional Arguments
ValueSummary

<image>

Name or id of the image to display

Expand
Table 26.106. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.107. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.108. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.109. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.110. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.23. dataprocessing image tags add

Usage:

openstack dataprocessing image tags add [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --tags <tag> [<tag> ...]
                                             <image>
Copy to Clipboard Toggle word wrap

Add image tags

Expand
Table 26.111. Positional Arguments
ValueSummary

<image>

Name or id of the image

Expand
Table 26.112. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--tags <tag> [<tag> …​]

Tag(s) to add [REQUIRED]

Expand
Table 26.113. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.114. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.115. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.116. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.24. dataprocessing image tags remove

Usage:

openstack dataprocessing image tags remove [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--prefix PREFIX]
                                                [--tags <tag> [<tag> ...] |
                                                --all]
                                                <image>
Copy to Clipboard Toggle word wrap

Remove image tags

Expand
Table 26.117. Positional Arguments
ValueSummary

<image>

Name or id of the image

Expand
Table 26.118. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--tags <tag> [<tag> …​]

Tag(s) to remove

--all

Remove all tags from image

Expand
Table 26.119. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.120. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.121. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.122. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.25. dataprocessing image tags set

Usage:

openstack dataprocessing image tags set [-h]

                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --tags <tag> [<tag> ...]
                                             <image>
Copy to Clipboard Toggle word wrap

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

Expand
Table 26.123. Positional Arguments
ValueSummary

<image>

Name or id of the image

Expand
Table 26.124. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--tags <tag> [<tag> …​]

Tag(s) to set [REQUIRED]

Expand
Table 26.125. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.126. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.127. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.128. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.26. dataprocessing image unregister

Usage:

openstack dataprocessing image unregister [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap

Unregister image(s)

Expand
Table 26.129. Positional Arguments
ValueSummary

<image>

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

Expand
Table 26.130. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-saharaclient plugin.

26.27. dataprocessing job binary create

Usage:

openstack dataprocessing job binary create [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--prefix PREFIX]
                                                [--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>]
Copy to Clipboard Toggle word wrap

Creates job binary

Expand
Table 26.131. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.132. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.133. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.134. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.135. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.28. dataprocessing job binary delete

Usage:

openstack dataprocessing job binary delete [-h]

                                                <job-binary>
                                                [<job-binary> ...]
Copy to Clipboard Toggle word wrap

Deletes job binary

Expand
Table 26.136. Positional Arguments
ValueSummary

<job-binary>

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

Expand
Table 26.137. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-saharaclient plugin.

26.29. dataprocessing job binary download

Usage:

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

                                                  <job-binary>
Copy to Clipboard Toggle word wrap

Downloads job binary

Expand
Table 26.138. Positional Arguments
ValueSummary

<job-binary>

Name or id of the job binary to download

Expand
Table 26.139. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <file>

Destination file (defaults to job binary name)

This command is provided by the python-saharaclient plugin.

26.30. dataprocessing job binary list

Usage:

openstack dataprocessing job binary list [-h]

                                              [-f {csv,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--sort-column SORT_COLUMN]
                                              [--long]
                                              [--name <name-substring>]
Copy to Clipboard Toggle word wrap

Lists job binaries

Expand
Table 26.140. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--name <name-substring>

List job binaries with specific substring in the name

Expand
Table 26.141. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.142. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.143. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.144. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.31. dataprocessing job binary show

Usage:

openstack dataprocessing job binary show [-h]

                                              [-f {json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              <job-binary>
Copy to Clipboard Toggle word wrap

Display job binary details

Expand
Table 26.145. Positional Arguments
ValueSummary

<job-binary>

Name or id of the job binary to display

Expand
Table 26.146. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.147. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.148. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.149. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.150. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.32. dataprocessing job binary update

Usage:

openstack dataprocessing job binary update [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--prefix PREFIX]
                                                [--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>
Copy to Clipboard Toggle word wrap

Updates job binary

Expand
Table 26.151. Positional Arguments
ValueSummary

<job-binary>

Name or id of the job binary

Expand
Table 26.152. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.153. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.154. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.155. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.156. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.33. dataprocessing job delete

Usage:

openstack dataprocessing job delete [-h] [--wait] <job> [<job> ...]
Copy to Clipboard Toggle word wrap

Deletes job

Expand
Table 26.157. Positional Arguments
ValueSummary

<job>

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

Expand
Table 26.158. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--wait

Wait for the job(s) delete to complete

This command is provided by the python-saharaclient plugin.

26.34. dataprocessing job execute

Usage:

openstack dataprocessing job execute [-h]

                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--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>]
Copy to Clipboard Toggle word wrap

Executes job

Expand
Table 26.159. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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> [<name:value> …​]

Parameters to add to the job

--args <argument> [<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> [<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

Expand
Table 26.160. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.161. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.162. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.163. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.35. dataprocessing job list

Usage:

openstack dataprocessing job list [-h] [-f {csv,json,table,value,yaml}]

                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--sort-column SORT_COLUMN] [--long]
                                       [--status <status>]
Copy to Clipboard Toggle word wrap

Lists jobs

Expand
Table 26.164. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--status <status>

List jobs with specific status

Expand
Table 26.165. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.166. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.167. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.168. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.36. dataprocessing job show

Usage:

openstack dataprocessing job show [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <job>
Copy to Clipboard Toggle word wrap

Display job details

Expand
Table 26.169. Positional Arguments
ValueSummary

<job>

Id of the job to display

Expand
Table 26.170. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.171. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.172. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.173. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.174. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.37. dataprocessing job template create

Usage:

openstack dataprocessing job template create [-h]

                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  [--name <name>]
                                                  [--type <type>]
                                                  [--mains <main> [<main> ...]]
                                                  [--libs <lib> [<lib> ...]]
                                                  [--description <description>]
                                                  [--public] [--protected]
                                                  [--interface <filename>]
                                                  [--json <filename>]
Copy to Clipboard Toggle word wrap

Creates job template

Expand
Table 26.175. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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> [<main> …​]

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

--libs <lib> [<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

Expand
Table 26.176. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.177. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.178. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.179. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.38. dataprocessing job template delete

Usage:

openstack dataprocessing job template delete [-h]

                                                  <job-template>
                                                  [<job-template> ...]
Copy to Clipboard Toggle word wrap

Deletes job template

Expand
Table 26.180. Positional Arguments
ValueSummary

<job-template>

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

Expand
Table 26.181. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-saharaclient plugin.

26.39. dataprocessing job template list

Usage:

openstack dataprocessing job template list [-h]

                                                [-f {csv,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--sort-column SORT_COLUMN]
                                                [--long] [--type <type>]
                                                [--name <name-substring>]
Copy to Clipboard Toggle word wrap

Lists job templates

Expand
Table 26.182. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.183. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.184. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.185. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.186. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.40. dataprocessing job template show

Usage:

openstack dataprocessing job template show [-h]

                                                [-f {json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--fit-width]
                                                [--print-empty] [--noindent]
                                                [--prefix PREFIX]
                                                <job-template>
Copy to Clipboard Toggle word wrap

Display job template details

Expand
Table 26.187. Positional Arguments
ValueSummary

<job-template>

Name or id of the job template to display

Expand
Table 26.188. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.189. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.190. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.191. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.192. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.41. dataprocessing job template update

Usage:

openstack dataprocessing job template update [-h]

                                                  [-f {json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width]
                                                  [--print-empty]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  [--name <name>]
                                                  [--description <description>]
                                                  [--public | --private]
                                                  [--protected | --unprotected]
                                                  <job-template>
Copy to Clipboard Toggle word wrap

Updates job template

Expand
Table 26.193. Positional Arguments
ValueSummary

<job-template>

Name or id of the job template

Expand
Table 26.194. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.195. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.196. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.197. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.198. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.42. dataprocessing job type configs get

Usage:

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

                                                   <job-type>
Copy to Clipboard Toggle word wrap

Get job type configs

Expand
Table 26.199. Positional Arguments
ValueSummary

<job-type>

Type of the job to provide config information about

Expand
Table 26.200. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <file>

Destination file (defaults to job type)

This command is provided by the python-saharaclient plugin.

26.43. dataprocessing job type list

Usage:

openstack dataprocessing job type list [-h]

                                            [-f {csv,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--sort-column SORT_COLUMN]
                                            [--type <type>]
                                            [--plugin <plugin>]
                                            [--plugin-version <plugin_version>]
Copy to Clipboard Toggle word wrap

Lists job types supported by plugins

Expand
Table 26.201. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.202. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.203. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.204. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.205. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.44. dataprocessing job update

Usage:

openstack dataprocessing job update [-h]

                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--public | --private]
                                         [--protected | --unprotected]
                                         <job>
Copy to Clipboard Toggle word wrap

Updates job

Expand
Table 26.206. Positional Arguments
ValueSummary

<job>

Id of the job to update

Expand
Table 26.207. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.208. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.209. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.210. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.211. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.45. dataprocessing node group template create

Usage:

openstack dataprocessing node group template create [-h]

                                                         [-f {json,shell,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--fit-width]
                                                         [--print-empty]
                                                         [--noindent]
                                                         [--prefix PREFIX]
                                                         [--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>]
Copy to Clipboard Toggle word wrap

Creates node group template

Expand
Table 26.212. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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> [<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> [<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

Expand
Table 26.213. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.214. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.215. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.216. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.46. dataprocessing node group template delete

Usage:

openstack dataprocessing node group template delete [-h]


                                                         <node-group-template>
                                                         [<node-group-template> ...]
Copy to Clipboard Toggle word wrap

Deletes node group template

Expand
Table 26.217. Positional Arguments
ValueSummary

<node-group-template>

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

Expand
Table 26.218. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-saharaclient plugin.

26.47. dataprocessing node group template export

Usage:

openstack dataprocessing node group template export [-h]

                                                         [--file <filename>]

                                                         <node-group-template>
Copy to Clipboard Toggle word wrap

Export node group template to JSON

Expand
Table 26.219. Positional Arguments
ValueSummary

<node-group-template>

Name or id of the node group template to export

Expand
Table 26.220. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <filename>

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

This command is provided by the python-saharaclient plugin.

26.48. dataprocessing node group template import

Usage:

openstack dataprocessing node group template import [-h]

                                                         [-f {json,shell,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--fit-width]
                                                         [--print-empty]
                                                         [--noindent]
                                                         [--prefix PREFIX]
                                                         [--name <name>]
                                                         [--security_groups <security_groups>]
                                                         [--floating_ip_pool <floating_ip_pool>]
                                                         --image_id
                                                         <image_id>
                                                         --flavor_id
                                                         <flavor_id>
                                                         <json>
Copy to Clipboard Toggle word wrap

Imports node group template

Expand
Table 26.221. Positional Arguments
ValueSummary

<json>

Json containing node group template

Expand
Table 26.222. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.223. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.224. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.225. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.226. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.49. dataprocessing node group template list

Usage:

openstack dataprocessing node group template list [-h]

                                                       [-f {csv,json,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--max-width <integer>]
                                                       [--fit-width]
                                                       [--print-empty]
                                                       [--noindent]
                                                       [--quote {all,minimal,none,nonnumeric}]
                                                       [--sort-column SORT_COLUMN]
                                                       [--long]
                                                       [--plugin <plugin>]
                                                       [--plugin-version <plugin_version>]
                                                       [--name <name-substring>]
Copy to Clipboard Toggle word wrap

Lists node group templates

Expand
Table 26.227. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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

Expand
Table 26.228. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.229. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.230. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.231. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.50. dataprocessing node group template show

Usage:

openstack dataprocessing node group template show [-h]

                                                       [-f {json,shell,table,value,yaml}]
                                                       [-c COLUMN]
                                                       [--max-width <integer>]
                                                       [--fit-width]
                                                       [--print-empty]
                                                       [--noindent]
                                                       [--prefix PREFIX]
                                                       <node-group-template>
Copy to Clipboard Toggle word wrap

Display node group template details

Expand
Table 26.232. Positional Arguments
ValueSummary

<node-group-template>

Name or id of the node group template to display

Expand
Table 26.233. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.234. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.235. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.236. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.237. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.51. dataprocessing node group template update

Usage:

openstack dataprocessing node group template update [-h]

                                                         [-f {json,shell,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--fit-width]
                                                         [--print-empty]
                                                         [--noindent]
                                                         [--prefix PREFIX]
                                                         [--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>
Copy to Clipboard Toggle word wrap

Updates node group template

Expand
Table 26.238. Positional Arguments
ValueSummary

<node-group-template>

Name or ID of the node group template

Expand
Table 26.239. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--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> [<processes> …​]

List of the processes that will be launched on each instance

--security-groups <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

Expand
Table 26.240. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.241. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.242. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.243. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.52. dataprocessing plugin configs get

Usage:

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

                                                 <plugin> <plugin_version>
Copy to Clipboard Toggle word wrap

Get plugin configs

Expand
Table 26.244. Positional Arguments
ValueSummary

<plugin>

Name of the plugin to provide config information about

<plugin_version>

Version of the plugin to provide config information about

Expand
Table 26.245. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--file <file>

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

This command is provided by the python-saharaclient plugin.

26.53. dataprocessing plugin list

Usage:

openstack dataprocessing plugin list [-h]

                                          [-f {csv,json,table,value,yaml}]
                                          [-c COLUMN]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--sort-column SORT_COLUMN]
                                          [--long]
Copy to Clipboard Toggle word wrap

Lists plugins

Expand
Table 26.246. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 26.247. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--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

Expand
Table 26.248. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.249. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.250. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

This command is provided by the python-saharaclient plugin.

26.54. dataprocessing plugin show

Usage:

openstack dataprocessing plugin show [-h]

                                          [-f {json,shell,table,value,yaml}]
                                          [-c COLUMN]
                                          [--max-width <integer>]
                                          [--fit-width] [--print-empty]
                                          [--noindent] [--prefix PREFIX]
                                          [--plugin-version <plugin_version>]
                                          <plugin>
Copy to Clipboard Toggle word wrap

Display plugin details

Expand
Table 26.251. Positional Arguments
ValueSummary

<plugin>

Name of the plugin to display

Expand
Table 26.252. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--plugin-version <plugin_version>

Version of the plugin to display

Expand
Table 26.253. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.254. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.255. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.256. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

26.55. dataprocessing plugin update

Usage:

openstack dataprocessing plugin update [-h]

                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <plugin> <json>
Copy to Clipboard Toggle word wrap

Expand
Table 26.257. Positional Arguments
ValueSummary

<plugin>

Name of the plugin to provide config information about

<json>

Json representation of the plugin update dictionary

Expand
Table 26.258. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 26.259. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 26.260. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 26.261. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 26.262. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-saharaclient plugin.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat