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. │
│ cli-dash Vantage CLI Dashboard - Interactive terminal dashboard. │
│ app Manage applications │
│ cloud Manage cloud provider configurations. │
│ cluster Manage Vantage compute clusters for high-performance │
│ computing workloads. │
│ config Manage Vantage CLI configuration and settings. │
│ job Manage computational jobs, scripts, submissions, and job │
│ templates for HPC workloads. │
│ license Manage software licenses, license servers, and licensing │
│ configurations. │
│ network Manage virtual networks, subnets, and network │
│ configurations for cloud infrastructure. │
│ notebook Manage Jupyter notebooks and computational notebooks for │
│ data science and research. │
│ profile Manage Vantage CLI profiles to work with different │
│ environments and configurations. │
│ storage Manage storage volumes, disks, and storage configurations │
│ for cloud infrastructure. │
│ support-ticket Manage support tickets │
╰──────────────────────────────────────────────────────────────────────────────╯
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
App Management
- 🔹 app
- list
- deployment
Usage: vantage app [OPTIONS] COMMAND [ARGS]...
Manage applications
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List available applications │
│ deployment Create and manage application deployments on Vantage compute │
│ clusters. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage app list [OPTIONS]
List available applications
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 deployment
- list
- get
- delete
Usage: vantage app deployment [OPTIONS] COMMAND [ARGS]...
Create and manage application deployments on Vantage compute clusters.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List all active deployments from │
│ ~/.vantage-cli/deployments.yaml. │
│ get Get detailed information about a specific deployment. │
│ delete Delete a deployment and clean up associated resources │
│ (multipass instances, etc). │
│ cleanup-orphans Find and clean up deployments whose clusters no longer │
│ exist. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage app deployment list [OPTIONS]
List all active deployments from ~/.vantage-cli/deployments.yaml.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cloud TEXT Filter deployments by cloud type (e.g., localhost, │
│ aws, gcp) │
│ --status TEXT Filter deployments by status (e.g., active, │
│ inactive) │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage app deployment get [OPTIONS] DEPLOYMENT_ID
Get detailed information about a specific deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id TEXT ID or name of the 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage app deployment delete [OPTIONS]
DEPLOYMENT_ID
Delete a deployment and clean up associated resources (multipass instances,
etc).
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id TEXT ID or name of the 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Cloud Management
- 🔹 cloud
- get
- list
- credential
Usage: vantage cloud [OPTIONS] COMMAND [ARGS]...
Manage cloud provider configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ get Get detailed information about a specific cloud provider. │
│ list List all available cloud providers. │
│ credential Manage cloud provider credentials. │
│ cudo-compute Cudo Compute cloud provider commands │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud get [OPTIONS] CLOUD_NAME
Get detailed information about a specific cloud provider.
Displays comprehensive information about a cloud provider including its
Vantage provider label, supported substrates, and configuration details.
Args: ctx: Typer context containing CLI configuration cloud_name: Name
of the cloud provider to retrieve
Examples: Get AWS cloud details: $ vantage cloud get aws
Get localhost cloud details: $ vantage cloud get localhost
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cloud_name TEXT Name of the cloud provider (e.g., 'aws', │
│ 'localhost', 'gcp') │
│ [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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud list [OPTIONS]
List all available cloud providers.
Displays all cloud providers configured in the system, including their Vantage
provider labels and supported substrates (infrastructure types).
Examples: List all clouds: $ vantage cloud list
Using the alias: $ vantage clouds
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 credential
- create
- delete
- get
- list
- update
Usage: vantage cloud credential [OPTIONS] COMMAND [ARGS]...
Manage cloud provider credentials.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new cloud provider credential. │
│ delete Delete a cloud provider credential. │
│ get Get detailed information about a specific cloud credential. │
│ list List all cloud provider credentials. │
│ update Update an existing cloud credential. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud credential create [OPTIONS] NAME
Create a new cloud provider credential.
Creates and stores a new credential for a cloud provider. Credentials can be
provided via a JSON file or as a JSON string.
Args: ctx: Typer context containing CLI configuration name:
Human-readable name for the credential cloud_name: Name of the cloud
provider credentials_file: Path to JSON file with credential data
credentials_json: JSON string with credential data
Examples: Create AWS credential from file: $ vantage cloud credential
create "AWS Prod" --cloud aws --file aws-creds.json
Create GCP credential from JSON: $ vantage cloud credential create "GCP
Dev" --cloud gcp --credentials-json '{"project_id": "my-project"}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Name for the credential (e.g., 'AWS Production') │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cloud -c TEXT Cloud provider name (e.g., 'aws', │
│ 'gcp', 'azure') │
│ [required] │
│ --file -f TEXT Path to JSON file containing credential │
│ data │
│ --credentials-json TEXT JSON string containing credential data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud credential delete [OPTIONS]
CREDENTIAL_ID
Delete a cloud provider credential.
Permanently removes a credential from the system. This action cannot be
undone.
Args: ctx: Typer context containing CLI configuration credential_id:
ID of the credential to delete force: Skip confirmation prompt
Examples: Delete credential with confirmation: $ vantage cloud
credential delete abc12345
Delete without confirmation: $ vantage cloud credential delete abc12345
--force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * credential_id TEXT ID of the credential 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud credential get [OPTIONS] CREDENTIAL_ID
Get detailed information about a specific cloud credential.
Displays comprehensive information about a cloud credential including its
associated cloud, type, and metadata. Use --show-secrets to display sensitive
credential data.
Args: ctx: Typer context containing CLI configuration credential_id:
ID of the credential to retrieve show_secrets: Whether to display
sensitive credential data
Examples: Get credential details: $ vantage cloud credential get
abc12345
Get credential with secrets: $ vantage cloud credential get abc12345
--show-secrets
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * credential_id TEXT ID of the credential to retrieve [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --show-secrets -s Show sensitive credential data (use with │
│ caution) │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud credential list [OPTIONS]
List all cloud provider credentials.
Displays all stored credentials for cloud providers. Optionally filter by
cloud name to see credentials for a specific cloud.
Examples: List all credentials: $ vantage cloud credential list
List credentials for AWS: $ vantage cloud credential list --cloud aws
Using the alias: $ vantage cloud credentials
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cloud -c TEXT Filter credentials by cloud name │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cloud credential update [OPTIONS]
CREDENTIAL_ID
Update an existing cloud credential.
Updates a credential's name, credentials data, or default status. When setting
a credential as default, all other credentials of the same cloud type will
have their default status set to False.
Args: ctx: Typer context containing CLI configuration credential_id:
ID of the credential to update name: New name for the credential
credentials_json: New credentials data as JSON string credentials_file:
Path to JSON file with new credentials data set_default: Set as default
credential for this cloud type
Examples: Update credential name: $ vantage cloud credential update
abc12345 --name "Production AWS"
Set as default credential: $ vantage cloud credential update abc12345
--default
Update credentials data: $ vantage cloud credential update abc12345
--credentials-json '{"api_key": "new-key"}'
Update from file: $ vantage cloud credential update abc12345 --file
credentials.json
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * credential_id TEXT ID of the credential to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the credential │
│ --credentials-json -c TEXT New credentials data as JSON string │
│ --file -f TEXT Path to JSON file containing new │
│ credentials data │
│ --default -d Set this credential as the default for its │
│ cloud 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Cluster Management
- 🔹 cluster
- create
- delete
- get
- list
- federation
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 and optionally cleanup associated app │
│ deployments. │
│ get Get details of a specific Vantage cluster. │
│ list List all Vantage clusters. │
│ federation Manage Vantage compute federations for distributed workloads. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster create [OPTIONS] CLUSTER_NAME
Create a new Vantage cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT Name of the cluster to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cloud -c [maas|localhost|aws|gcp Cloud to use for │
│ |azure|on-premises|k8s| deployment. │
│ cudo-compute] [required] │
│ --config-file FILE Path to configuration │
│ file for cluster │
│ creation. │
│ --app TEXT Deploy an application │
│ after cluster creation. │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster delete [OPTIONS] CLUSTER_NAME
Delete a Vantage cluster and optionally cleanup associated app deployments.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT Name of the cluster to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt │
│ --app TEXT Cleanup the specified app deployment (e.g., │
│ slurm-lxd, slurm-multipass, slurm-microk8s) │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster get [OPTIONS] CLUSTER_NAME
Get details of a specific Vantage cluster.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster list [OPTIONS]
List all Vantage clusters.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 federation
- create
- delete
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster federation create
[OPTIONS] NAME
Create a new Vantage federation.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster federation delete
[OPTIONS] NAME
Delete a Vantage federation.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster federation get [OPTIONS] NAME
Get details of a specific Vantage federation.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster federation list [OPTIONS]
List all Vantage federations.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage cluster federation update
[OPTIONS] NAME
Update a Vantage federation.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Job Management
- 🔹 job
- script
- submission
- template
Usage: vantage job [OPTIONS] COMMAND [ARGS]...
Manage computational jobs, scripts, submissions, and job templates for HPC
workloads.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ script Manage job scripts for computational workloads and batch │
│ processing. │
│ submission Manage job submissions │
│ template Manage job templates │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 script
- create
- delete
- get
- list
- update
Usage: vantage job script [OPTIONS] COMMAND [ARGS]...
Manage job scripts for computational workloads and batch processing.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new job script. │
│ delete Delete a job script. │
│ get Get details of a specific job script. │
│ list List all job scripts. │
│ update Update a job script. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job script create [OPTIONS] NAME
Create a new job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Name of the job script to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --type -t TEXT Script type (bash, python, sbatch) │
│ [default: bash] │
│ --description -d TEXT Description of the job script │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job script delete [OPTIONS] SCRIPT_ID
Delete a job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * script_id INTEGER ID of the job script to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job script get [OPTIONS] SCRIPT_ID
Get details of a specific job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * script_id INTEGER ID of the job script 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job script list [OPTIONS]
List all job scripts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --from-template-id INTEGER Filter by job script │
│ template ID │
│ --search -s TEXT Search job scripts │
│ --sort-field TEXT Field to sort by │
│ --sort-ascending --sort-descending Sort order │
│ [default: │
│ sort-ascending] │
│ --user-only Show only user's job │
│ scripts │
│ --include-archived Include archived job │
│ scripts │
│ --limit -l INTEGER Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o INTEGER Number of results to │
│ skip │
│ [default: 0] │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job script update [OPTIONS] SCRIPT_ID
Update a job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * script_id INTEGER ID of the job script to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the job script │
│ --description -d TEXT New description for the job │
│ script │
│ --archived --not-archived Archive or unarchive the job │
│ script │
│ --json-file -f PATH Path to JSON file containing │
│ update data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 submission
- create
- delete
- get
- list
- update
Usage: vantage job submission [OPTIONS] COMMAND [ARGS]...
Manage job submissions
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new job submission │
│ delete Delete a job submission │
│ get Get details of a specific job submission │
│ list List all job submissions │
│ update Update a job submission │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job submission create [OPTIONS]
Create a new job submission
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --name -n TEXT Name of the job submission │
│ [required] │
│ * --job-script-id INTEGER ID of the job script to use │
│ [required] │
│ --description -d TEXT Description of the job submission │
│ --client-id TEXT Client ID of the cluster where │
│ job should execute │
│ --execution-directory TEXT Directory on cluster where job │
│ should execute │
│ --slurm-job-id INTEGER SLURM job ID (if already known) │
│ --sbatch-arg TEXT SBATCH arguments (can be used │
│ multiple times) │
│ --json-file -f PATH Path to JSON file containing job │
│ submission data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job submission delete [OPTIONS]
SUBMISSION_ID
Delete a job submission
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * submission_id INTEGER ID of the job submission to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job submission get [OPTIONS] SUBMISSION_ID
Get details of a specific job submission
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * submission_id INTEGER ID of the job submission 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job submission list [OPTIONS]
List all job submissions
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --slurm-job-ids TEXT Comma-separated list │
│ of SLURM job IDs to │
│ filter by │
│ --submit-status TEXT Filter by submission │
│ status (CREATED, │
│ SUBMITTED, REJECTED, │
│ DONE, ABORTED) │
│ --from-script-id INTEGER Filter by job script │
│ ID │
│ --search -s TEXT Search job submissions │
│ --sort-field TEXT Field to sort by │
│ --sort-ascending --sort-descending Sort order │
│ [default: │
│ sort-ascending] │
│ --user-only Show only user's job │
│ submissions │
│ --include-archived Include archived job │
│ submissions │
│ --limit -l INTEGER Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o INTEGER Number of results to │
│ skip │
│ [default: 0] │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job submission update [OPTIONS]
SUBMISSION_ID
Update a job submission
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * submission_id INTEGER ID of the job submission to update │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the job submission │
│ --description -d TEXT New description for the job submission │
│ --execution-directory TEXT New execution directory │
│ --status TEXT New status (CREATED, SUBMITTED, │
│ REJECTED, DONE, ABORTED) │
│ --json-file -f PATH Path to JSON file containing update │
│ data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 template
- create
- delete
- get
- list
- update
Usage: vantage job template [OPTIONS] COMMAND [ARGS]...
Manage job templates
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new job template │
│ delete Delete a job template │
│ get Get details of a specific job template │
│ list List all job templates │
│ update Update a job template │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job template create [OPTIONS]
Create a new job template
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --name -n TEXT Name of the job template [required] │
│ --description -d TEXT Description of the job template │
│ --identifier -i TEXT Human-friendly identifier for the job │
│ template │
│ --json-file -f PATH Path to JSON file containing job template │
│ data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job template delete [OPTIONS] TEMPLATE_ID
Delete a job template
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * template_id TEXT ID or identifier of the job template to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job template get [OPTIONS] TEMPLATE_ID
Get details of a specific job template
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * template_id TEXT ID or identifier of the job template 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job template list [OPTIONS]
List all job templates
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search job templates │
│ --sort-field TEXT Field to sort by │
│ --sort-ascending --sort-descending Sort order │
│ [default: │
│ sort-ascending] │
│ --user-only Show only user's job │
│ templates │
│ --include-archived Include archived job │
│ templates │
│ --limit -l INTEGER Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o INTEGER Number of results to │
│ skip │
│ [default: 0] │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage job template update [OPTIONS] TEMPLATE_ID
Update a job template
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * template_id TEXT ID or identifier of the job template to update │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the job template │
│ --description -d TEXT New description for the job │
│ template │
│ --identifier -i TEXT New identifier for the job │
│ template │
│ --archived --not-archived Archive or unarchive the job │
│ template │
│ --json-file -f PATH Path to JSON file containing │
│ update data │
│ --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
- 🔹 license
- booking
- server
- product
- configuration
- deployment
- feature
Usage: vantage license [OPTIONS] COMMAND [ARGS]...
Manage software licenses, license servers, and licensing configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ booking License booking management 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. │
│ feature Feature management commands │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 booking
- list
- get
- create
- delete
Usage: vantage license booking [OPTIONS] COMMAND [ARGS]...
License booking management commands
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List all license bookings │
│ get Get a specific license booking by ID │
│ create Create a new license booking │
│ delete Delete a license booking │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license booking list [OPTIONS]
List all license bookings
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search bookings by name or id │
│ --sort TEXT Sort by field (name, id, created_at) │
│ --limit -l INTEGER Maximum number of bookings to return │
│ --offset -o INTEGER Number of bookings to skip │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license booking get [OPTIONS] BOOKING_ID
Get a specific license booking by ID
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * booking_id TEXT Booking ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license booking create [OPTIONS]
Create a new license booking
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT Booking name │
│ --description -d TEXT Booking description │
│ --json-file -f PATH JSON file with booking data │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license booking delete [OPTIONS] BOOKING_ID
Delete a license booking
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * booking_id TEXT Booking ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 server
- create
- delete
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license server create [OPTIONS] NAME
Create a new license server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Name of the license server to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --host -h TEXT Server hostname or IP address [required] │
│ --port -p INTEGER Server port number [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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license server delete [OPTIONS] SERVER_ID
Delete a license server.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license server get [OPTIONS] SERVER_ID
Get details of a specific license server.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license server list [OPTIONS]
List all license servers.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search term for filtering servers │
│ --sort TEXT Sort field for ordering results │
│ --limit -l INTEGER Maximum number of results to return │
│ --offset -o INTEGER Number of results to skip │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license server update [OPTIONS] SERVER_ID
Update an existing license server.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 product
- create
- delete
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license product create [OPTIONS] NAME
Create a new license product.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Name of the license product to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --version -v TEXT Product version [required] │
│ --description -d TEXT Description of the license product │
│ --type -t TEXT Type of license (concurrent, node-locked, │
│ etc.) │
│ [default: concurrent] │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license product delete [OPTIONS] PRODUCT_ID
Delete a license product.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license product get [OPTIONS] PRODUCT_ID
Get details of a specific license product.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license product list [OPTIONS]
List all license products.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search term for filtering products │
│ --sort TEXT Sort field for ordering results │
│ --limit -l INTEGER Maximum number of results to return │
│ --offset -o INTEGER Number of results to skip │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license product update [OPTIONS] PRODUCT_ID
Update an existing license product.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 configuration
- create
- delete
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license configuration create
[OPTIONS] NAME
Create a new license configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Name of the license configuration to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --type -t TEXT Type of license (concurrent, node-locked, │
│ etc.) │
│ [required] │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license configuration delete
[OPTIONS] CONFIG_ID
Delete a license configuration.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license configuration get
[OPTIONS] CONFIG_ID
Get details of a specific license configuration.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license configuration list
[OPTIONS]
List all license configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search configurations by name or id │
│ --sort TEXT Sort by field (name, id, created_at) │
│ --limit -l INTEGER Maximum number of configurations to return │
│ --offset -o INTEGER Number of configurations to skip │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license configuration update
[OPTIONS] CONFIG_ID
Update an existing license configuration.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 deployment
- create
- delete
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license deployment create
[OPTIONS] NAME
Create a new license deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Name of the license deployment to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --product-id -p TEXT Product ID for the deployment [required] │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license deployment delete
[OPTIONS] DEPLOYMENT_ID
Delete a license deployment.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license deployment get [OPTIONS]
DEPLOYMENT_ID
Get details of a specific license deployment.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license deployment list [OPTIONS]
List all license deployments.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license deployment update
[OPTIONS] DEPLOYMENT_ID
Update a license deployment.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 feature
- list
- get
- create
- update
- delete
Usage: vantage license feature [OPTIONS] COMMAND [ARGS]...
Feature management commands
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List all license features. │
│ get Get details of a specific license feature. │
│ create Create a new license feature. │
│ update Update an existing license feature. │
│ delete Delete a license feature. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license feature list [OPTIONS]
List all license features.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search features by name or id │
│ --sort TEXT Sort by field (name, id, created_at) │
│ --limit -l INTEGER Maximum number of features to return │
│ --offset -o INTEGER Number of features to skip │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license feature get [OPTIONS] FEATURE_ID
Get details of a specific license feature.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * feature_id TEXT ID of the license feature 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license feature create [OPTIONS]
Create a new license feature.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT Feature name │
│ --description -d TEXT Feature description │
│ --json-file -f PATH JSON file with feature data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license feature update [OPTIONS] FEATURE_ID
Update an existing license feature.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * feature_id TEXT ID of the license feature to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New feature name │
│ --description -d TEXT New feature description │
│ --json-file -f PATH JSON file with feature data │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage license feature delete [OPTIONS] FEATURE_ID
Delete a license feature.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * feature_id TEXT ID of the license feature 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Network Management
- 🔹 network
- attach
- create
- delete
- detach
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network attach [OPTIONS] NETWORK_ID
INSTANCE_ID
Attach a network interface to an instance.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network create [OPTIONS] NAME
Create a new virtual network.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network delete [OPTIONS] NETWORK_ID
Delete a virtual network.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network detach [OPTIONS] NETWORK_ID
INSTANCE_ID
Detach a network interface from an instance.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network get [OPTIONS] NETWORK_ID
Get details of a specific virtual network.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network list [OPTIONS]
List all virtual networks.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage network update [OPTIONS] NETWORK_ID
Update a virtual network configuration.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Notebook Management
- 🔹 notebook
- create
- delete
- get
- list
- update
Usage: vantage notebook [OPTIONS] COMMAND [ARGS]...
Manage Jupyter notebooks and computational notebooks for data science and
research.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new Jupyter notebook server on a cluster. │
│ delete Delete notebook server. │
│ get Get notebook server details. │
│ list List notebook servers. │
│ update Update a Jupyter notebook configuration. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage notebook create [OPTIONS]
Create a new Jupyter notebook server on a cluster.
Creates a notebook server using JupyterHub API with resource specifications.
If username is not provided, it will use the authenticated user's email.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c TEXT Name of the cluster [required] │
│ --username -u TEXT JupyterHub username │
│ --name -n TEXT Named server (optional) │
│ --partition TEXT SLURM partition to use │
│ --cpu-cores INTEGER Number of CPU cores │
│ --mem TEXT Memory (e.g., 4G, 8G) │
│ --gpu INTEGER Number of GPUs │
│ --node TEXT Specific node to use │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage notebook delete [OPTIONS] NAME
Delete notebook server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Notebook server name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cluster -c TEXT Cluster name │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage notebook get [OPTIONS] NAME
Get notebook server details.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT Notebook server name [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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage notebook list [OPTIONS]
List notebook servers.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cluster -c TEXT Filter by cluster name │
│ --status -s TEXT Filter by notebook status │
│ --kernel -k TEXT Filter by kernel type │
│ --limit -l INTEGER Maximum number of notebooks to return │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage notebook update [OPTIONS] NOTEBOOK_ID
Update a Jupyter notebook configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * notebook_id TEXT ID of the notebook to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the notebook │
│ --description -d TEXT New description │
│ --kernel -k TEXT New kernel 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Profile Management
- 🔹 profile
- create
- delete
- get
- list
- use
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage profile create [OPTIONS] PROFILE_NAME
Create a new Vantage CLI profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name TEXT Name of the profile to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --vantage-url TEXT Vantage Platform URL │
│ [default: https://app.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 │
│ --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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage profile delete [OPTIONS] PROFILE_NAME
Delete a Vantage CLI profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name TEXT Name of the profile 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage profile get [OPTIONS] PROFILE_NAME
Get details of a specific Vantage CLI profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name TEXT Name of the profile 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage profile list [OPTIONS]
List all Vantage CLI profiles.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage profile use [OPTIONS] PROFILE_NAME
Activate a profile for use in the current session.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name TEXT Name of the profile to activate [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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Storage Management
- 🔹 storage
- attach
- create
- delete
- detach
- get
- list
- update
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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage attach [OPTIONS] STORAGE_ID
INSTANCE_ID
Attach a storage volume to an instance.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage create [OPTIONS] NAME
Create a new storage volume.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage delete [OPTIONS] STORAGE_ID
Delete a storage volume.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage detach [OPTIONS] STORAGE_ID
Detach a storage volume from an instance.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage get [OPTIONS] STORAGE_ID
Get details of a specific storage volume.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage list [OPTIONS]
List all storage volumes.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage storage update [OPTIONS] STORAGE_ID
Update a storage volume configuration.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
Configuration Management
- 🔹 config
- clear
Usage: vantage config [OPTIONS] COMMAND [ARGS]...
Manage Vantage CLI configuration and settings.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ clear Clear all user tokens and configuration. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: vantage config clear [OPTIONS]
Clear all user tokens and configuration.
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯