VMware vRA CLI Reference Guide
This comprehensive reference guide covers all available commands, options, and usage patterns for the VMware vRA CLI tool.
Global Options
All commands support these global options:
Option | Description | Default |
---|---|---|
--verbose , -v |
Enable verbose output with HTTP request/response details | False |
--format |
Output format: table , json , yaml |
table |
--version |
Show CLI version and exit | - |
--help |
Show help message and exit | - |
Global Option Examples
# Enable verbose logging for troubleshooting
vmware-vra --verbose catalog list
# Get JSON output instead of table
vmware-vra --format json deployment list
# Show version information
vmware-vra --version
Authentication Commands (auth
)
Manage authentication tokens and credentials.
auth login
Authenticate to vRA using username and password.
Syntax:
Options:
| Option | Type | Description | Required |
|--------|------|-------------|----------|
| --username
| TEXT | Username for vRA access | Yes |
| --password
| TEXT | Password for vRA access | Yes |
| --url
| TEXT | vRA server URL | No |
| --tenant
| TEXT | vRA tenant | No |
| --domain
| TEXT | Domain for multiple identity sources | No |
Prompted if not provided
*Uses configured default if available
Examples:
# Interactive login (prompts for credentials)
vmware-vra auth login
# Login with specific parameters
vmware-vra auth login \
--username john.doe@company.com \
--url https://vra.company.com \
--tenant company.local
# Login with specific domain for multiple identity sources
vmware-vra auth login \
--username administrator \
--domain vsphere.local \
--url https://vra.company.com
Sample Output:
โ
Authentication successful!
๐ Tokens saved securely
๐พ Configuration saved: https://vra.company.com
๐ข Tenant: company.local
๐ Domain: vsphere.local
auth logout
Clear stored authentication tokens.
Syntax:
Example:
Sample Output:
auth status
Check current authentication status.
Syntax:
Example:
Sample Outputs:
# Fully authenticated
โ
Authenticated (Access token available)
๐ Refresh token available for automatic renewal
# Refresh token only
โ ๏ธ Only refresh token available - will obtain new access token on next use
# Not authenticated
โ Not authenticated
auth refresh
Manually refresh the access token.
Syntax:
Example:
Sample Output:
Configuration Commands (config
)
Manage CLI configuration settings.
config show
Display current configuration values.
Syntax:
Example:
Sample Output (Table Format):
VMware vRA CLI Configuration
โโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Setting โ Value โ Source โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ Api Url โ https://vra.company.com โ Config file โ
โ Tenant โ company.local โ Config file โ
โ Domain โ vsphere.local โ Config file โ
โ Verify Ssl โ True โ Default โ
โ Timeout โ 30 โ Default โ
โโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Config file: /Users/username/.config/vmware-vra-cli/config.json
config set
Set a configuration value.
Syntax:
Available Keys:
- api_url
: vRA server URL
- tenant
: vRA tenant identifier
- domain
: Authentication domain
- verify_ssl
: SSL verification (true/false)
- timeout
: Request timeout in seconds
Examples:
# Set vRA server URL
vmware-vra config set api_url https://vra.company.com
# Set tenant
vmware-vra config set tenant company.local
# Disable SSL verification (not recommended for production)
vmware-vra config set verify_ssl false
# Set timeout
vmware-vra config set timeout 60
Sample Output:
โ
Configuration updated: api_url = https://vra.company.com
Saved to: /Users/username/.config/vmware-vra-cli/config.json
config reset
Reset configuration to defaults.
Syntax:
Options:
| Option | Description |
|--------|-------------|
| --confirm
| Skip confirmation prompt |
Examples:
# Reset with confirmation prompt
vmware-vra config reset
# Reset without confirmation
vmware-vra config reset --confirm
config edit
Edit configuration file in default editor.
Syntax:
Example:
Service Catalog Commands (catalog
)
Manage catalog items and requests.
catalog list
List available catalog items.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --project
| TEXT | None | Filter by project ID |
| --page-size
| INT | 100 | Items per page (max: 2000) |
| --first-page-only
| FLAG | False | Fetch only first page |
Examples:
# List all catalog items
vmware-vra catalog list
# List items for specific project
vmware-vra catalog list --project dev-project-123
# List first page only (faster for large catalogs)
vmware-vra catalog list --first-page-only
# Get JSON output
vmware-vra --format json catalog list
Sample Output (Table):
Service Catalog Items (156 items)
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโณโโโโโโโโโโโโ
โ ID โ Name โ Type โ Status โ Version โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ blueprint-ubuntu-server-01 โ Ubuntu Server Template โ blueprint โ PUBLISHED โ 1.2 โ
โ blueprint-windows-server-2019 โ Windows Server 2019 โ blueprint โ PUBLISHED โ 2.1 โ
โ workflow-create-user-account โ Create User Account โ workflow โ PUBLISHED โ 1.0 โ
โ blueprint-docker-container โ Docker Container โ blueprint โ PUBLISHED โ 3.0 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโดโโโโโโโโโโโโ
catalog show
Show details of a specific catalog item.
Syntax:
Examples:
# Show catalog item details
vmware-vra catalog show blueprint-ubuntu-server-01
# Get JSON output
vmware-vra --format json catalog show blueprint-ubuntu-server-01
Sample Output (Table):
Catalog Item: Ubuntu Server Template
โโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Property โ Value โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ ID โ blueprint-ubuntu-server-01 โ
โ Name โ Ubuntu Server Template โ
โ Type โ blueprint โ
โ Status โ PUBLISHED โ
โ Version โ 1.2 โ
โ Description โ Standard Ubuntu 20.04 server template with common configurations โ
โโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
catalog schema
Show request schema for a catalog item.
Syntax:
Examples:
# Show schema for catalog item
vmware-vra catalog schema blueprint-ubuntu-server-01
# Always outputs JSON regardless of --format setting
vmware-vra catalog schema blueprint-ubuntu-server-01
Sample Output:
{
"type": "object",
"properties": {
"hostname": {
"type": "string",
"title": "Hostname",
"description": "Server hostname"
},
"cpu": {
"type": "integer",
"title": "CPU Count",
"default": 2,
"minimum": 1,
"maximum": 8
},
"memory": {
"type": "string",
"title": "Memory Size",
"default": "4GB",
"enum": ["2GB", "4GB", "8GB", "16GB"]
}
},
"required": ["hostname"]
}
catalog request
Request a catalog item deployment.
Syntax:
Options:
| Option | Type | Description | Required |
|--------|------|-------------|----------|
| --inputs
| TEXT | Input parameters as JSON string | No |
| --inputs-file
| PATH | Input parameters from YAML/JSON file | No |
| --project
| TEXT | Project ID for the request | Yes |
| --reason
| TEXT | Reason for the request | No |
| --name
| TEXT | Deployment name | No |
Examples:
# Request with inline JSON inputs
vmware-vra catalog request blueprint-ubuntu-server-01 \
--inputs '{"hostname": "web-server-01", "cpu": 4, "memory": "8GB"}' \
--project dev-project-123 \
--reason "Development web server"
# Request with inputs from file
vmware-vra catalog request blueprint-ubuntu-server-01 \
--inputs-file server-config.yaml \
--project dev-project-123 \
--name "web-server-01"
# Simple request with minimal parameters
vmware-vra catalog request blueprint-ubuntu-server-01 \
--project dev-project-123
Sample inputs-file (server-config.yaml):
hostname: web-server-01
cpu: 4
memory: "8GB"
disk_size: "100GB"
network: "corporate-dmz"
install_packages:
- nginx
- docker
- git
Sample Output:
โ
Request submitted successfully!
Deployment ID: deployment-12345-abcdef
Request ID: request-67890-ghijkl
Deployment Commands (deployment
)
Manage and export deployments.
deployment list
List deployments.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --project
| TEXT | None | Filter by project ID |
| --status
| TEXT | None | Filter by status |
| --page-size
| INT | 100 | Items per page (max: 2000) |
| --first-page-only
| FLAG | False | Fetch only first page |
Examples:
# List all deployments
vmware-vra deployment list
# List deployments for specific project
vmware-vra deployment list --project dev-project-123
# List only successful deployments
vmware-vra deployment list --status CREATE_SUCCESSFUL
# First page only for large environments
vmware-vra deployment list --first-page-only
Sample Output:
Deployments (89 items)
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ ID โ Name โ Status โ Project โ Created โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ deployment-12345-abcdef โ web-server-01 โ CREATE_SUCCESSFUL โ dev-project-123 โ 2024-01-15T09:30:00.000Z โ
โ deployment-67890-ghijkl โ database-server-01 โ CREATE_SUCCESSFUL โ dev-project-123 โ 2024-01-15T10:15:00.000Z โ
โ deployment-13579-mnopqr โ load-balancer-01 โ CREATE_INPROGRESS โ prod-project-456 โ 2024-01-15T11:00:00.000Z โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
deployment show
Show deployment details.
Syntax:
Examples:
# Show deployment details
vmware-vra deployment show deployment-12345-abcdef
# Get YAML output
vmware-vra --format yaml deployment show deployment-12345-abcdef
Sample Output (Table):
Deployment: web-server-01
โโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Property โ Value โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ id โ deployment-12345-abcdef โ
โ name โ web-server-01 โ
โ status โ CREATE_SUCCESSFUL โ
โ projectId โ dev-project-123 โ
โ catalogItemId โ blueprint-ubuntu-server-01 โ
โ createdAt โ 2024-01-15T09:30:00.000Z โ
โ completedAt โ 2024-01-15T09:45:00.000Z โ
โ inputs โ {"hostname": "web-server-01", "cpu": 4, "memory": "8GB"} โ
โโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
deployment delete
Delete a deployment.
Syntax:
Options:
| Option | Description |
|--------|-------------|
| --confirm
| Skip confirmation prompt |
Examples:
# Delete with confirmation prompt
vmware-vra deployment delete deployment-12345-abcdef
# Delete without confirmation
vmware-vra deployment delete deployment-12345-abcdef --confirm
Sample Output:
deployment resources
Show deployment resources.
Syntax:
Examples:
# Show deployment resources
vmware-vra deployment resources deployment-12345-abcdef
# Get JSON output
vmware-vra --format json deployment resources deployment-12345-abcdef
Sample Output:
Resources for Deployment deployment-12345-abcdef
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโ
โ ID โ Name โ Type โ Status โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ vm-12345-abcdef โ web-server-01 โ Cloud.vSphere.Machine โ SUCCESS โ
โ disk-67890-ghijkl โ web-server-01-disk1 โ Cloud.vSphere.Disk โ SUCCESS โ
โ nic-13579-mnopqr โ web-server-01-nic0 โ Cloud.vSphere.Network โ SUCCESS โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโ
deployment export-all
Export all deployments grouped by catalog item.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --project
| TEXT | None | Filter deployments by project ID |
| --output-dir
| TEXT | ./exports
| Directory to save export files |
| --include-resources
| FLAG | False | Include resource details (slower) |
| --no-unsynced
| FLAG | False | Exclude unsynced deployments |
For comprehensive details and examples, see the Deployment Export Guide.
Quick Examples:
# Basic export
vmware-vra deployment export-all
# Export with resource details
vmware-vra deployment export-all --include-resources
# Export specific project
vmware-vra deployment export-all --project dev-project-123
# Export to custom directory
vmware-vra deployment export-all --output-dir /backup/vra-exports
Tag Management Commands (tag
)
Manage tags and resource tagging.
tag list
List available tags.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --search
| TEXT | None | Search term to filter tags |
| --page-size
| INT | 100 | Items per page (max: 2000) |
| --first-page-only
| FLAG | False | Fetch only first page |
Examples:
# List all tags
vmware-vra tag list
# Search for specific tags
vmware-vra tag list --search environment
# First page only
vmware-vra tag list --first-page-only
tag show
Show details of a specific tag.
Syntax:
Example:
tag create
Create a new tag.
Syntax:
Options:
| Option | Type | Description |
|--------|------|-------------|
| --value
| TEXT | Tag value (optional) |
| --description
| TEXT | Tag description (optional) |
Examples:
# Create simple tag
vmware-vra tag create environment --value production
# Create tag with description
vmware-vra tag create cost-center \
--value "IT-Infrastructure" \
--description "Cost center for IT infrastructure resources"
tag update
Update an existing tag.
Syntax:
Options:
| Option | Type | Description |
|--------|------|-------------|
| --key
| TEXT | New tag key |
| --value
| TEXT | New tag value |
| --description
| TEXT | New tag description |
Example:
vmware-vra tag update tag-12345-abcdef \
--value "development" \
--description "Development environment resources"
tag delete
Delete a tag.
Syntax:
Options:
| Option | Description |
|--------|-------------|
| --confirm
| Skip confirmation prompt |
Example:
tag assign
Assign a tag to a resource.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --resource-type
| CHOICE | deployment
| Resource type: deployment
or catalog-item
|
Examples:
# Assign tag to deployment
vmware-vra tag assign deployment-12345-abcdef tag-67890-ghijkl
# Assign tag to catalog item
vmware-vra tag assign blueprint-ubuntu-server-01 tag-environment-prod \
--resource-type catalog-item
tag remove
Remove a tag from a resource.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --resource-type
| CHOICE | deployment
| Resource type: deployment
or catalog-item
|
| --confirm
| FLAG | False | Skip confirmation prompt |
Example:
tag resource-tags
Show tags assigned to a resource.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --resource-type
| CHOICE | deployment
| Resource type: deployment
or catalog-item
|
Example:
Report Commands (report
)
Generate analytics and reports.
report activity-timeline
Generate deployment activity timeline.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --project
| TEXT | None | Filter by project ID |
| --days-back
| INT | 30 | Days back for timeline |
| --group-by
| CHOICE | day
| Group by: day
, week
, month
, year
|
| --statuses
| TEXT | All | Comma-separated status list |
Examples:
# 30-day activity timeline
vmware-vra report activity-timeline
# Weekly activity for 90 days
vmware-vra report activity-timeline --days-back 90 --group-by week
# Only successful deployments
vmware-vra report activity-timeline \
--statuses "CREATE_SUCCESSFUL,UPDATE_SUCCESSFUL"
report catalog-usage
Generate catalog usage report.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --project
| TEXT | None | Filter by project ID |
| --include-zero
| FLAG | False | Include items with zero deployments |
| --sort-by
| CHOICE | deployments
| Sort by: deployments
, resources
, name
|
| --detailed-resources
| FLAG | False | Fetch exact resource counts |
Examples:
# Basic usage report
vmware-vra report catalog-usage
# Include all catalog items
vmware-vra report catalog-usage --include-zero --sort-by name
# Detailed resource counting
vmware-vra report catalog-usage --detailed-resources
report unsync
Generate unsynced deployments report.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --project
| TEXT | None | Filter by project ID |
| --detailed-resources
| FLAG | False | Fetch exact resource counts |
| --show-details
| FLAG | False | Show detailed analysis |
| --reason-filter
| TEXT | None | Filter by specific reason |
Examples:
# Basic unsync report
vmware-vra report unsync
# Detailed analysis
vmware-vra report unsync --show-details
# Filter by specific reason
vmware-vra report unsync --reason-filter catalog_item_deleted
Workflow Commands (workflow
)
Manage and execute workflows.
workflow list
List available workflows.
Syntax:
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| --page-size
| INT | 100 | Items per page (max: 2000) |
| --first-page-only
| FLAG | False | Fetch only first page |
Example:
workflow run
Execute a workflow.
Syntax:
Options:
| Option | Type | Description |
|--------|------|-------------|
| --inputs
| TEXT | Input parameters as JSON string |
| --inputs-file
| PATH | Input parameters from YAML/JSON file |
Examples:
# Run workflow with inline inputs
vmware-vra workflow run create-user-workflow \
--inputs '{"username": "john.doe", "department": "IT"}'
# Run workflow with inputs file
vmware-vra workflow run create-user-workflow \
--inputs-file user-inputs.yaml
Output Formats
All list and show commands support three output formats:
Table Format (Default)
Human-readable tables with aligned columns and formatting.
JSON Format
Machine-readable JSON for scripting and automation.
YAML Format
Human-readable YAML format.
Environment Variables
Override configuration using environment variables:
Variable | Description | Example |
---|---|---|
VRA_URL |
vRA server URL | https://vra.company.com |
VRA_TENANT |
vRA tenant | company.local |
VRA_DOMAIN |
Authentication domain | vsphere.local |
VRA_VERIFY_SSL |
SSL verification | true or false |
VRA_TIMEOUT |
Request timeout | 60 |
Example:
export VRA_URL="https://vra-dev.company.com"
export VRA_TENANT="dev.company.local"
vmware-vra catalog list
Common Usage Patterns
Automation Scripts
#!/bin/bash
set -e
# Authenticate
vmware-vra auth login \
--username "$VRA_USERNAME" \
--password "$VRA_PASSWORD" \
--url "$VRA_URL"
# Deploy infrastructure
DEPLOYMENT_ID=$(vmware-vra catalog request blueprint-web-app \
--project "$PROJECT_ID" \
--inputs-file webapp-config.yaml \
--format json | jq -r '.deploymentId')
echo "Deployment created: $DEPLOYMENT_ID"
# Wait for deployment completion (custom logic)
while true; do
STATUS=$(vmware-vra deployment show "$DEPLOYMENT_ID" --format json | jq -r '.status')
if [[ "$STATUS" == "CREATE_SUCCESSFUL" ]]; then
echo "Deployment completed successfully"
break
elif [[ "$STATUS" == "CREATE_FAILED" ]]; then
echo "Deployment failed"
exit 1
fi
sleep 30
done
Batch Operations
#!/bin/bash
# Tag multiple deployments
DEPLOYMENTS=$(vmware-vra deployment list --format json | jq -r '.[].id')
TAG_ID="tag-environment-prod"
for deployment in $DEPLOYMENTS; do
echo "Tagging deployment: $deployment"
vmware-vra tag assign "$deployment" "$TAG_ID" --confirm
done
Data Export Pipeline
#!/bin/bash
# Complete data export and analysis
EXPORT_DIR="/backup/vra/$(date +%Y-%m-%d)"
mkdir -p "$EXPORT_DIR"
# Export deployments
vmware-vra deployment export-all \
--output-dir "$EXPORT_DIR" \
--include-resources
# Generate reports
vmware-vra report catalog-usage --format json > "$EXPORT_DIR/catalog-usage.json"
vmware-vra report unsync --format json > "$EXPORT_DIR/unsync-report.json"
vmware-vra report activity-timeline --days-back 90 --format json > "$EXPORT_DIR/activity-timeline.json"
# Create summary
echo "Export completed: $EXPORT_DIR"
echo "Files created:"
ls -la "$EXPORT_DIR"
This comprehensive CLI reference provides complete coverage of all available commands, options, and usage patterns for the VMware vRA CLI tool.