Share via

az batchai cluster node

  • Deprecated
  • Reference

This command group is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Commands to work with cluster nodes.

Commands

Name Description Type Status
az batchai cluster node exec

Executes a command line on a cluster's node with optional ports forwarding.

 Core Deprecated
az batchai cluster node list

List remote login information for cluster's nodes.

 Core Deprecated

az batchai cluster node exec

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Executes a command line on a cluster's node with optional ports forwarding.

az batchai cluster node exec --cluster
                             --resource-group
                             --workspace
                             [--address]
                             [--exec]
                             [--node-id]
                             [--password]
                             [--ssh-private-key]

Examples

Report a snapshot of the current processes.

az batchai cluster node exec -g MyResourceGroup -w MyWorkspace -c MyCluster \
    -n tvm-xxx --exec "ps axu"

Report a GPU information for a node.

az batchai cluster node exec -g MyResourceGroup -w MyWorkspace -c MyCluster \
    -n tvm-xxx --exec "nvidia-smi"

Forward local 9000 to port 9001 on the node.

az batchai cluster node exec -g MyResourceGroup -w MyWorkspace -c MyCluster \
    -n tvm-xxx -L 9000:localhost:9001

Required Parameters

--cluster -c

Name of cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace -w

Name of workspace.

Optional Parameters

--address -L

Specifies that connections to the given TCP port or Unix socket on the local (client) host are to be forwarded to the given host and port, or Unix socket, on the remote side. e.g. -L 8080:localhost:8080.

--exec

Optional command line to be executed on the node. If not provided, the command will perform ports forwarding only.

--node-id -n

ID of the node to forward the ports to. If not provided, the command will be executed on the first available node.

--password -p

Optional password to establish SSH connection.

--ssh-private-key -k

Optional SSH private key path to establish SSH connection. If omitted, the default SSH private key will be used.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az batchai cluster node list

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

List remote login information for cluster's nodes.

List remote login information for cluster nodes. You can ssh to a particular node using the provided public IP address and the port number. E.g. ssh @ -p <node's SSH port number>.

az batchai cluster node list --cluster
                             --resource-group
                             --workspace

Examples

List remote login information for a cluster.

az batchai cluster node list -g MyResourceGroup -w MyWorkspace -c MyCluster -o table

Required Parameters

--cluster -c

Name of cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace -w

Name of workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.