The following commands are currently supported by the Sahara CLI:
dataprocessing plugin configs get
Get plugin configs
usage: dataprocessing plugin configs get [-h] [--file <file>]
<plugin> <plugin_version>
Name of the plugin to provide config information about
Version of the plugin to provide config information about
Destination file (defaults to a combination of plugin name and plugin version)
This command is provided by the python-saharaclient plugin.
dataprocessing plugin list
Lists plugins
usage: dataprocessing plugin list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
This command is provided by the python-saharaclient plugin.
dataprocessing plugin show
Display plugin details
usage: dataprocessing plugin show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
[--plugin-version <plugin_version>]
<plugin>
Name of the plugin to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Version of the plugin to display
This command is provided by the python-saharaclient plugin.
dataprocessing plugin update
Command base class for displaying data about a single object.
usage: dataprocessing plugin update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<plugin> <json>
Name of the plugin to provide config information about
JSON representation of the plugin update dictionary
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing image tags add
Add image tags
usage: dataprocessing image tags add [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] --tags
<tag> [<tag> ...]
<image>
Name or id of the image
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Tag(s) to add [REQUIRED]
This command is provided by the python-saharaclient plugin.
dataprocessing image list
Lists registered images
usage: dataprocessing image list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--name <name-regex>]
[--tags <tag> [<tag> ...]]
[--username <username>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
Regular expression to match image name
List images with specific tag(s)
List images with specific username
This command is provided by the python-saharaclient plugin.
dataprocessing image register
Register an image
usage: dataprocessing image register [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] --username
<username> [--description <description>]
<image>
Name or ID of the image to register
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Username of privileged user in the image [REQUIRED]
Description of the image. If not provided, description of the image will be reset to empty
This command is provided by the python-saharaclient plugin.
dataprocessing image tags remove
Remove image tags
usage: dataprocessing image tags remove [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
[--tags <tag> [<tag> ...] | --all]
<image>
Name or id of the image
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Tag(s) to remove
Remove all tags from image
This command is provided by the python-saharaclient plugin.
dataprocessing image tags set
Set image tags (Replace current image tags with provided ones)
usage: dataprocessing image tags set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty] --tags
<tag> [<tag> ...]
<image>
Name or id of the image
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Tag(s) to set [REQUIRED]
This command is provided by the python-saharaclient plugin.
dataprocessing image show
Display image details
usage: dataprocessing image show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<image>
Name or id of the image to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing image unregister
Unregister image(s)
usage: dataprocessing image unregister [-h] <image> [<image> ...]
Name(s) or id(s) of the image(s) to unregister
This command is provided by the python-saharaclient plugin.
dataprocessing node group template create
Creates node group template
usage: dataprocessing node group template create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--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>]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the node group template [REQUIRED if JSON is not provided]
Name of the plugin [REQUIRED if JSON is not provided]
Version of the plugin [REQUIRED if JSON is not provided]
List of the processes that will be launched on each instance [REQUIRED if JSON is not provided]
Name or ID of the flavor [REQUIRED if JSON is not provided]
List of the security groups for the instances in this node group
Indicates if an additional security group should be created for the node group
Name of the availability zone where instances will be created
ID of the floating IP pool
Number of volumes attached to every node
Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero
Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero
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
Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero
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 of the node group template
If enabled, instances of the node group will be automatically configured
If enabled, instances of the node group will be used to access other instances in the cluster
Make the node group template public (Visible from other projects)
Make the node group template protected
JSON representation of the node group template. Other arguments will not be taken into account if this one is provided
JSON representation of the manila shares
JSON representation of the node group template configs
This command is provided by the python-saharaclient plugin.
dataprocessing node group template delete
Deletes node group template
usage: dataprocessing node group template delete [-h]
<node-group-template>
[<node-group-template> ...]
Name(s) or id(s) of the node group template(s) to delete
This command is provided by the python-saharaclient plugin.
dataprocessing node group template export
Export node group template to JSON
usage: dataprocessing node group template export [-h] [--file <filename>]
<node-group-template>
Name or id of the node group template to export
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.
dataprocessing node group template import
Imports node group template
usage: dataprocessing node group template import [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--security_groups <security_groups>]
[--floating_ip_pool <floating_ip_pool>]
--image_id <image_id>
--flavor_id <flavor_id>
<json>
JSON containing node group template
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the node group template
Security groups of the node group template
Floating IP pool of the node group template
Image ID of the node group template
Flavor ID of the node group template
This command is provided by the python-saharaclient plugin.
dataprocessing node group template list
Lists node group templates
usage: dataprocessing node group template list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--plugin <plugin>]
[--plugin-version <plugin_version>]
[--name <name-substring>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List node group templates for specific plugin
List node group templates with specific version of the plugin
List node group templates with specific substring in the name
This command is provided by the python-saharaclient plugin.
dataprocessing node group template show
Display node group template details
usage: dataprocessing node group template show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
<node-group-template>
Name or id of the node group template to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing node group template update
Updates node group template
usage: dataprocessing node group template update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--plugin <plugin>]
[--plugin-version <plugin_version>]
[--processes <processes> [<processes> ...]]
[--security-groups <security-groups> [<security-groups> ...]]
[--auto-security-group-enable | --auto-security-group-disable]
[--availability-zone <availability-zone>]
[--flavor <flavor>]
[--floating-ip-pool <floating-ip-pool>]
[--volumes-per-node <volumes-per-node>]
[--volumes-size <volumes-size>]
[--volumes-type <volumes-type>]
[--volumes-availability-zone <volumes-availability-zone>]
[--volumes-mount-prefix <volumes-mount-prefix>]
[--volumes-locality-enable | --volumes-locality-disable]
[--description <description>]
[--autoconfig-enable | --autoconfig-disable]
[--proxy-gateway-enable | --proxy-gateway-disable]
[--public | --private]
[--protected | --unprotected]
[--json <filename>]
[--shares <filename>]
[--configs <filename>]
<node-group-template>
Name or ID of the node group template
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
New name of the node group template
Name of the plugin
Version of the plugin
List of the processes that will be launched on each instance
List of the security groups for the instances in this node group
Additional security group should be created for the node group
Additional security group should not be created for the node group
Name of the availability zone where instances will be created
Name or ID of the flavor
ID of the floating IP pool
Number of volumes attached to every node
Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero
Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero
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
Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero
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
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 of the node group template
Instances of the node group will be automatically configured
Instances of the node group will not be automatically configured
Instances of the node group will be used to access other instances in the cluster
Instances of the node group will not be used to access other instances in the cluster
Make the node group template public (Visible from other projects)
Make the node group template private (Visible only from this project)
Make the node group template protected
Make the node group template unprotected
JSON representation of the node group template update fields. Other arguments will not be taken into account if this one is provided
JSON representation of the manila shares
JSON representation of the node group template configs
This command is provided by the python-saharaclient plugin.
dataprocessing cluster template create
Creates cluster template
usage: dataprocessing cluster template create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--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>]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the cluster template [REQUIRED if JSON is not provided]
List of the node groups(names or IDs) and numbers of instances for each one of them [REQUIRED if JSON is not provided]
List of processes that should be added to an anti-affinity group
Description of the cluster template
If enabled, instances of the cluster will be automatically configured
Make the cluster template public (Visible from other projects)
Make the cluster template protected
JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided
JSON representation of the manila shares
JSON representation of the cluster template configs
Domain name for instances of this cluster template. This option is available if ‘use_designate’ config is True
This command is provided by the python-saharaclient plugin.
dataprocessing cluster template delete
Deletes cluster template
usage: dataprocessing cluster template delete [-h]
<cluster-template>
[<cluster-template> ...]
Name(s) or id(s) of the cluster template(s) to delete
This command is provided by the python-saharaclient plugin.
dataprocessing cluster template export
Export cluster template to JSON
usage: dataprocessing cluster template export [-h] [--file <filename>]
<cluster-template>
Name or id of the cluster template to export
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.
dataprocessing cluster template import
Imports cluster template
usage: dataprocessing cluster template import [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--default-image-id <default_image_id>]
--node-groups
<node-group:instances_count>
[<node-group:instances_count> ...]
<json>
JSON containing cluster template
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the cluster template
Default image ID to be used
List of the node groups(names or IDs) and numbers of instances for each one of them
This command is provided by the python-saharaclient plugin.
dataprocessing cluster template list
Lists cluster templates
usage: dataprocessing cluster template list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--plugin <plugin>]
[--plugin-version <plugin_version>]
[--name <name-substring>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List cluster templates for specific plugin
List cluster templates with specific version of the plugin
List cluster templates with specific substring in the name
This command is provided by the python-saharaclient plugin.
dataprocessing cluster template show
Display cluster template details
usage: dataprocessing cluster template show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
<cluster-template>
Name or id of the cluster template to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing cluster template update
Updates cluster template
usage: dataprocessing cluster template update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
[--anti-affinity <anti-affinity> [<anti-affinity> ...]]
[--description <description>]
[--autoconfig-enable | --autoconfig-disable]
[--public | --private]
[--protected | --unprotected]
[--json <filename>]
[--shares <filename>]
[--configs <filename>]
[--domain-name <domain-name>]
<cluster-template>
Name or ID of the cluster template [REQUIRED]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
New name of the cluster template
List of the node groups(names or IDs) and numbers ofinstances for each one of them
List of processes that should be added to an anti-affinity group
Description of the cluster template
Instances of the cluster will be automatically configured
Instances of the cluster will not be automatically configured
Make the cluster template public (Visible from other projects)
Make the cluster template private (Visible only from this tenant)
Make the cluster template protected
Make the cluster template unprotected
JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided
JSON representation of the manila shares
JSON representation of the cluster template configs
Domain name for instances of this cluster template. This option is available if ‘use_designate’ config is True
This command is provided by the python-saharaclient plugin.
dataprocessing cluster create
Creates cluster
usage: dataprocessing cluster create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--cluster-template <cluster-template>]
[--image <image>]
[--description <description>]
[--user-keypair <keypair>]
[--neutron-network <network>]
[--count <count>] [--public]
[--protected] [--transient]
[--json <filename>] [--wait]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the cluster [REQUIRED if JSON is not provided]
Cluster template name or ID [REQUIRED if JSON is not provided]
Image that will be used for cluster deployment (Name or ID) [REQUIRED if JSON is not provided]
Description of the cluster
User keypair to get acces to VMs after cluster creation
Instances of the cluster will get fixed IP addresses in this network. (Name or ID should be provided)
Number of clusters to be created
Make the cluster public (Visible from other projects)
Make the cluster protected
Create transient cluster
JSON representation of the cluster. Other arguments (except for –wait) will not be taken into account if this one is provided
Wait for the cluster creation to complete
This command is provided by the python-saharaclient plugin.
dataprocessing cluster delete
Deletes cluster
usage: dataprocessing cluster delete [-h] [--wait] <cluster> [<cluster> ...]
Name(s) or id(s) of the cluster(s) to delete
Wait for the cluster(s) delete to complete
This command is provided by the python-saharaclient plugin.
dataprocessing cluster list
Lists clusters
usage: dataprocessing cluster list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--plugin <plugin>]
[--plugin-version <plugin_version>]
[--name <name-substring>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List clusters with specific plugin
List clusters with specific version of the plugin
List clusters with specific substring in the name
This command is provided by the python-saharaclient plugin.
dataprocessing cluster scale
Scales cluster
usage: dataprocessing cluster scale [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
[--instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]]
[--json <filename>] [--wait]
<cluster>
Name or ID of the cluster
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Node group templates and number of their instances to be scale to [REQUIRED if JSON is not provided]
JSON representation of the cluster scale object. Other arguments (except for –wait) will not be taken into account if this one is provided
Wait for the cluster scale to complete
This command is provided by the python-saharaclient plugin.
dataprocessing cluster show
Display cluster details
usage: dataprocessing cluster show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--verification]
[--show-progress] [--full-dump-events]
<cluster>
Name or id of the cluster to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
List additional fields for verifications
Provides ability to show brief details of event logs.
Provides ability to make full dump with event log details.
This command is provided by the python-saharaclient plugin.
dataprocessing cluster verification
Updates cluster
usage: dataprocessing cluster verification [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--description <description>]
[--shares <filename>]
[--public | --private]
[--protected | --unprotected]
<cluster>
Name or ID of the cluster
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
New name of the cluster
Description of the cluster
JSON representation of the manila shares
Make the cluster public (Visible from other projects)
Make the cluster private (Visible only from this tenant)
Make the cluster protected
Make the cluster unprotected
This command is provided by the python-saharaclient plugin.
dataprocessing cluster verification
Updates cluster verifications
usage: dataprocessing cluster verification [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
(--start | --show)
<cluster>
Name or ID of the cluster
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Start health verification for the cluster
Show health of the cluster
This command is provided by the python-saharaclient plugin.
dataprocessing data source create
Creates data source
usage: dataprocessing data source create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] --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>
Name of the data source
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Type of the data source (swift, hdfs, maprfs, manila, s3) [REQUIRED]
Possible choices: swift, hdfs, maprfs, manila, s3
URL for the data source [REQUIRED]
Username for accessing the data source URL
S3 access key for accessing the data source URL
Password for accessing the data source URL
S3 secret key for accessing the data source URL
S3 endpoint for accessing the data source URL (ignored if data source not in S3)
Enable access to S3 endpoint using SSL (ignored if data source not in S3)
Disable access to S3 endpoint using SSL (ignored if data source not in S3)
Access S3 endpoint using bucket name in path (ignored if data source not in S3)
Access S3 endpoint using bucket name in path (ignored if data source not in S3)
Description of the data source
Make the data source public
Make the data source protected
This command is provided by the python-saharaclient plugin.
dataprocessing data source delete
Delete data source
usage: dataprocessing data source delete [-h]
<data-source> [<data-source> ...]
Name(s) or id(s) of the data source(s) to delete
This command is provided by the python-saharaclient plugin.
dataprocessing data source list
Lists data sources
usage: dataprocessing data source list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--type <type>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List data sources of specific type (swift, hdfs, maprfs, manila, s3)
Possible choices: swift, hdfs, maprfs, manila, s3
This command is provided by the python-saharaclient plugin.
dataprocessing data source show
Display data source details
usage: dataprocessing data source show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<data-source>
Name or id of the data source to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing data source update
Update data source
usage: dataprocessing data source update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--name <name>]
[--type <type>] [--url <url>]
[--username <username> | --access-key <accesskey>]
[--password <password> | --secret-key <secretkey>]
[--s3-endpoint <endpoint>]
[--enable-s3-ssl | --disable-s3-ssl]
[--enable-s3-bucket-in-path | --disable-s3-bucket-in-path]
[--description <description>]
[--public | --private]
[--protected | --unprotected]
<data-source>
Name or id of the data source
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
New name of the data source
Type of the data source (swift, hdfs, maprfs, manila, s3)
Possible choices: swift, hdfs, maprfs, manila, s3
URL for the data source
Username for accessing the data source URL
S3 access key for accessing the data source URL
Password for accessing the data source URL
S3 secret key for accessing the data source URL
S3 endpoint for accessing the data source URL (ignored if data source not in S3)
Enable access to S3 endpoint using SSL (ignored if data source not in S3)
Disable access to S3 endpoint using SSL (ignored if data source not in S3)
Access S3 endpoint using bucket name in path (ignored if data source not in S3)
Access S3 endpoint using bucket name in path (ignored if data source not in S3)
Description of the data source
Make the data source public (Visible from other projects)
Make the data source private (Visible only from this tenant)
Make the data source protected
Make the data source unprotected
This command is provided by the python-saharaclient plugin.
dataprocessing job binary create
Creates job binary
usage: dataprocessing job binary create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--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>]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the job binary [REQUIRED if JSON is not provided]
File that will be stored in the internal DB [REQUIRED if JSON and URL are not provided]
URL for the job binary [REQUIRED if JSON and file are not provided]
Description of the job binary
Username for accessing the job binary URL
S3 access key for accessing the job binary URL
Password for accessing the job binary URL
S3 secret key for accessing the job binary URL
Prompt interactively for password
Prompt interactively for S3 secret key
S3 endpoint for accessing the job binary URL (ignored if binary not in S3
Make the job binary public
Make the job binary protected
JSON representation of the job binary. Other arguments will not be taken into account if this one is provided
This command is provided by the python-saharaclient plugin.
dataprocessing job binary delete
Deletes job binary
usage: dataprocessing job binary delete [-h] <job-binary> [<job-binary> ...]
Name(s) or id(s) of the job binary(ies) to delete
This command is provided by the python-saharaclient plugin.
dataprocessing job binary download
Downloads job binary
usage: dataprocessing job binary download [-h] [--file <file>] <job-binary>
Name or ID of the job binary to download
Destination file (defaults to job binary name)
This command is provided by the python-saharaclient plugin.
dataprocessing job binary list
Lists job binaries
usage: dataprocessing job binary list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--name <name-substring>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List job binaries with specific substring in the name
This command is provided by the python-saharaclient plugin.
dataprocessing job binary show
Display job binary details
usage: dataprocessing job binary show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<job-binary>
Name or ID of the job binary to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing job binary update
Updates job binary
usage: dataprocessing job binary update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--name <name>]
[--url <url>]
[--description <description>]
[--username <username> | --access-key <accesskey>]
[--password <password> | --secret-key <secretkey> | --password-prompt | --secret-key-prompt]
[--s3-endpoint <endpoint>]
[--public | --private]
[--protected | --unprotected]
[--json <filename>]
<job-binary>
Name or ID of the job binary
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
New name of the job binary
URL for the job binary [Internal DB URL can not be updated]
Description of the job binary
Username for accessing the job binary URL
S3 access key for accessing the job binary URL
Password for accessing the job binary URL
S3 secret key for accessing the job binary URL
Prompt interactively for password
Prompt interactively for S3 secret key
S3 endpoint for accessing the job binary URL (ignored if binary not in S3
Make the job binary public (Visible from other projects)
Make the job binary private (Visible only from this project)
Make the job binary protected
Make the job binary unprotected
JSON representation of the update object. Other arguments will not be taken into account if this one is provided
This command is provided by the python-saharaclient plugin.
dataprocessing job type configs get
Get job type configs
usage: dataprocessing job type configs get [-h] [--file <file>] <job-type>
Type of the job to provide config information about
Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark
Destination file (defaults to job type)
This command is provided by the python-saharaclient plugin.
dataprocessing job type list
Lists job types supported by plugins
usage: dataprocessing job type list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--type <type>] [--plugin <plugin>]
[--plugin-version <plugin_version>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
Get information about specific job type
Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark
Get only job types supported by this plugin
Get only job types supported by specific version of the plugin. This parameter will be taken into account only if plugin is provided
This command is provided by the python-saharaclient plugin.
dataprocessing job template create
Creates job template
usage: dataprocessing job template create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>] [--type <type>]
[--mains <main> [<main> ...]]
[--libs <lib> [<lib> ...]]
[--description <description>]
[--public] [--protected]
[--interface <filename>]
[--json <filename>]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name of the job template [REQUIRED if JSON is not provided]
Type of the job (Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark) [REQUIRED if JSON is not provided]
Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark
Name(s) or ID(s) for job’s main job binary(s)
Name(s) or ID(s) for job’s lib job binary(s)
Description of the job template
Make the job template public
Make the job template protected
JSON representation of the interface
JSON representation of the job template
This command is provided by the python-saharaclient plugin.
dataprocessing job template delete
Deletes job template
usage: dataprocessing job template delete [-h]
<job-template> [<job-template> ...]
Name(s) or id(s) of the job template(s) to delete
This command is provided by the python-saharaclient plugin.
dataprocessing job template list
Lists job templates
usage: dataprocessing job template list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--long] [--type <type>]
[--name <name-substring>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List job templates of specific type
Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark
List job templates with specific substring in the name
This command is provided by the python-saharaclient plugin.
dataprocessing job template show
Display job template details
usage: dataprocessing job template show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<job-template>
Name or ID of the job template to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing job template update
Updates job template
usage: dataprocessing job template update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--name <name>]
[--description <description>]
[--public | --private]
[--protected | --unprotected]
<job-template>
Name or ID of the job template
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
New name of the job template
Description of the job template
Make the job template public (Visible from other projects)
Make the job_template private (Visible only from this tenant)
Make the job template protected
Make the job template unprotected
This command is provided by the python-saharaclient plugin.
dataprocessing job binary delete
Deletes job
usage: dataprocessing job binary delete [-h] [--wait] <job> [<job> ...]
ID(s) of the job(s) to delete
Wait for the job(s) delete to complete
This command is provided by the python-saharaclient plugin.
dataprocessing job execute
Executes job
usage: dataprocessing job execute [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
[--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>]
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Name or ID of the job template [REQUIRED if JSON is not provided]
Name or ID of the cluster [REQUIRED if JSON is not provided]
Name or ID of the input data source
Name or ID of the output data source
Parameters to add to the job
Arguments to add to the job
Make the job public
Make the job protected
JSON representation of the job configs
Configs to add to the job
JSON representation of the interface
JSON representation of the job. Other arguments will not be taken into account if this one is provided
This command is provided by the python-saharaclient plugin.
dataprocessing job list
Lists jobs
usage: dataprocessing job list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending] [--long]
[--status <status>]
the output format, defaults to table
Possible choices: csv, json, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
when to include quotes, defaults to nonnumeric
Possible choices: all, minimal, none, nonnumeric
whether to disable indenting the JSON
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List additional fields in output
List jobs with specific status
Possible choices: done-with-error, failed, killed, pending, running, succeeded, to-be-killed
This command is provided by the python-saharaclient plugin.
dataprocessing job binary show
Display job details
usage: dataprocessing job binary show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<job>
ID of the job to display
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
This command is provided by the python-saharaclient plugin.
dataprocessing job binary update
Updates job
usage: dataprocessing job binary update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--public | --private]
[--protected | --unprotected]
<job>
ID of the job to update
the output format, defaults to table
Possible choices: json, shell, table, value, yaml
specify the column(s) to include, can be repeated to show multiple columns
whether to disable indenting the JSON
add a prefix to all variable names
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
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 table if there is no data to show.
Make the job public (Visible from other projects)
Make the job private (Visible only from this project)
Make the job protected
Make the job unprotected
This command is provided by the python-saharaclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.