Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The instance-pools command group within the Databricks CLI enables you to create, edit, delete and list instance pools by using ready-to-use cloud instances which reduces cluster start and auto-scaling times. See Connect to pools.
databricks instance-pools create
Create a new instance pool using idle and ready-to-use cloud instances.
databricks instance-pools create INSTANCE_POOL_NAME NODE_TYPE_ID [flags]
Arguments
INSTANCE_POOL_NAME
Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100 characters.
NODE_TYPE_ID
The ID of the node type. This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster. For example, the Spark nodes can be provisioned and optimized for memory or compute intensive workloads. A list of available node types can be retrieved by using the List node types API.
Options
--enable-elastic-disk
Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire additional disk space when its Spark workers are running low on disk space.
--idle-instance-autotermination-minutes int
Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--max-capacity int
Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances.
--min-idle-instances int
Minimum number of idle instances to keep in the instance pool.
databricks instance-pools delete
Delete an instance pool permanently. The idle instances in the pool are terminated asynchronously.
databricks instance-pools delete INSTANCE_POOL_ID [flags]
Arguments
INSTANCE_POOL_ID
The instance pool to be terminated.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
databricks instance-pools edit
Modify the configuration of an existing instance pool.
databricks instance-pools edit INSTANCE_POOL_ID INSTANCE_POOL_NAME NODE_TYPE_ID [flags]
Arguments
INSTANCE_POOL_ID
Instance pool ID
INSTANCE_POOL_NAME
Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100 characters.
NODE_TYPE_ID
This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster. For example, the Spark nodes can be provisioned and optimized for memory or compute intensive workloads. A list of available node types can be retrieved using databricks clusters list-node-types.
Options
--idle-instance-autotermination-minutes int
Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met.
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
--max-capacity int
Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances.
--min-idle-instances int
Minimum number of idle instances to keep in the instance pool.
databricks instance-pools get
Retrieve the information for an instance pool based on its identifier.
databricks instance-pools get INSTANCE_POOL_ID [flags]
Arguments
INSTANCE_POOL_ID
The canonical unique identifier for the instance pool.
Options
databricks instance-pools list
List instance pool info.
Gets a list of instance pools with their statistics.
databricks instance-pools list [flags]
Arguments
None
Options
databricks instance-pools get-permission-levels
Get instance pool permission levels.
databricks instance-pools get-permission-levels INSTANCE_POOL_ID [flags]
Arguments
INSTANCE_POOL_ID
The instance pool for which to get or manage permissions.
Options
databricks instance-pools get-permissions
Get the permissions of an instance pool. Instance pools can inherit permissions from their root object.
databricks instance-pools get-permissions INSTANCE_POOL_ID [flags]
Arguments
INSTANCE_POOL_ID
The instance pool for which to get or manage permissions.
Options
databricks instance-pools set-permissions
Set instance pool permissions.
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.
databricks instance-pools set-permissions INSTANCE_POOL_ID [flags]
Arguments
INSTANCE_POOL_ID
The instance pool for which to get or manage permissions.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
databricks instance-pools update-permissions
Update the permissions on an instance pool. Instance pools can inherit permissions from their root object.
databricks instance-pools update-permissions INSTANCE_POOL_ID [flags]
Arguments
INSTANCE_POOL_ID
The instance pool for which to get or manage permissions.
Options
--json JSON
The inline JSON string or the @path to the JSON file with the request body.
Global flags
--debug
Whether to enable debug logging.
-h or --help
Display help for the Databricks CLI or the related command group or the related command.
--log-file string
A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.
--log-format format
The log format type, text or json. The default value is text.
--log-level string
A string representing the log format level. If not specified then the log format level is disabled.
-o, --output type
The command output type, text or json. The default value is text.
-p, --profile string
The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.
--progress-format format
The format to display progress logs: default, append, inplace, or json
-t, --target string
If applicable, the bundle target to use