CLI Command Reference
This document provides a comprehensive reference for all available CLI commands and their options.
Usage: vantage [OPTIONS] COMMAND [ARGS]...
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ version Show version and exit. │
│ login Authenticate against the Vantage CLI by obtaining an authentication token. │
│ logout Log out of the vantage-cli and clear saved user credentials. │
│ whoami Display information about the currently authenticated user. │
│ cloud Manage cloud provider configurations and integrations for your Vantage infrastructure. │
│ cluster Manage Vantage compute clusters for high-performance computing workloads. │
│ config Manage Vantage CLI configuration and settings. │
│ license Manage software licenses, license servers, and licensing configurations. │
│ network Manage virtual networks, subnets, and network configurations for cloud infrastructure. │
│ profile Manage Vantage CLI profiles to work with different environments and configurations. │
│ storage Manage storage volumes, disks, and storage configurations for cloud infrastructure. │
│ app Deploy and manage applications on Vantage compute clusters. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Authentication Commands
Login
Usage: vantage login [OPTIONS]
Authenticate against the Vantage CLI by obtaining an authentication token.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use [default: default] │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Logout
Usage: vantage logout [OPTIONS]
Log out of the vantage-cli and clear saved user credentials.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use [default: default] │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Whoami
Usage: vantage whoami [OPTIONS]
Display information about the currently authenticated user.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use [default: default] │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Version Information
Usage: vantage version [OPTIONS]
Show version and exit.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use [default: default] │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Cloud Management
Usage: vantage cloud [OPTIONS] COMMAND [ARGS]...
Manage cloud provider configurations and integrations for your Vantage infrastructure.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ add Add a new cloud configuration. │
│ delete Delete a cloud configuration. │
│ get Get details of a specific cloud configuration. │
│ list List all configured cloud providers. │
│ update Update an existing cloud configuration. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show cloud add details
vantage cloud add [OPTIONS] CLOUD_NAME
Arguments:
*- cloud_name TEXT Name of the cloud to add [required] │
Options:
--region- -r TEXT Default region for the cloud │--config-file FILE- Path to cloud configuration file │--credentials-file FILE- Path to credentials file │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cloud delete details
vantage cloud delete [OPTIONS] CLOUD_NAME
Arguments:
*- cloud_name TEXT Name of the cloud to delete [required] │
Options:
--force Force- deletion without confirmation │--remove-credentials Also- remove stored credentials │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cloud get details
vantage cloud get [OPTIONS] NAME
Arguments:
*- name TEXT Name of the cloud configuration to retrieve [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cloud list details
vantage cloud list [OPTIONS]
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cloud update details
vantage cloud update [OPTIONS] CLOUD_NAME
Arguments:
*- cloud_name TEXT Name of the cloud to update [required] │
Options:
--provider- -p TEXT Update cloud provider │--region- -r TEXT Update default region │--config-file FILE- Path to updated configuration file │--credentials-file FILE- Path to updated credentials file │--description TEXT- Update cloud description │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Cluster Management
Usage: vantage cluster [OPTIONS] COMMAND [ARGS]...
Manage Vantage compute clusters for high-performance computing workloads.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new Vantage cluster. │
│ delete Delete a Vantage cluster. │
│ get Get details of a specific Vantage cluster. │
│ list List all Vantage clusters. │
│ federation Manage Vantage compute federations for distributed workloads. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show cluster create details
vantage cluster create [OPTIONS] CLUSTER_NAME
Arguments:
*- cluster_name TEXT Name of the cluster to create [required] │
Options:
--config-file FILE- Path to configuration file for │--deploy- [slurm-juju-localhost|slurm-microk8 Deploy an application after cluster │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use │--help Show- this message and exit. │
Show cluster delete details
vantage cluster delete [OPTIONS] CLUSTER_NAME
Arguments:
*- cluster_name TEXT Name of the cluster to delete [required] │
Options:
--force- -f Skip confirmation prompt │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster get details
vantage cluster get [OPTIONS] CLUSTER_NAME
Arguments:
*- cluster_name TEXT Name of the cluster to get details for [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster list details
vantage cluster list [OPTIONS]
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster federation help
vantage cluster federation --help
Usage: vantage cluster federation [OPTIONS] COMMAND
[ARGS]...
Manage Vantage compute federations for distributed workloads.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new Vantage federation. │
│ delete Delete a Vantage federation. │
│ get Get details of a specific Vantage federation. │
│ list List all Vantage federations. │
│ update Update a Vantage federation. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show cluster federation create details
vantage cluster federation create
Arguments:
*- name TEXT Name of the federation to create [required] │
Options:
--description- -d TEXT Description of the federation │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster federation delete details
vantage cluster federation delete
Arguments:
*- name TEXT Name of the federation to delete [required] │
Options:
--force- -f Force deletion without confirmation │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster federation get details
vantage cluster federation get [OPTIONS] NAME
Arguments:
*- name TEXT Name of the federation to retrieve [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster federation list details
vantage cluster federation list [OPTIONS]
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show cluster federation update details
vantage cluster federation update
Arguments:
*- name TEXT Name of the federation to update [required] │
Options:
--description- -d TEXT New description for the federation │--add-cluster TEXT- Add a cluster to the federation │--remove-cluster TEXT- Remove a cluster from the federation │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
License Management
Usage: vantage license [OPTIONS] COMMAND [ARGS]...
Manage software licenses, license servers, and licensing configurations.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ server Manage license servers for software licensing and compliance. │
│ product Manage license products and software licensing definitions. │
│ configuration Manage license configurations and policy settings. │
│ deployment Manage license deployments for software distribution and activation. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show license server help
vantage license server --help
Usage: vantage license server [OPTIONS] COMMAND [ARGS]...
Manage license servers for software licensing and compliance.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new license server. │
│ delete Delete a license server. │
│ get Get details of a specific license server. │
│ list List all license servers. │
│ update Update an existing license server. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show license server create details
vantage license server create [OPTIONS] NAME
Arguments:
*- name TEXT Name of the license server to create [required] │
Options:
--port- -p INTEGER License server port [default: 27000] │--description- -d TEXT Description of the license server │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license server delete details
vantage license server delete [OPTIONS] SERVER_ID
Arguments:
*- server_id TEXT ID of the license server to delete [required] │
Options:
--force- -f Force delete without confirmation │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license server get details
vantage license server get [OPTIONS] SERVER_ID
Arguments:
*- server_id TEXT ID of the license server to get [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license server list details
vantage license server list [OPTIONS]
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license server update details
vantage license server update [OPTIONS] SERVER_ID
Arguments:
*- server_id TEXT ID of the license server to update [required] │
Options:
--name- -n TEXT New name for the license server │--host- -h TEXT New hostname or IP address │--port- -p INTEGER New port number │--description- -d TEXT New description │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license product help
vantage license product --help
Usage: vantage license product [OPTIONS] COMMAND [ARGS]...
Manage license products and software licensing definitions.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new license product. │
│ delete Delete a license product. │
│ get Get details of a specific license product. │
│ list List all license products. │
│ update Update an existing license product. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show license product create details
vantage license product create [OPTIONS] NAME
Arguments:
*- name TEXT Name of the license product to create [required] │
Options:
--description- -d TEXT Description of the license product │--type- -t TEXT Type of license (concurrent, node-locked, etc.) │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license product delete details
vantage license product delete [OPTIONS] PRODUCT_ID
Arguments:
*- product_id TEXT ID of the license product to delete [required] │
Options:
--force- -f Force delete without confirmation │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license product get details
vantage license product get [OPTIONS] PRODUCT_ID
Arguments:
*- product_id TEXT ID of the license product to get [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license product list details
vantage license product list [OPTIONS]
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license product update details
vantage license product update [OPTIONS] PRODUCT_ID
Arguments:
*- product_id TEXT ID of the license product to update [required] │
Options:
--name- -n TEXT New name for the license product │--version- -v TEXT New version │--description- -d TEXT New description │--type- -t TEXT New license type │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license configuration help
vantage license configuration --help
Usage: vantage license configuration [OPTIONS] COMMAND
[ARGS]...
Manage license configurations and policy settings.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new license configuration. │
│ delete Delete a license configuration. │
│ get Get details of a specific license configuration. │
│ list List all license configurations. │
│ update Update an existing license configuration. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show license configuration create details
vantage license configuration create
Arguments:
*- name TEXT Name of the license configuration to create [required] │
Options:
--max-users- -m INTEGER Maximum number of users │--description- -d TEXT Description of the license configuration │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license configuration delete details
vantage license configuration delete
Arguments:
*- config_id TEXT ID of the license configuration to delete [required] │
Options:
--force- -f Force delete without confirmation │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license configuration get details
vantage license configuration get
Arguments:
*- config_id TEXT ID of the license configuration to get [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license configuration list details
vantage license configuration list
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license configuration update details
vantage license configuration update
Arguments:
*- config_id TEXT ID of the license configuration to update [required] │
Options:
--name- -n TEXT New name for the license configuration │--type- -t TEXT New license type │--max-users- -m INTEGER New maximum number of users │--description- -d TEXT New description │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license deployment help
vantage license deployment --help
Usage: vantage license deployment [OPTIONS] COMMAND
[ARGS]...
Manage license deployments for software distribution and activation.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new license deployment. │
│ delete Delete a license deployment. │
│ get Get details of a specific license deployment. │
│ list List all license deployments. │
│ update Update a license deployment. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show license deployment create details
vantage license deployment create
Arguments:
*- name TEXT Name of the license deployment to create [required] │
Options:
--environment- -e TEXT Deployment environment (dev, test, prod) [default: dev] │--nodes- -n INTEGER Number of nodes in the deployment [default: 1] │--description- -d TEXT Description of the license deployment │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license deployment delete details
vantage license deployment delete
Arguments:
*- deployment_id TEXT ID of the license deployment to delete [required] │
Options:
--force- -f Skip confirmation prompt │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license deployment get details
vantage license deployment get [OPTIONS]
Arguments:
*- deployment_id TEXT ID of the license deployment to retrieve [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license deployment list details
vantage license deployment list [OPTIONS]
Options:
--environment- -e TEXT Filter by environment │--status- -s TEXT Filter by status │--limit- -l INTEGER Maximum number of deployments to return [default: 10] │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show license deployment update details
vantage license deployment update
Arguments:
*- deployment_id TEXT ID of the license deployment to update [required] │
Options:
--name- -n TEXT New name for the deployment │--environment- -e TEXT New environment for the deployment │--nodes INTEGER- New number of nodes │--description- -d TEXT New description │--status- -s TEXT New status (active, inactive, suspended) │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Network Management
Usage: vantage network [OPTIONS] COMMAND [ARGS]...
Manage virtual networks, subnets, and network configurations for cloud infrastructure.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ attach Attach a network interface to an instance. │
│ create Create a new virtual network. │
│ delete Delete a virtual network. │
│ detach Detach a network interface from an instance. │
│ get Get details of a specific virtual network. │
│ list List all virtual networks. │
│ update Update a virtual network configuration. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show network attach details
vantage network attach [OPTIONS] NETWORK_ID
Arguments:
*- network_id TEXT ID of the network to attach [required] │*- instance_id TEXT ID of the instance to attach network to [required] │
Options:
--subnet-id- -s TEXT Specific subnet ID to attach │--assign-public-ip Assign- a public IP address │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show network create details
vantage network create [OPTIONS] NAME
Arguments:
*- name TEXT Name of the network to create [required] │
Options:
--cidr- -c TEXT CIDR block for the network [default: 10.0.0.0/16] │--region- -r TEXT Region for the network │--enable-dns Enable- DNS resolution [default: True] │--description- -d TEXT Description of the network │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show network delete details
vantage network delete [OPTIONS] NETWORK_ID
Arguments:
*- network_id TEXT ID of the network to delete [required] │
Options:
--force- -f Skip confirmation prompt │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show network detach details
vantage network detach [OPTIONS] NETWORK_ID
Arguments:
*- network_id TEXT ID of the network to detach [required] │*- instance_id TEXT ID of the instance to detach network from [required] │
Options:
--force- -f Force detachment without graceful shutdown │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show network get details
vantage network get [OPTIONS] NETWORK_ID
Arguments:
*- network_id TEXT ID of the network to retrieve [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show network list details
vantage network list [OPTIONS]
Options:
--region- -r TEXT Filter by region │--status- -s TEXT Filter by status │--limit- -l INTEGER Maximum number of networks to return [default: 10] │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show network update details
vantage network update [OPTIONS] NETWORK_ID
Arguments:
*- network_id TEXT ID of the network to update [required] │
Options:
--name- -n TEXT New name for the network │--description- -d TEXT New description │--enable-dns- --disable-dns Enable or disable DNS resolution │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Profile Management
Usage: vantage profile [OPTIONS] COMMAND [ARGS]...
Manage Vantage CLI profiles to work with different environments and configurations.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ create Create a new Vantage CLI profile. │
│ delete Delete a Vantage CLI profile. │
│ get Get details of a specific Vantage CLI profile. │
│ list List all Vantage CLI profiles. │
│ use Activate a profile for use in the current session. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show profile create details
vantage profile create [OPTIONS] PROFILE_NAME
Arguments:
*- profile_name TEXT Name of the profile to create [required] │
Options:
--api-url TEXT- API base URL [default: https://apis.vantagecompute.ai] │--tunnel-url TEXT- Tunnel API URL [default: https://tunnel.vantagecompute.ai] │--oidc-url TEXT- OIDC base URL [default: https://auth.vantagecompute.ai] │--client-id TEXT- OIDC client ID [default: default] │--max-poll-time INTEGER- OIDC max poll time in seconds [default: 300] │--force- -f Overwrite existing profile │--activate Activate- this profile after creation │--help Show- this message and exit. │
Show profile delete details
vantage profile delete [OPTIONS] PROFILE_NAME
Arguments:
*- profile_name TEXT Name of the profile to delete [required] │
Options:
--force- -f Skip confirmation prompt │--help Show- this message and exit. │
Show profile get details
vantage profile get [OPTIONS] PROFILE_NAME
Arguments:
*- profile_name TEXT Name of the profile to get details for [required] │
Options:
--help Show- this message and exit. │
Show profile list details
vantage profile list [OPTIONS]
Options:
--help Show- this message and exit. │
Show profile use details
vantage profile use [OPTIONS] PROFILE_NAME
Arguments:
*- profile_name TEXT Name of the profile to activate [required] │
Options:
--help Show- this message and exit. │
Storage Management
Usage: vantage storage [OPTIONS] COMMAND [ARGS]...
Manage storage volumes, disks, and storage configurations for cloud infrastructure.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ attach Attach a storage volume to an instance. │
│ create Create a new storage volume. │
│ delete Delete a storage volume. │
│ detach Detach a storage volume from an instance. │
│ get Get details of a specific storage volume. │
│ list List all storage volumes. │
│ update Update a storage volume configuration. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show storage attach details
vantage storage attach [OPTIONS] STORAGE_ID
Arguments:
*- storage_id TEXT ID of the storage volume to attach [required] │*- instance_id TEXT ID of the instance to attach storage to [required] │
Options:
--mount-point- -m TEXT Mount point for the storage [default: /data] │--read-only- -r Attach storage in read-only mode │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show storage create details
vantage storage create [OPTIONS] NAME
Arguments:
*- name TEXT Name of the storage volume to create [required] │
Options:
--size- -s INTEGER Size of the storage volume in GB [default: 10] │--type- -t TEXT Storage type (ssd, hdd, nvme) [default: ssd] │--zone- -z TEXT Availability zone for the storage │--description- -d TEXT Description of the storage volume │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show storage delete details
vantage storage delete [OPTIONS] STORAGE_ID
Arguments:
*- storage_id TEXT ID of the storage volume to delete [required] │
Options:
--force- -f Skip confirmation prompt │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show storage detach details
vantage storage detach [OPTIONS] STORAGE_ID
Arguments:
*- storage_id TEXT ID of the storage volume to detach [required] │
Options:
--force- -f Force detachment without graceful unmounting │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show storage get details
vantage storage get [OPTIONS] STORAGE_ID
Arguments:
*- storage_id TEXT ID of the storage volume to retrieve [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show storage list details
vantage storage list [OPTIONS]
Options:
--zone- -z TEXT Filter by availability zone │--type- -t TEXT Filter by storage type │--status- -s TEXT Filter by status │--limit- -l INTEGER Maximum number of storage volumes to return [default: 10] │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show storage update details
vantage storage update [OPTIONS] STORAGE_ID
Arguments:
*- storage_id TEXT ID of the storage volume to update [required] │
Options:
--name- -n TEXT New name for the storage volume │--size- -s INTEGER New size in GB (expansion only) │--description- -d TEXT New description │--iops INTEGER- New IOPS setting │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Application Management
Usage: vantage app [OPTIONS] COMMAND [ARGS]...
Deploy and manage applications on Vantage compute clusters.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────╮
│ list List all available applications for deployment. │
│ deploy Deploy a slurm cluster and link it to a cluster entity in Vantage. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
Show app list details
vantage app list [OPTIONS]
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Show app deploy details
vantage app deploy [OPTIONS] APP_NAME CLUSTER_NAME
Arguments:
*- app_name TEXT Name of the cluster infrastructure application to deploy [required] │*- cluster_name TEXT Name of the cluster in Vantage you would like to link to [required] │
Options:
--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │
Configuration Management
Show config clear details
vantage config clear [OPTIONS]
Options:
--force- -f Skip confirmation prompt │--json- -j Output in JSON format │--verbose- -v Enable verbose terminal output │--profile- -p TEXT Profile name to use [default: default] │--help Show- this message and exit. │