# Exoscale Documentation — CLI > Manage cloud infrastructure with the Exoscale CLI: deploy, monitor, and automate resources with the exo command-line tool. --- url: https://community.exoscale.com/reference/cli/ --- # CLI - [Exocale CLI](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your infrastructure easily with the exo cli. --- url: https://community.exoscale.com/reference/cli/exo/ --- # Command Reference ``` exo [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--help, -h` | help for exo | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo config](https://community.exoscale.com/reference/cli/exo/config/index.md) - Exoscale CLI configuration management * [exo dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dedicated-inference](https://community.exoscale.com/reference/cli/exo/dedicated-inference/index.md) - Dedicated AI inference management * [exo dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records * [exo iam](https://community.exoscale.com/reference/cli/exo/iam/index.md) - Identity and Access Management * [exo kms](https://community.exoscale.com/reference/cli/exo/kms/index.md) - Key management * [exo limits](https://community.exoscale.com/reference/cli/exo/limits/index.md) - Current account limits * [exo networking](https://community.exoscale.com/reference/cli/exo/networking/index.md) - Networking services management * [exo status](https://community.exoscale.com/reference/cli/exo/status/index.md) - Exoscale status * [exo storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management * [exo version](https://community.exoscale.com/reference/cli/exo/version/index.md) - Print the version of exo * [exo zone](https://community.exoscale.com/reference/cli/exo/zone/index.md) - List all available zones --- url: https://community.exoscale.com/reference/cli/exo/compute/ --- # exo compute ``` exo compute [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for compute | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo compute anti-affinity-group](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/index.md) - Anti-Affinity Groups management * [exo compute block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management * [exo compute deploy-target](https://community.exoscale.com/reference/cli/exo/compute/deploy-target/index.md) - Compute instance Deploy Targets management * [exo compute elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/index.md) - Elastic IP addresses management * [exo compute instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management * [exo compute instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management * [exo compute instance-template](https://community.exoscale.com/reference/cli/exo/compute/instance-template/index.md) - Compute instance templates management * [exo compute instance-type](https://community.exoscale.com/reference/cli/exo/compute/instance-type/index.md) - Compute instance types management * [exo compute load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management * [exo compute private-network](https://community.exoscale.com/reference/cli/exo/compute/private-network/index.md) - Private Networks management * [exo compute security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management * [exo compute sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management * [exo compute ssh-key](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/index.md) - SSH keys management --- url: https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/ --- # exo compute anti-affinity-group ``` exo compute anti-affinity-group [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for anti-affinity-group | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute anti-affinity-group create](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/create/index.md) - Create an Anti-Affinity Group * [exo compute anti-affinity-group delete](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/delete/index.md) - Delete an Anti-Affinity Group * [exo compute anti-affinity-group list](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/list/index.md) - List Anti-Affinity Groups * [exo compute anti-affinity-group show](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/show/index.md) - Show an Anti-Affinity Group details --- url: https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/create/ --- # exo compute anti-affinity-group create ### Description This command creates a Compute instance Anti-Affinity Group. Supported output template annotations: .ID, .Name, .Description, .Instances ``` exo compute anti-affinity-group create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Anti-Affinity Group description | | `--help, -h` | help for create | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [anti-affinity-group](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/index.md) - Anti-Affinity Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/delete/ --- # exo compute anti-affinity-group delete ``` exo compute anti-affinity-group delete ANTI-AFFINITY-GROUP-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [anti-affinity-group](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/index.md) - Anti-Affinity Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/list/ --- # exo compute anti-affinity-group list ### Description This command lists Compute instance Anti-Affinity Groups. Supported output template annotations: .ID, .Name ``` exo compute anti-affinity-group list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [anti-affinity-group](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/index.md) - Anti-Affinity Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/show/ --- # exo compute anti-affinity-group show ### Description This command shows a Compute instance Anti-Affinity Group details. Supported output template annotations: .ID, .Name, .Description, .Instances ``` exo compute anti-affinity-group show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [anti-affinity-group](https://community.exoscale.com/reference/cli/exo/compute/anti-affinity-group/index.md) - Anti-Affinity Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/ --- # exo compute block-storage ``` exo compute block-storage [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for block-storage | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute block-storage attach](https://community.exoscale.com/reference/cli/exo/compute/block-storage/attach/index.md) - Attach a Block Storage Volume * [exo compute block-storage create](https://community.exoscale.com/reference/cli/exo/compute/block-storage/create/index.md) - Create a Block Storage Volume * [exo compute block-storage delete](https://community.exoscale.com/reference/cli/exo/compute/block-storage/delete/index.md) - Delete a Block Storage Volume * [exo compute block-storage detach](https://community.exoscale.com/reference/cli/exo/compute/block-storage/detach/index.md) - Detach a Block Storage Volume * [exo compute block-storage list](https://community.exoscale.com/reference/cli/exo/compute/block-storage/list/index.md) - List Block Storage Volumes * [exo compute block-storage show](https://community.exoscale.com/reference/cli/exo/compute/block-storage/show/index.md) - Show a Block Storage Volume details * [exo compute block-storage snapshot](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/index.md) - Block Storage Snapshot management * [exo compute block-storage update](https://community.exoscale.com/reference/cli/exo/compute/block-storage/update/index.md) - Update a Block Storage Volume --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/attach/ --- # exo compute block-storage attach ### Description This command attaches a Block Storage Volume to a Compute Instance. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage attach NAME|ID INSTANCE-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for attach | | `--zone, -z` | block storage zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/create/ --- # exo compute block-storage create ### Description This command creates a Block Storage Volume. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--label` | block storage volume labels (format: key=value) | | `--size` | block storage volume size (default: 10) | | `--snapshot` | block storage volume snapshot NAME\|ID | | `--zone, -z` | block storage zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/delete/ --- # exo compute block-storage delete ### Description This command deletes a Block Storage Volume. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage delete NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | block storage volume zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/detach/ --- # exo compute block-storage detach ### Description This command detaches Block Storage Volume. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage detach NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for detach | | `--zone, -z` | block storage volume zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/list/ --- # exo compute block-storage list ### Description This command lists Block Storage Volumes. Supported output template annotations: .ID, .Name, .Zone, .Size, .State ``` exo compute block-storage list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/show/ --- # exo compute block-storage show ### Description This command shows a Block Storage Volume details. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute block-storage show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | block storage volume zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/ --- # exo compute block-storage snapshot ``` exo compute block-storage snapshot [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for snapshot | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management * [exo compute block-storage snapshot create](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/create/index.md) - Create a Block Storage Volume Snapshot * [exo compute block-storage snapshot delete](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/delete/index.md) - Delete a Block Storage Volume Snapshot * [exo compute block-storage snapshot list](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/list/index.md) - List Block Storage Volume Snapshots * [exo compute block-storage snapshot show](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/show/index.md) - Show a Block Storage Volume details * [exo compute block-storage snapshot update](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/update/index.md) - Update a Block Storage Volume Snapshot --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/create/ --- # exo compute block-storage snapshot create ### Description This command creates a Block Storage Volume Snapshot. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage snapshot create [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--label` | block storage volume snapshot labels (format: key=value) | | `--name` | block storage volume snapshot name | | `--zone, -z` | block storage volume snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/index.md) - Block Storage Snapshot management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/delete/ --- # exo compute block-storage snapshot delete ### Description This command deletes a Block Storage Volume Snapshot. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage snapshot delete [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | block storage volume snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/index.md) - Block Storage Snapshot management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/list/ --- # exo compute block-storage snapshot list ### Description This command lists Block Storage Volume Snapshots. Supported output template annotations: .ID, .Name, .Zone, .Size, .State ``` exo compute block-storage snapshot list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/index.md) - Block Storage Snapshot management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/show/ --- # exo compute block-storage snapshot show ### Description This command shows a Block Storage Volume Snapshot details. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute block-storage snapshot show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | block storage zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/index.md) - Block Storage Snapshot management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/update/ --- # exo compute block-storage snapshot update ### Description This command updates a Block Storage Volume Snapshot. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage snapshot update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for update | | `--label` | block storage volume snapshot label (format: key=value), clearing the labels is possible by passing [=] | | `--rename` | rename block storage volume snapshot | | `--zone, -z` | block storage volume snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/block-storage/snapshot/index.md) - Block Storage Snapshot management --- url: https://community.exoscale.com/reference/cli/exo/compute/block-storage/update/ --- # exo compute block-storage update ### Description This command updates a Block Storage Volume. Supported output template annotations: .BlockStorageSnapshots, .Blocksize, .CreatedAT, .ID, .Instance, .Name, .Size, .Labels, .State ``` exo compute block-storage update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for update | | `--label` | block storage volume label (format: key=value), clearing the labels is possible by passing [=] | | `--rename` | rename block storage volume | | `--size` | block storage volume size | | `--zone, -z` | block storage volume zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [block-storage](https://community.exoscale.com/reference/cli/exo/compute/block-storage/index.md) - Block Storage management --- url: https://community.exoscale.com/reference/cli/exo/compute/deploy-target/ --- # exo compute deploy-target ``` exo compute deploy-target [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for deploy-target | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute deploy-target list](https://community.exoscale.com/reference/cli/exo/compute/deploy-target/list/index.md) - List Deploy Targets * [exo compute deploy-target show](https://community.exoscale.com/reference/cli/exo/compute/deploy-target/show/index.md) - Show a Deploy Target details --- url: https://community.exoscale.com/reference/cli/exo/compute/deploy-target/list/ --- # exo compute deploy-target list ### Description This command lists existing Deploy Targets. Supported output template annotations: .Zone, .ID, .Name, .Type ``` exo compute deploy-target list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deploy-target](https://community.exoscale.com/reference/cli/exo/compute/deploy-target/index.md) - Compute instance Deploy Targets management --- url: https://community.exoscale.com/reference/cli/exo/compute/deploy-target/show/ --- # exo compute deploy-target show ### Description This command shows a Deploy Target details. Supported output template annotations: .ID, .Name, .Description, .Type, .Zone ``` exo compute deploy-target show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Deploy Target zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deploy-target](https://community.exoscale.com/reference/cli/exo/compute/deploy-target/index.md) - Compute instance Deploy Targets management --- url: https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/ --- # exo compute elastic-ip ``` exo compute elastic-ip [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for elastic-ip | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute elastic-ip create](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/create/index.md) - Create an Elastic IP * [exo compute elastic-ip delete](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/delete/index.md) - Delete an Elastic IP * [exo compute elastic-ip list](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/list/index.md) - List Elastic IPs * [exo compute elastic-ip show](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/show/index.md) - Show an Elastic IP details * [exo compute elastic-ip update](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/update/index.md) - Update an Elastic IP --- url: https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/create/ --- # exo compute elastic-ip create ### Description This command creates a Compute instance Elastic IP. Supported output template annotations: .ID, .IPAddress, .AddressFamily, .CIDR, .Description, .Zone, .Type, .ReverseDNS, .Instances, .HealthcheckMode, .HealthcheckPort, .HealthcheckURI, .HealthcheckInterval, .HealthcheckTimeout, .HealthcheckStrikesOK, .HealthcheckStrikesFail, .HealthcheckTLSSNI, .HealthcheckTLSSkipVerify, .Labels ``` exo compute elastic-ip create [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Elastic IP description | | `--healthcheck-interval` | managed Elastic IP health checking interval in seconds | | `--healthcheck-mode` | managed Elastic IP health checking mode (tcp\|http\|https) | | `--healthcheck-port` | managed Elastic IP health checking port | | `--healthcheck-strikes-fail` | number of failed attempts before considering a managed Elastic IP health check unhealthy | | `--healthcheck-strikes-ok` | number of successful attempts before considering a managed Elastic IP health check healthy | | `--healthcheck-timeout` | managed Elastic IP health checking timeout in seconds | | `--healthcheck-tls-skip-verify` | disable TLS certificate verification for managed Elastic IP health checking in https mode | | `--healthcheck-tls-sni` | managed Elastic IP health checking server name to present with SNI in https mode | | `--healthcheck-uri` | managed Elastic IP health checking URI (required in http(s) mode) | | `--help, -h` | help for create | | `--ipv6` | create Elastic IPv6 prefix | | `--label` | Elastic IP labels (format: key=value, ex: a=1,b=2) | | `--reverse-dns` | Domain name for reverse DNS record. | | `--zone, -z` | Elastic IP zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/index.md) - Elastic IP addresses management --- url: https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/delete/ --- # exo compute elastic-ip delete ``` exo compute elastic-ip delete IP-ADDRESS|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Elastic IP zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/index.md) - Elastic IP addresses management --- url: https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/list/ --- # exo compute elastic-ip list ### Description This command lists Compute Elastic IPs. Supported output template annotations: .ID, .IPAddress, .Description, .Type, .Zone ``` exo compute elastic-ip list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/index.md) - Elastic IP addresses management --- url: https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/show/ --- # exo compute elastic-ip show ### Description This command shows a Compute instance Elastic IP details. Supported output template annotations: .ID, .IPAddress, .AddressFamily, .CIDR, .Description, .Zone, .Type, .ReverseDNS, .Instances, .HealthcheckMode, .HealthcheckPort, .HealthcheckURI, .HealthcheckInterval, .HealthcheckTimeout, .HealthcheckStrikesOK, .HealthcheckStrikesFail, .HealthcheckTLSSNI, .HealthcheckTLSSkipVerify, .Labels ``` exo compute elastic-ip show IP-ADDRESS|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Elastic IP zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/index.md) - Elastic IP addresses management --- url: https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/update/ --- # exo compute elastic-ip update ### Description This command updates a Compute instance Elastic IP. Supported output template annotations: .ID, .IPAddress, .AddressFamily, .CIDR, .Description, .Zone, .Type, .ReverseDNS, .Instances, .HealthcheckMode, .HealthcheckPort, .HealthcheckURI, .HealthcheckInterval, .HealthcheckTimeout, .HealthcheckStrikesOK, .HealthcheckStrikesFail, .HealthcheckTLSSNI, .HealthcheckTLSSkipVerify, .Labels ``` exo compute elastic-ip update IP-ADDRESS|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Elastic IP description | | `--healthcheck-interval` | managed Elastic IP health checking interval in seconds | | `--healthcheck-mode` | managed Elastic IP health checking mode (tcp\|http\|https) | | `--healthcheck-port` | managed Elastic IP health checking port | | `--healthcheck-strikes-fail` | number of failed attempts before considering a managed Elastic IP health check unhealthy | | `--healthcheck-strikes-ok` | number of successful attempts before considering a managed Elastic IP health check healthy | | `--healthcheck-timeout` | managed Elastic IP health checking timeout in seconds | | `--healthcheck-tls-skip-verify` | disable TLS certificate verification for managed Elastic IP health checking in https mode | | `--healthcheck-tls-sni` | managed Elastic IP health checking server name to present with SNI in https mode | | `--healthcheck-uri` | managed Elastic IP health checking URI (required in http(s) mode) | | `--help, -h` | help for update | | `--reverse-dns` | Reverse DNS Domain | | `--zone, -z` | Elastic IP zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/elastic-ip/index.md) - Elastic IP addresses management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/ --- # exo compute instance ``` exo compute instance [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for instance | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute instance attach-to-subnet](https://community.exoscale.com/reference/cli/exo/compute/instance/attach-to-subnet/index.md) - Attach a Compute instance to a VPC Subnet * [exo compute instance console-url](https://community.exoscale.com/reference/cli/exo/compute/instance/console-url/index.md) - Get instance console URL * [exo compute instance create](https://community.exoscale.com/reference/cli/exo/compute/instance/create/index.md) - Create a Compute instance * [exo compute instance delete](https://community.exoscale.com/reference/cli/exo/compute/instance/delete/index.md) - Delete a Compute instance * [exo compute instance detach-from-subnet](https://community.exoscale.com/reference/cli/exo/compute/instance/detach-from-subnet/index.md) - Detach a Compute instance from a VPC Subnet * [exo compute instance elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/index.md) - Manage Compute instance Elastic IP addresses * [exo compute instance enable-tpm](https://community.exoscale.com/reference/cli/exo/compute/instance/enable-tpm/index.md) - Enable Trusted Platform Module (TPM) * [exo compute instance list](https://community.exoscale.com/reference/cli/exo/compute/instance/list/index.md) - List Compute instances * [exo compute instance private-network](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/index.md) - Manage Compute instance Private Networks * [exo compute instance reboot](https://community.exoscale.com/reference/cli/exo/compute/instance/reboot/index.md) - Reboot a Compute instance * [exo compute instance reset](https://community.exoscale.com/reference/cli/exo/compute/instance/reset/index.md) - Reset a Compute instance * [exo compute instance reset-password](https://community.exoscale.com/reference/cli/exo/compute/instance/reset-password/index.md) - Reset the password of a Compute instance * [exo compute instance resize-disk](https://community.exoscale.com/reference/cli/exo/compute/instance/resize-disk/index.md) - Resize a Compute instance disk * [exo compute instance reveal-password](https://community.exoscale.com/reference/cli/exo/compute/instance/reveal-password/index.md) - Reveal the password of a Compute instance * [exo compute instance scale](https://community.exoscale.com/reference/cli/exo/compute/instance/scale/index.md) - Scale a Compute instance * [exo compute instance scp](https://community.exoscale.com/reference/cli/exo/compute/instance/scp/index.md) - SCP files to/from a Compute instance * [exo compute instance security-group](https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/index.md) - Manage Compute instance Security Groups * [exo compute instance show](https://community.exoscale.com/reference/cli/exo/compute/instance/show/index.md) - Show a Compute instance details * [exo compute instance snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots * [exo compute instance ssh](https://community.exoscale.com/reference/cli/exo/compute/instance/ssh/index.md) - Log into a Compute instance via SSH * [exo compute instance start](https://community.exoscale.com/reference/cli/exo/compute/instance/start/index.md) - Start a Compute instance * [exo compute instance stop](https://community.exoscale.com/reference/cli/exo/compute/instance/stop/index.md) - Stop a Compute instance * [exo compute instance update](https://community.exoscale.com/reference/cli/exo/compute/instance/update/index.md) - Update an Instance --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/attach-to-subnet/ --- # exo compute instance attach-to-subnet ### Description This command attaches a Compute instance to a VPC Subnet. ``` exo compute instance attach-to-subnet INSTANCE-NAME|ID VPC-NAME|ID SUBNET-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for attach-to-subnet | | `--ipv4` | IPv4 address to assign to the Compute instance in the Subnet | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/console-url/ --- # exo compute instance console-url ### Description This command generates a Compute instance console URL. Supported output template annotations: .ConsoleURL ``` exo compute instance console-url NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for console-url | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/create/ --- # exo compute instance create ### Description This command creates a Compute instance. Supported Compute instance type families: cpu, gpu, gpu2, memory, standard, storage Supported Compute instance type sizes: micro, tiny, small, medium, large, extra-large, huge, jumbo, mega, titan Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--anti-affinity-group` | instance Anti-Affinity Group NAME\|ID (can be specified multiple times) | | `--application-consistent-snapshot-enabled` | enable application-consistent snapshots when supported; false disables; omit for template default | | `--cloud-init` | instance cloud-init user data configuration file path | | `--cloud-init-compress` | compress instance cloud-init user data | | `--deploy-target` | instance Deploy Target NAME\|ID | | `--disk-size` | instance disk size | | `--help, -h` | help for create | | `--instance-type` | instance type (format: [FAMILY.]SIZE) | | `--ip-forwarding` | enable ip forwarding on instance | | `--label` | instance label (format: key=value) | | `--private-network` | instance Private Network NAME\|ID (can be specified multiple times) | | `--protection` | enable delete protection | | `--public-ip` | Configures public IP assignment of the Instances (none\|inet4\|dual). (default: inet4) | | `--reverse-dns` | Reverse DNS Domain | | `--secureboot` | enable Secure boot on instance | | `--security-group` | instance Security Group NAME\|ID (can be specified multiple times) | | `--ssh-key` | SSH key to deploy on the instance (can be specified multiple times) | | `--template` | instance template NAME\|ID | | `--template-visibility` | instance template visibility (public\|private) | | `--tpm` | enable TPM on instance | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/delete/ --- # exo compute instance delete ``` exo compute instance delete NAME|ID... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/detach-from-subnet/ --- # exo compute instance detach-from-subnet ### Description This command detaches a Compute instance from a VPC Subnet. ``` exo compute instance detach-from-subnet INSTANCE-NAME|ID VPC-NAME|ID SUBNET-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for detach-from-subnet | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/ --- # exo compute instance elastic-ip ``` exo compute instance elastic-ip [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for elastic-ip | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management * [exo compute instance elastic-ip attach](https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/attach/index.md) - Attach an Elastic IP to a Compute instance * [exo compute instance elastic-ip detach](https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/detach/index.md) - Detach a Compute instance from a Elastic IP --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/attach/ --- # exo compute instance elastic-ip attach ### Description This command attaches an Elastic IP address to a Compute instance. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance elastic-ip attach INSTANCE-NAME|ID ELASTIC-IP-ADDRESS|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for attach | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/index.md) - Manage Compute instance Elastic IP addresses --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/detach/ --- # exo compute instance elastic-ip detach ### Description This command detaches an Elastic IP address from a Compute instance. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance elastic-ip detach INSTANCE-NAME|ID ELASTIC-IP-ADDRESS|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for detach | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [elastic-ip](https://community.exoscale.com/reference/cli/exo/compute/instance/elastic-ip/index.md) - Manage Compute instance Elastic IP addresses --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/enable-tpm/ --- # exo compute instance enable-tpm ``` exo compute instance enable-tpm NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for enable-tpm | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/list/ --- # exo compute instance list ### Description This command lists Compute instances. Supported output template annotations: .ID, .Name, .Zone, .Type, .IPAddress, .IPv6Address, .State ``` exo compute instance list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/ --- # exo compute instance private-network ``` exo compute instance private-network [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for private-network | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management * [exo compute instance private-network attach](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/attach/index.md) - Attach a Compute instance to a Private Network * [exo compute instance private-network detach](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/detach/index.md) - Detach a Compute instance from a Private Network * [exo compute instance private-network update-ip](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/update-ip/index.md) - Update a Compute instance Private Network IP address --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/attach/ --- # exo compute instance private-network attach ### Description This command attaches a Compute instance to a Private Network. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance private-network attach INSTANCE-NAME|ID PRIVATE-NETWORK-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for attach | | `--ip` | network IP address to assign to the Compute instance (managed Private Networks only) | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/index.md) - Manage Compute instance Private Networks --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/detach/ --- # exo compute instance private-network detach ### Description This command detaches a Compute instance from a Private Network. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance private-network detach INSTANCE-NAME|ID PRIVATE-NETWORK-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for detach | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/index.md) - Manage Compute instance Private Networks --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/update-ip/ --- # exo compute instance private-network update-ip ### Description This command updates the IP address assigned to a Compute instance in a managed Private Network. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance private-network update-ip INSTANCE-NAME|ID PRIVATE-NETWORK-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for update-ip | | `--ip` | network IP address to assign to the Compute instance | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/instance/private-network/index.md) - Manage Compute instance Private Networks --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/reboot/ --- # exo compute instance reboot ``` exo compute instance reboot NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for reboot | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/reset/ --- # exo compute instance reset ### Description This commands resets a Compute instance to a base template state, and optionally resizes the instance's disk'. /!\ **************************************************************** /!\ THIS OPERATION EFFECTIVELY WIPES ALL DATA STORED ON THE INSTANCE'S DISK /!\ **************************************************************** /!\ Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance reset NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--disk-size` | disk size to reset the instance to (default: current instance disk size) | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for reset | | `--template` | template NAME\|ID to reset the instance to (default: current instance template) | | `--template-visibility` | instance template visibility (public\|private) | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/reset-password/ --- # exo compute instance reset-password ``` exo compute instance reset-password NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for reset-password | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/resize-disk/ --- # exo compute instance resize-disk ### Description This commands grows a Compute instance's disk to a larger size.' Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance resize-disk NAME|ID SIZE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for resize-disk | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/reveal-password/ --- # exo compute instance reveal-password ``` exo compute instance reveal-password NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for reveal-password | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/scale/ --- # exo compute instance scale ### Description This commands scales a Compute instance to a different size. Supported Compute instance type sizes: micro, tiny, small, medium, large, extra-large, huge, jumbo, mega, titan Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance scale NAME|ID SIZE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for scale | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/scp/ --- # exo compute instance scp ### Description This command executes the scp(1) command to send or receive files to/from the specified Compute instance. TARGET (or SOURCE, depending on the direction of the transfer) must contain the "{}" marker which will be interpolated at run time with the actual Compute instance IP address, similar to xargs(1). This marker can be replaced by another string via the --replace-str|-i flag. Example: exo compute instance scp my-instance hello-world.txt {}: exo compute instance scp -i%% my-instance %%:/etc/motd . ``` exo compute instance scp INSTANCE-NAME|ID SOURCE TARGET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for scp | | `--ipv6, -6` | | | `--login, -l` | | | `--print-command` | print the SCP command that would be executed instead of executing it | | `--recursive, -r` | recursively copy entire directories | | `--replace-str, -i` | string to replace with the actual Compute instance information (i.e. username@IP-ADDRESS) | | `--scp-options, -o` | additional options to pass to the scp(1) command | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/ --- # exo compute instance security-group ``` exo compute instance security-group [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for security-group | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management * [exo compute instance security-group add](https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/add/index.md) - Add a Compute instance to Security Groups * [exo compute instance security-group remove](https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/remove/index.md) - Remove a Compute instance from Security Groups --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/add/ --- # exo compute instance security-group add ### Description This command adds a Compute instance to Security Groups. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance security-group add INSTANCE-NAME|ID SECURITY-GROUP-NAME|ID... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for add | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/index.md) - Manage Compute instance Security Groups --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/remove/ --- # exo compute instance security-group remove ### Description This command removes a Compute instance from Security Groups. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance security-group remove INSTANCE-NAME|ID SECURITY-GROUP-NAME|ID... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for remove | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/instance/security-group/index.md) - Manage Compute instance Security Groups --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/show/ --- # exo compute instance show ### Description This command shows a Compute instance details. Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--user-data, -u` | show instance cloud-init user data configuration | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/ --- # exo compute instance snapshot ``` exo compute instance snapshot [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for snapshot | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management * [exo compute instance snapshot create](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/create/index.md) - Create a Compute instance snapshot * [exo compute instance snapshot delete](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/delete/index.md) - Delete a Compute instance snapshot * [exo compute instance snapshot export](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/export/index.md) - Export a Compute instance snapshot * [exo compute instance snapshot list](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/list/index.md) - List Compute instance snapshots * [exo compute instance snapshot revert](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/revert/index.md) - Revert a Compute instance to a snapshot * [exo compute instance snapshot show](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/show/index.md) - Show a Compute instance snapshot details --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/create/ --- # exo compute instance snapshot create ### Description This command creates a Compute instance snapshot. Supported output template annotations: .ID, .Name, .CreationDate, .State, .Size, .Instance, .Zone, .AppConsistentSnapshot ``` exo compute instance snapshot create INSTANCE-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/delete/ --- # exo compute instance snapshot delete ``` exo compute instance snapshot delete ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/export/ --- # exo compute instance snapshot export ### Description This command exports a Compute instance snapshot. Supported output template annotations: .URL, .Checksum ``` exo compute instance snapshot export ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for export | | `--zone, -z` | snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/list/ --- # exo compute instance snapshot list ### Description This command lists existing Compute instance snapshots. Supported output template annotations: .ID, .CreationDate, .Instance, .State, .Zone ``` exo compute instance snapshot list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/revert/ --- # exo compute instance snapshot revert ### Description This command reverts a Compute instance to a snapshot. /!\ **************************************************************** /!\ THIS OPERATION EFFECTIVELY RESTORES AN INSTANCE'S DISK TO A PREVIOUS STATE: ALL DATA WRITTEN AFTER THE SNAPSHOT HAS BEEN CREATED WILL BE LOST. /!\ **************************************************************** /!\ Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance snapshot revert INSTANCE-NAME|ID SNAPSHOT-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for revert | | `--zone, -z` | snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/show/ --- # exo compute instance snapshot show ### Description This command shows a Compute instance snapshot details. Supported output template annotations: .ID, .Name, .CreationDate, .State, .Size, .Instance, .Zone, .AppConsistentSnapshot ``` exo compute instance snapshot show ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | snapshot zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [snapshot](https://community.exoscale.com/reference/cli/exo/compute/instance/snapshot/index.md) - Manage Compute instance snapshots --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/ssh/ --- # exo compute instance ssh ### Description This command connects to a Compute instance via SSH (requires the ssh(1) command). To pass custom SSH options: exo compute instance ssh -o "-p 2222 -A" my-instance ``` exo compute instance ssh INSTANCE-NAME|ID [COMMAND ARGUMENT] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for ssh | | `--ipv6, -6` | | | `--login, -l` | | | `--print-command` | print the SSH command that would be executed instead of executing it | | `--print-ssh-config` | print the corresponding SSH information in a format compatible with ssh_config(5) | | `--ssh-options, -o` | additional options to pass to the ssh(1) command | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/start/ --- # exo compute instance start ``` exo compute instance start NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for start | | `--rescue-profile` | rescue profile to start the instance with | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/stop/ --- # exo compute instance stop ``` exo compute instance stop NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for stop | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance/update/ --- # exo compute instance update ### Description This command updates an Instance . Supported output template annotations: .ID, .Name, .CreationDate, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .DeployTarget, .SecurityGroups, .PrivateInstance, .ElasticIPs, .PublicIPAssignment, .IPAddress, .IPv6Address, .Vpc, .VpcSubnets, .PrivateNetworks, .IpForwarding, .SSHKeys, .DiskSize, .State, .Labels, .SecureBoot, .Tpm, .ReverseDNS, .AppConsistentSnapshot ``` exo compute instance update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--application-consistent-snapshot-enabled` | update instance application-consistent snapshots | | `--cloud-init, -c` | instance cloud-init user data configuration file path | | `--cloud-init-compress` | compress instance cloud-init user data | | `--help, -h` | help for update | | `--label` | instance label (format: key=value) | | `--name, -n` | instance name | | `--protection` | delete protection; set --protection=false to disable instance protection | | `--reverse-dns` | Reverse DNS Domain | | `--zone, -z` | instance zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance](https://community.exoscale.com/reference/cli/exo/compute/instance/index.md) - Compute instances management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/ --- # exo compute instance-pool ``` exo compute instance-pool [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for instance-pool | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute instance-pool create](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/create/index.md) - Create an Instance Pool * [exo compute instance-pool delete](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/delete/index.md) - Delete an Instance Pool * [exo compute instance-pool evict](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/evict/index.md) - Evict Instance Pool members * [exo compute instance-pool list](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/list/index.md) - List Instance Pools * [exo compute instance-pool scale](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/scale/index.md) - Scale an Instance Pool size * [exo compute instance-pool show](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/show/index.md) - Show an Instance Pool details * [exo compute instance-pool update](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/update/index.md) - Update an Instance Pool --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/create/ --- # exo compute instance-pool create ### Description This command creates an Instance Pool. Supported output template annotations: .ID, .Name, .Description, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .ElasticIPs, .IPv6, .PublicIPAssignment, .SSHKey, .Size, .DiskSize, .InstancePrefix, .State, .Labels, .Instances ``` exo compute instance-pool create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--anti-affinity-group, -a` | managed Compute instances Anti-Affinity Group NAME\|ID (can be specified multiple times) | | `--cloud-init, -c` | cloud-init user data configuration file path | | `--cloud-init-compress` | compress instance cloud-init user data | | `--deploy-target` | managed Compute instances Deploy Target NAME\|ID | | `--description` | Instance Pool description | | `--disk-size` | managed Compute instances disk size | | `--elastic-ip, -e` | managed Compute instances Elastic IP ADDRESS\|ID (can be specified multiple times) | | `--help, -h` | help for create | | `--instance-prefix` | string to prefix managed Compute instances names with | | `--instance-type` | managed Compute instances type (format: [FAMILY.]SIZE) | | `--label` | Instance Pool label (format: key=value) | | `--min-available` | Minimum number of running Instances | | `--private-network` | managed Compute instances Private Network NAME\|ID (can be specified multiple times) | | `--public-ip` | Configures public IP assignment of the instance pool (none\|inet4\|dual). (default: inet4) | | `--security-group, -s` | managed Compute instances Security Group NAME\|ID (can be specified multiple times) | | `--size` | Instance Pool size | | `--ssh-key` | SSH key to deploy on managed Compute instances | | `--template, -t` | managed Compute instances template NAME\|ID | | `--template-visibility` | instance template visibility (public\|private) | | `--zone, -z` | Instance Pool zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/delete/ --- # exo compute instance-pool delete ``` exo compute instance-pool delete NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Instance Pool zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/evict/ --- # exo compute instance-pool evict ### Description This command evicts specific members from an Instance Pool, effectively scaling down the Instance Pool similar to the "exo compute instance-pool scale" command. ``` exo compute instance-pool evict INSTANCE-POOL-NAME|ID INSTANCE-NAME|ID... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for evict | | `--zone, -z` | Instance Pool zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/list/ --- # exo compute instance-pool list ### Description This command lists Instance Pools. Supported output template annotations: .ID, .Name, .Zone, .Size, .State ``` exo compute instance-pool list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/scale/ --- # exo compute instance-pool scale ### Description This command scales an Instance Pool size up (growing) or down (shrinking). In case of a scale-down, operators should use the "exo compute instance-pool evict" command, allowing them to specify which specific instance should be evicted from the Instance Pool rather than leaving the decision to the orchestrator. ``` exo compute instance-pool scale INSTANCE-POOL-NAME|ID SIZE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for scale | | `--zone, -z` | Instance Pool zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/show/ --- # exo compute instance-pool show ### Description This command shows an Instance Pool details. Supported output template annotations: .ID, .Name, .Description, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .ElasticIPs, .IPv6, .PublicIPAssignment, .SSHKey, .Size, .DiskSize, .InstancePrefix, .State, .Labels, .Instances ``` exo compute instance-pool show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--user-data, -u` | show cloud-init user data configuration | | `--zone, -z` | Instance Pool zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-pool/update/ --- # exo compute instance-pool update ### Description This command updates an Instance Pool. Supported output template annotations: .ID, .Name, .Description, .InstanceType, .Template, .Zone, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .ElasticIPs, .IPv6, .PublicIPAssignment, .SSHKey, .Size, .DiskSize, .InstancePrefix, .State, .Labels, .Instances ``` exo compute instance-pool update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--anti-affinity-group, -a` | managed Compute instances Anti-Affinity Group NAME\|ID (can be specified multiple times) | | `--cloud-init, -c` | cloud-init user data configuration file path | | `--cloud-init-compress` | compress instance cloud-init user data | | `--deploy-target` | managed Compute instances Deploy Target NAME\|ID | | `--description` | Instance Pool description | | `--disk-size` | managed Compute instances disk size | | `--elastic-ip, -e` | managed Compute instances Elastic IP ADDRESS\|ID (can be specified multiple times) | | `--help, -h` | help for update | | `--instance-prefix` | string to prefix managed Compute instances names with | | `--instance-type` | managed Compute instances type (format: [FAMILY.]SIZE) | | `--ipv6, -6` | enable IPv6 on managed Compute instances | | `--label` | Instance Pool label (format: key=value) | | `--min-available` | Minimum number of running Instances | | `--name, -n` | Instance Pool name | | `--private-network` | managed Compute instances Private Network NAME\|ID (can be specified multiple times) | | `--security-group, -s` | managed Compute instances Security Group NAME\|ID (can be specified multiple times) | | `--ssh-key` | SSH key to deploy on managed Compute instances | | `--template, -t` | managed Compute instances template NAME\|ID | | `--template-visibility` | instance template visibility (public\|private) | | `--zone, -z` | Instance Pool zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-pool](https://community.exoscale.com/reference/cli/exo/compute/instance-pool/index.md) - Instance Pools management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-template/ --- # exo compute instance-template ``` exo compute instance-template [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for instance-template | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute instance-template delete](https://community.exoscale.com/reference/cli/exo/compute/instance-template/delete/index.md) - Delete a Compute instance template * [exo compute instance-template list](https://community.exoscale.com/reference/cli/exo/compute/instance-template/list/index.md) - List Compute instance templates * [exo compute instance-template register](https://community.exoscale.com/reference/cli/exo/compute/instance-template/register/index.md) - Register a new Compute instance template * [exo compute instance-template show](https://community.exoscale.com/reference/cli/exo/compute/instance-template/show/index.md) - Show a Compute instance template details --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-template/delete/ --- # exo compute instance-template delete ``` exo compute instance-template delete TEMPLATE-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | template zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-template](https://community.exoscale.com/reference/cli/exo/compute/instance-template/index.md) - Compute instance templates management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-template/list/ --- # exo compute instance-template list ### Description This command lists available Compute instance templates. Supported output template annotations: .ID, .Name, .Family, .CreationDate ``` exo compute instance-template list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--family, -f` | template family to filter results to | | `--help, -h` | help for list | | `--visibility, -v` | template visibility (public\|private) | | `--zone, -z` | zone to filter results to (default: current account's default zone) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-template](https://community.exoscale.com/reference/cli/exo/compute/instance-template/index.md) - Compute instance templates management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-template/register/ --- # exo compute instance-template register ### Description This command registers a new Compute instance template. Supported output template annotations: .ID, .Zone, .Name, .Description, .Family, .CreationDate, .Visibility, .Size, .Version, .Build, .Maintainer, .DefaultUser, .SSHKeyEnabled, .PasswordEnabled, .BootMode, .Checksum, .AppConsistentSnapshotEnabled ``` exo compute instance-template register NAME URL CHECKSUM [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--application-consistent-snapshot-enabled` | template with support for application-consistent-snapshots | | `--boot-mode` | template boot mode (legacy\|uefi) | | `--build` | template build | | `--description` | template description | | `--disable-password` | disable password-based authentication | | `--disable-ssh-key` | disable SSH key-based authentication | | `--from-snapshot` | ID of a Compute instance snapshot to register as template | | `--help, -h` | help for register | | `--maintainer` | template maintainer | | `--username` | template default username | | `--version` | template version | | `--zone, -z` | zone to register the template into (default: current account's default zone) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-template](https://community.exoscale.com/reference/cli/exo/compute/instance-template/index.md) - Compute instance templates management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-template/show/ --- # exo compute instance-template show ### Description This command shows a Compute instance template details. Supported output template annotations: .ID, .Zone, .Name, .Description, .Family, .CreationDate, .Visibility, .Size, .Version, .Build, .Maintainer, .DefaultUser, .SSHKeyEnabled, .PasswordEnabled, .BootMode, .Checksum, .AppConsistentSnapshotEnabled ``` exo compute instance-template show [FAMILY.]SIZE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--visibility, -v` | template visibility (public\|private) | | `--zone, -z` | zone to filter results to (default: current account's default zone) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-template](https://community.exoscale.com/reference/cli/exo/compute/instance-template/index.md) - Compute instance templates management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-type/ --- # exo compute instance-type ``` exo compute instance-type [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for instance-type | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute instance-type list](https://community.exoscale.com/reference/cli/exo/compute/instance-type/list/index.md) - List Compute instance types * [exo compute instance-type show](https://community.exoscale.com/reference/cli/exo/compute/instance-type/show/index.md) - Show a Compute instance type details --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-type/list/ --- # exo compute instance-type list ### Description This command lists available Compute instance types. Supported output template annotations: .ID, .Family, .Size, .CPUs, .Memory, .Authorized ``` exo compute instance-type list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--verbose, -v` | | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-type](https://community.exoscale.com/reference/cli/exo/compute/instance-type/index.md) - Compute instance types management --- url: https://community.exoscale.com/reference/cli/exo/compute/instance-type/show/ --- # exo compute instance-type show ### Description This command shows a Compute instance type details. Supported output template annotations: .ID, .Family, .Size, .Memory, .CPUs, .GPUs, .Authorized ``` exo compute instance-type show [FAMILY.]SIZE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [instance-type](https://community.exoscale.com/reference/cli/exo/compute/instance-type/index.md) - Compute instance types management --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/ --- # exo compute load-balancer ``` exo compute load-balancer [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for load-balancer | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute load-balancer create](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/create/index.md) - Create a Network Load Balancer * [exo compute load-balancer delete](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/delete/index.md) - Delete a Network Load Balancer * [exo compute load-balancer list](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/list/index.md) - List Network Load Balancers * [exo compute load-balancer service](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/index.md) - Manage Network Load Balancer services * [exo compute load-balancer show](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/show/index.md) - Show a Network Load Balancer details * [exo compute load-balancer update](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/update/index.md) - Update a Network Load Balancer --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/create/ --- # exo compute load-balancer create ### Description This command creates a Network Load Balancer. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .Zone, .IPAddress, .AddressFamily, .State, .Services, .Labels ``` exo compute load-balancer create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Network Load Balancer description | | `--help, -h` | help for create | | `--ipv6, -6` | create an IPv6 (inet6) Network Load Balancer | | `--label` | Network Load Balancer label (format: key=value) | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/delete/ --- # exo compute load-balancer delete ``` exo compute load-balancer delete NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/list/ --- # exo compute load-balancer list ### Description This command lists Network Load Balancers. Supported output template annotations: .ID, .Name, .Zone, .IPAddress, .AddressFamily ``` exo compute load-balancer list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/ --- # exo compute load-balancer service ``` exo compute load-balancer service [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for service | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management * [exo compute load-balancer service add](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/add/index.md) - Add a service to a Network Load Balancer * [exo compute load-balancer service delete](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/delete/index.md) - Delete a Network Load Balancer service * [exo compute load-balancer service show](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/show/index.md) - Show a Network Load Balancer service details * [exo compute load-balancer service update](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/update/index.md) - Update a Network Load Balancer service --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/add/ --- # exo compute load-balancer service add ### Description This command adds a service to a Network Load Balancer. Supported output template annotations: .ID, .Name, .Description, .InstancePoolID, .Protocol, .Port, .TargetPort, .Strategy, .Healthcheck, .HealthcheckStatus, .State ``` exo compute load-balancer service add LOAD-BALANCER-NAME|ID SERVICE-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | service description | | `--healthcheck-interval` | service health checking interval in seconds | | `--healthcheck-mode` | service health checking mode (tcp\|http\|https) | | `--healthcheck-port` | service health checking port (defaults to target port) | | `--healthcheck-retries` | service health checking retries | | `--healthcheck-timeout` | service health checking timeout in seconds | | `--healthcheck-tls-sni` | service health checking server name to present with SNI in https mode | | `--healthcheck-uri` | service health checking URI (required in http(s) mode) | | `--help, -h` | help for add | | `--instance-pool` | name or ID of the Instance Pool to forward traffic to | | `--port` | service port | | `--protocol` | service network protocol (tcp\|udp) | | `--strategy` | load balancing strategy (round-robin\|source-hash) | | `--target-port` | port to forward traffic to on target instances (defaults to service port) | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [service](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/index.md) - Manage Network Load Balancer services --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/delete/ --- # exo compute load-balancer service delete ``` exo compute load-balancer service delete LOAD-BALANCER-NAME|ID SERVICE-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [service](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/index.md) - Manage Network Load Balancer services --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/show/ --- # exo compute load-balancer service show ### Description This command shows a Network Load Balancer service details. Supported output template annotations: .ID, .Name, .Description, .InstancePoolID, .Protocol, .Port, .TargetPort, .Strategy, .Healthcheck, .HealthcheckStatus, .State ``` exo compute load-balancer service show LOAD-BALANCER-NAME|ID SERVICE-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [service](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/index.md) - Manage Network Load Balancer services --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/update/ --- # exo compute load-balancer service update ### Description This command updates a Network Load Balancer service. Supported output template annotations: .ID, .Name, .Description, .InstancePoolID, .Protocol, .Port, .TargetPort, .Strategy, .Healthcheck, .HealthcheckStatus, .State ``` exo compute load-balancer service update LOAD-BALANCER-NAME|ID SERVICE-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | service description | | `--healthcheck-interval` | service health checking interval in seconds | | `--healthcheck-mode` | service health checking mode (tcp\|http\|https) | | `--healthcheck-port` | service health checking port | | `--healthcheck-retries` | service health checking retries | | `--healthcheck-timeout` | service health checking timeout in seconds | | `--healthcheck-tls-sni` | service health checking server name to present with SNI in https mode | | `--healthcheck-uri` | service health checking URI (required in http(s) mode) | | `--help, -h` | help for update | | `--name` | service name | | `--port` | service port | | `--protocol` | service network protocol (tcp\|udp) | | `--strategy` | load balancing strategy (round-robin\|source-hash) | | `--target-port` | port to forward traffic to on target instances | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [service](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/service/index.md) - Manage Network Load Balancer services --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/show/ --- # exo compute load-balancer show ### Description This command shows a Network Load Balancer details. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .Zone, .IPAddress, .AddressFamily, .State, .Services, .Labels ``` exo compute load-balancer show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management --- url: https://community.exoscale.com/reference/cli/exo/compute/load-balancer/update/ --- # exo compute load-balancer update ### Description This command updates a Network Load Balancer. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .Zone, .IPAddress, .AddressFamily, .State, .Services, .Labels ``` exo compute load-balancer update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Network Load Balancer description | | `--help, -h` | help for update | | `--label` | Network Load Balancer label (format: key=value) | | `--name` | Network Load Balancer name | | `--zone, -z` | Network Load Balancer zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [load-balancer](https://community.exoscale.com/reference/cli/exo/compute/load-balancer/index.md) - Network Load Balancers management --- url: https://community.exoscale.com/reference/cli/exo/compute/private-network/ --- # exo compute private-network ``` exo compute private-network [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for private-network | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute private-network create](https://community.exoscale.com/reference/cli/exo/compute/private-network/create/index.md) - Create a Private Network * [exo compute private-network delete](https://community.exoscale.com/reference/cli/exo/compute/private-network/delete/index.md) - Delete a Private Network * [exo compute private-network list](https://community.exoscale.com/reference/cli/exo/compute/private-network/list/index.md) - List Private Networks * [exo compute private-network show](https://community.exoscale.com/reference/cli/exo/compute/private-network/show/index.md) - Show a Private Network details * [exo compute private-network update](https://community.exoscale.com/reference/cli/exo/compute/private-network/update/index.md) - Update a Private Network --- url: https://community.exoscale.com/reference/cli/exo/compute/private-network/create/ --- # exo compute private-network create ### Description This command creates a Compute instance Private Network. Supported output template annotations: .ID, .Name, .Description, .Zone, .Type, .StartIP, .EndIP, .Netmask, .Leases, .Options ``` exo compute private-network create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Private Network description | | `--dns-server` | DHCP option 6: DNS servers (can be specified multiple times) | | `--domain-search` | DHCP option 119: domain search list (limited to 255 octets, can be specified multiple times) | | `--end-ip` | Private Network range end IP address | | `--help, -h` | help for create | | `--netmask` | DHCP option 1: Subnet netmask | | `--ntp-server` | DHCP option 42: NTP servers (can be specified multiple times) | | `--router` | DHCP option 3: Routers (can be specified multiple times) | | `--start-ip` | Private Network range start IP address | | `--zone, -z` | Private Network zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/private-network/index.md) - Private Networks management --- url: https://community.exoscale.com/reference/cli/exo/compute/private-network/delete/ --- # exo compute private-network delete ``` exo compute private-network delete NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Private Network zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/private-network/index.md) - Private Networks management --- url: https://community.exoscale.com/reference/cli/exo/compute/private-network/list/ --- # exo compute private-network list ### Description This command lists Compute instance Private Networks. Supported output template annotations: .ID, .Name, .Zone ``` exo compute private-network list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/private-network/index.md) - Private Networks management --- url: https://community.exoscale.com/reference/cli/exo/compute/private-network/show/ --- # exo compute private-network show ### Description This command shows a Compute instance Private Network details. Supported output template annotations for Private Network: .ID, .Name, .Description, .Zone, .Type, .StartIP, .EndIP, .Netmask, .Leases, .Options Supported output template annotations for Private Network leases: .Instance, .IPAddress ``` exo compute private-network show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Private Network zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/private-network/index.md) - Private Networks management --- url: https://community.exoscale.com/reference/cli/exo/compute/private-network/update/ --- # exo compute private-network update ### Description This command updates a Compute instance Private Network. Supported output template annotations: .ID, .Name, .Description, .Zone, .Type, .StartIP, .EndIP, .Netmask, .Leases, .Options ``` exo compute private-network update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Private Network description | | `--dns-server` | DHCP option 6: DNS servers (can be specified multiple times) | | `--domain-search` | DHCP option 119: domain search list (limited to 255 octets, can be specified multiple times) | | `--end-ip` | Private Network range end IP address | | `--help, -h` | help for update | | `--name` | Private Network name | | `--netmask` | DHCP option 1: Subnet netmask | | `--ntp-server` | DHCP option 42: NTP servers (can be specified multiple times) | | `--router` | DHCP option 3: Routers (can be specified multiple times) | | `--start-ip` | Private Network range start IP address | | `--zone, -z` | Private Network zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [private-network](https://community.exoscale.com/reference/cli/exo/compute/private-network/index.md) - Private Networks management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/ --- # exo compute security-group ``` exo compute security-group [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for security-group | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute security-group create](https://community.exoscale.com/reference/cli/exo/compute/security-group/create/index.md) - Create a Security Group * [exo compute security-group delete](https://community.exoscale.com/reference/cli/exo/compute/security-group/delete/index.md) - Delete a Security Group * [exo compute security-group list](https://community.exoscale.com/reference/cli/exo/compute/security-group/list/index.md) - List Security Groups * [exo compute security-group rule](https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/index.md) - Security Group rules management * [exo compute security-group show](https://community.exoscale.com/reference/cli/exo/compute/security-group/show/index.md) - Show a Security Group details * [exo compute security-group source](https://community.exoscale.com/reference/cli/exo/compute/security-group/source/index.md) - Security Group external sources management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/create/ --- # exo compute security-group create ### Description This command creates a Compute instance Security Group. Supported output template annotations: .ID, .Name, .Description, .ExternalSources, .IngressRules, .EgressRules, .Instances ``` exo compute security-group create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Security Group description | | `--help, -h` | help for create | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/delete/ --- # exo compute security-group delete ``` exo compute security-group delete SECURITY-GROUP-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--delete-rules, -r` | Delete all rules but not the security group | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/list/ --- # exo compute security-group list ### Description This command lists Compute instance Security Groups. Supported output template annotations: .ID, .Name, .Visibility ``` exo compute security-group list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--visibility` | Security Group visibility: private (default) or public | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/ --- # exo compute security-group rule ``` exo compute security-group rule [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for rule | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management * [exo compute security-group rule add](https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/add/index.md) - Add a Security Group rule * [exo compute security-group rule delete](https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/delete/index.md) - Delete a Security Group rule --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/add/ --- # exo compute security-group rule add ### Description This command adds a rule to a Compute instance Security Group. Supported network protocols: all, ah, esp, gre, icmp, icmpv6, ipip, tcp, udp Supported output template annotations: .ID, .Name, .Description, .ExternalSources, .IngressRules, .EgressRules, .Instances ``` exo compute security-group rule add SECURITY-GROUP-ID|NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | rule description | | `--flow` | rule network flow direction (ingress\|egress) | | `--help, -h` | help for add | | `--icmp-code` | rule ICMP code | | `--icmp-type` | rule ICMP type | | `--network` | rule target network address (in CIDR format) | | `--port` | rule network port (format: PORT\|START-END) | | `--protocol` | rule network protocol | | `--public-security-group` | rule target Public Security Group NAME | | `--security-group` | rule target Security Group NAME\|ID | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [rule](https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/index.md) - Security Group rules management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/delete/ --- # exo compute security-group rule delete ### Description This command deletes a rule from a Compute instance Security Group. Supported output template annotations: .ID, .Name, .Description, .ExternalSources, .IngressRules, .EgressRules, .Instances ``` exo compute security-group rule delete SECURITY-GROUP-ID|NAME RULE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [rule](https://community.exoscale.com/reference/cli/exo/compute/security-group/rule/index.md) - Security Group rules management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/show/ --- # exo compute security-group show ### Description This command shows a Compute instance Security Group details. Supported output template annotations for Security Group: .ID, .Name, .Description, .ExternalSources, .IngressRules, .EgressRules, .Instances Supported output template annotations for Security Group rules: .ID, .Description, .ICMPCode, .ICMPType, .Network, .Protocol, .SecurityGroup, .StartPort, .EndPort ``` exo compute security-group show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/source/ --- # exo compute security-group source ``` exo compute security-group source [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for source | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [security-group](https://community.exoscale.com/reference/cli/exo/compute/security-group/index.md) - Security Groups management * [exo compute security-group source add](https://community.exoscale.com/reference/cli/exo/compute/security-group/source/add/index.md) - Add an external source to a Security Group * [exo compute security-group source remove](https://community.exoscale.com/reference/cli/exo/compute/security-group/source/remove/index.md) - Remove an external source from a Security Group --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/source/add/ --- # exo compute security-group source add ### Description This command adds an external source to a Compute instance Security Group. Supported output template annotations: .ID, .Name, .Description, .ExternalSources, .IngressRules, .EgressRules, .Instances ``` exo compute security-group source add SECURITY-GROUP-ID|NAME CIDR [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for add | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [source](https://community.exoscale.com/reference/cli/exo/compute/security-group/source/index.md) - Security Group external sources management --- url: https://community.exoscale.com/reference/cli/exo/compute/security-group/source/remove/ --- # exo compute security-group source remove ### Description This command removes an external source from a Compute instance Security Group. Supported output template annotations: .ID, .Name, .Description, .ExternalSources, .IngressRules, .EgressRules, .Instances ``` exo compute security-group source remove SECURITY-GROUP-ID|NAME CIDR [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for remove | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [source](https://community.exoscale.com/reference/cli/exo/compute/security-group/source/index.md) - Security Group external sources management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/ --- # exo compute sks ``` exo compute sks [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for sks | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute sks active-nodepool-templates](https://community.exoscale.com/reference/cli/exo/compute/sks/active-nodepool-templates/index.md) - Find active SKS nodepool templates for a Kubernetes version * [exo compute sks authority-cert](https://community.exoscale.com/reference/cli/exo/compute/sks/authority-cert/index.md) - Retrieve an authority certificate for an SKS cluster * [exo compute sks create](https://community.exoscale.com/reference/cli/exo/compute/sks/create/index.md) - Create an SKS cluster * [exo compute sks delete](https://community.exoscale.com/reference/cli/exo/compute/sks/delete/index.md) - Delete an SKS cluster * [exo compute sks deprecated-resources](https://community.exoscale.com/reference/cli/exo/compute/sks/deprecated-resources/index.md) - List resources that will be deprecated in a futur release of Kubernetes for an SKS cluster * [exo compute sks generate-karpenter-manifests](https://community.exoscale.com/reference/cli/exo/compute/sks/generate-karpenter-manifests/index.md) - Generate Karpenter-related manifests for an SKS cluster * [exo compute sks kubeconfig](https://community.exoscale.com/reference/cli/exo/compute/sks/kubeconfig/index.md) - Generate a Kubernetes kubeconfig file for an SKS cluster * [exo compute sks list](https://community.exoscale.com/reference/cli/exo/compute/sks/list/index.md) - List SKS clusters * [exo compute sks nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools * [exo compute sks rotate-ccm-credentials](https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-ccm-credentials/index.md) - Rotate the Exoscale Cloud Controller IAM credentials for an SKS cluster * [exo compute sks rotate-csi-credentials](https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-csi-credentials/index.md) - Rotate the Exoscale Container Storage Interface IAM credentials for an SKS cluster * [exo compute sks rotate-karpenter-credentials](https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-karpenter-credentials/index.md) - Rotate the Exoscale Karpenter IAM credentials for an SKS cluster * [exo compute sks rotate-operators-ca](https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-operators-ca/index.md) - Rotate the Exoscale Operators Certificate Authority for an SKS cluster * [exo compute sks show](https://community.exoscale.com/reference/cli/exo/compute/sks/show/index.md) - Show an SKS cluster details * [exo compute sks update](https://community.exoscale.com/reference/cli/exo/compute/sks/update/index.md) - Update an SKS cluster * [exo compute sks upgrade](https://community.exoscale.com/reference/cli/exo/compute/sks/upgrade/index.md) - Upgrade an SKS cluster Kubernetes version * [exo compute sks upgrade-service-level](https://community.exoscale.com/reference/cli/exo/compute/sks/upgrade-service-level/index.md) - Upgrade an SKS cluster service level * [exo compute sks versions](https://community.exoscale.com/reference/cli/exo/compute/sks/versions/index.md) - List supported SKS cluster versions --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/active-nodepool-templates/ --- # exo compute sks active-nodepool-templates ### Description This command finds active SKS nodepool templates for a given Kubernetes version. By default, both "standard" and "nvidia" variants are queried. Supported output template annotations: .KubeVersion, .Variant, .TemplateID, .Template ``` exo compute sks active-nodepool-templates KUBERNETES-VERSION [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for active-nodepool-templates | | `--variant` | nodepool template variant to resolve (standard\|nvidia) | | `--zone, -z` | zone to query in | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/authority-cert/ --- # exo compute sks authority-cert ### Description This command retrieves the certificate content for the specified Kubernetes cluster authority. Supported authorities: Supported authorities: aggregation, control-plane, kubelet ``` exo compute sks authority-cert CLUSTER-NAME|ID AUTHORITY [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for authority-cert | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/create/ --- # exo compute sks create ### Description This command creates an SKS cluster. Note: SKS cluster Nodes' kubelet configuration is set to use the Exoscale Cloud Controller Manager (CCM) as Cloud Provider by default. Cluster Nodes will remain in the "NotReady" status until the Exoscale CCM is deployed by cluster operators. Please refer to the Exoscale CCM documentation for more information: https://github.com/exoscale/exoscale-cloud-controller-manager If you do not want to use a Cloud Controller Manager, add the "--no-exoscale-ccm" option to the command. This cannot be changed once the cluster has been created. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .AutoUpgrade, .EnableKubeProxy, .Zone, .Endpoint, .Version, .ServiceLevel, .CNI, .AddOns, .AuditEnabled, .AuditEndpoint, .AuditInitialBackoff, .FeatureGates, .State, .Labels, .Nodepools, .KarpenterFeatureGates ``` exo compute sks create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--audit-bearer-token` | Bearer token for Kubernetes Audit endpoint authentication | | `--audit-endpoint` | Kubernetes Audit endpoint URL (enables audit logging when set) | | `--audit-initial-backoff` | Initial backoff for Kubernetes Audit endpoint retry (default: 10s) | | `--auto-upgrade` | enable automatic upgrading of the SKS cluster control plane Kubernetes version | | `--cni` | CNI plugin to deploy. e.g. 'calico', or 'cilium' | | `--description` | SKS cluster description | | `--enable-karpenter-addon` | deploy Karpenter node provisioner | | `--enable-kube-proxy` | deploy the Kubernetes network proxy | | `--exoscale-csi` | deploy the Exoscale Container Storage Interface on worker nodes | | `--feature-gates` | SKS cluster feature gates to enable | | `--help, -h` | help for create | | `--karpenter-feature-gates` | Karpenter feature gates to enable (only effective when the Karpenter addon is enabled) | | `--kubernetes-version` | SKS cluster control plane Kubernetes version | | `--label` | SKS cluster label (format: key=value) | | `--no-cni` | do not deploy a default Container Network Interface plugin in the cluster control plane | | `--no-exoscale-ccm` | do not deploy the Exoscale Cloud Controller Manager in the cluster control plane | | `--no-metrics-server` | do not deploy the Kubernetes Metrics Server in the cluster control plane | | `--nodepool-anti-affinity-group` | default Nodepool Anti-Affinity Group NAME\|ID (can be specified multiple times) | | `--nodepool-deploy-target` | default Nodepool Deploy Target NAME\|ID | | `--nodepool-description` | default Nodepool description | | `--nodepool-disk-size` | default Nodepool Compute instances disk size | | `--nodepool-image-gc-high-threshold` | default Nodepool the percent of disk usage after which image garbage collection is always run | | `--nodepool-image-gc-low-threshold` | default Nodepool the percent of disk usage after which image garbage collection is never run | | `--nodepool-image-gc-min-age` | default Nodepool maximum age an image can be unused before it is garbage collected | | `--nodepool-instance-prefix` | string to prefix default Nodepool member names with | | `--nodepool-instance-type` | default Nodepool Compute instances type | | `--nodepool-label` | default Nodepool label (format: key=value) | | `--nodepool-name` | default Nodepool name | | `--nodepool-nvidia-mig-profile` | default Nodepool Nvidia MIG profile to enable on the GPUs (e.g. 4g.24gb); the GPU family is inferred from the instance type | | `--nodepool-private-network` | default Nodepool Private Network NAME\|ID (can be specified multiple times) | | `--nodepool-public-ip` | Configures public IP assignment of the Instances (inet4\|dual). (default: inet4) | | `--nodepool-security-group` | default Nodepool Security Group NAME\|ID (can be specified multiple times) | | `--nodepool-size` | default Nodepool size. If 0, no default Nodepool will be added to the cluster. | | `--nodepool-taint` | Kubernetes taint to apply to default Nodepool Nodes (format: KEY=VALUE:EFFECT, can be specified multiple times) | | `--oidc-client-id` | OpenID client ID | | `--oidc-groups-claim` | OpenID JWT claim to use as the user's group | | `--oidc-groups-prefix` | OpenID prefix prepended to group claims | | `--oidc-issuer-url` | OpenID provider URL | | `--oidc-required-claim` | OpenID token required claim (format: key=value) | | `--oidc-username-claim` | OpenID JWT claim to use as the user name | | `--oidc-username-prefix` | OpenID prefix prepended to username claims | | `--service-level` | SKS cluster control plane service level (starter\|pro) | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/delete/ --- # exo compute sks delete ``` exo compute sks delete NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--nodepools, -n` | delete existing Nodepools before deleting the SKS cluster | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/deprecated-resources/ --- # exo compute sks deprecated-resources ### Description This command lists SKS cluster Nodepools. Supported output template annotations: .Group, .RemovedRelease, .Resource, .Subresource, .Version ``` exo compute sks deprecated-resources CLUSTER-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for deprecated-resources | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/generate-karpenter-manifests/ --- # exo compute sks generate-karpenter-manifests ### Description This command generates the Karpenter manifests for an SKS cluster It create the code for the Kubernetes resources "ExoscaleNodeClass" and/or "NodePool" relevant to the given cluster. Example usage: # Generate ExoscaleNodeClass and NodePool resources $ exo compute sks generate-karpenter-manifests my-cluster --zone de-fra-1 --- apiVersion: karpenter.exoscale.com/v1 kind: ExoscaleNodeClass metadata: [...] --- apiVersion: karpenter.sh/v1 kind: NodePool metadata: name: standard [...] $ exo compute sks km my-cluster -n --- apiVersion: karpenter.sh/v1 kind: NodePool metadata: name: standard [...] You can get only the NodePool or the ExoscaleNodeClass resource by using --nodepool (-n) or --exoscale-nodeclass (-e) respectively. When no flags are given, both is assumed. It's equivalent to "-en". The output can be piped to a "kubectl apply -f -" command or written to a file for further customization. Notes: * Refer to Karpenter documentation for more information on the resources NodeClasses [1] and NodePools [2] [1]: https://karpenter.sh/docs/concepts/nodeclasses/ [2]: https://karpenter.sh/docs/concepts/nodepools/ ``` exo compute sks generate-karpenter-manifests CLUSTER-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--exoscale-nodeclass, -e` | generate ExoscaleNodeclass resource with important fields pre-filled | | `--help, -h` | help for generate-karpenter-manifests | | `--nodepool, -n` | generate a Nodepool manifest to define the scaling policies and constraints for the nodes created by Karpenter | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/kubeconfig/ --- # exo compute sks kubeconfig ### Description This command generates a kubeconfig file to be used for authenticating to an SKS cluster API. The "user" command argument corresponds to the CN field of the generated X.509 client certificate. Optionally, you can specify client certificate groups using the "-g|--group" option: those groups will be set in the "O" field of the certificate. See [1] for more information about Kubernetes authentication certificates. Example usage: # Obtain "cluster-admin" credentials $ exo compute sks kubeconfig my-cluster admin \ --zone de-fra-1 \ -g system:masters \ -t $((86400 * 7)) > $HOME/.kube/my-cluster.config $ kubeconfig --kubeconfig=$HOME/.kube/my-cluster.config get pods Note: if no TTL value is specified, the API applies a default value as a safety measure. Please look up the API documentation for more information. ## Using exo CLI as Kubernetes credential plugin If you wish to avoid leaving sensitive credentials on your system, you can use exo CLI as a Kubernetes client-go credential plugin[2] to generate and return a kubeconfig dynamically when invoked by kubectl without storing it on disk. To achieve this configuration, edit your kubeconfig file so that the "users" section relating to your cluster ("my-sks-cluster" in the following example) looks like: apiVersion: v1 kind: Config clusters: - name: my-sks-cluster cluster: certificate-authority-data: **BASE64-ENCODED CLUSTER CERTIFICATE** server: https://153fcc53-1197-46ae-a8e0-ccf6d09efcb0.sks-ch-gva-2.exo.io:443 users: - name: exo@my-sks-cluster user: # The "exec" section replaces "client-certificate-data"/"client-key-data" exec: apiVersion: "client.authentication.k8s.io/v1beta1" command: exo args: - sks - kubeconfig - my-sks-cluster - --zone=ch-gva-2 - --exec-credential - user contexts: - name: my-sks-cluster context: cluster: my-sks-cluster user: exo@my-sks-cluster current-context: my-sks-cluster Notes: * The "exo" CLI binary must be installed in a directory listed in your PATH shell environment variable. * You can specify the "--group" flag in the user.exec.args section referencing a non-admin group to restrict the privileges of the operator using kubectl. [1]: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#x509-client-certs [2]: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins ``` exo compute sks kubeconfig CLUSTER-NAME|ID USER [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--exec-credential, -x` | output an ExecCredential object to use with a kubeconfig user.exec mode | | `--group, -g` | client certificate group. Can be specified multiple times. Defaults to system:masters | | `--help, -h` | help for kubeconfig | | `--ttl, -t` | client certificate validity duration in seconds | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/list/ --- # exo compute sks list ### Description This command lists SKS clusters. Supported output template annotations: .ID, .Name, .Zone, .AuditEnabled ``` exo compute sks list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/ --- # exo compute sks nodepool ``` exo compute sks nodepool [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for nodepool | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management * [exo compute sks nodepool add](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/add/index.md) - Add a Nodepool to an SKS cluster * [exo compute sks nodepool delete](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/delete/index.md) - Delete an SKS cluster Nodepool * [exo compute sks nodepool evict](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/evict/index.md) - Evict SKS cluster Nodepool members * [exo compute sks nodepool list](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/list/index.md) - List SKS cluster Nodepools * [exo compute sks nodepool scale](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/scale/index.md) - Scale an SKS cluster Nodepool size * [exo compute sks nodepool show](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/show/index.md) - Show an SKS cluster Nodepool details * [exo compute sks nodepool update](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/update/index.md) - Update an SKS cluster Nodepool --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/add/ --- # exo compute sks nodepool add ### Description This command adds a Nodepool to an SKS cluster. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .InstancePoolID, .InstancePrefix, .InstanceType, .Template, .DiskSize, .PublicIPAssignment, .IPv6, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .Version, .Size, .State, .Taints, .Labels, .NvidiaMigProfile, .AddOns, .ImageGCMin, .ImageGcLowThreshold, .ImageGcHighThreshold, .KubeletMaxPods ``` exo compute sks nodepool add CLUSTER-NAME|ID NODEPOOL-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--anti-affinity-group` | Nodepool Anti-Affinity Group NAME\|ID (can be specified multiple times) | | `--deploy-target` | Nodepool Deploy Target NAME\|ID | | `--description` | Nodepool description | | `--disk-size` | Nodepool Compute instances disk size | | `--help, -h` | help for add | | `--image-gc-high-threshold` | the percent of disk usage after which image garbage collection is always run | | `--image-gc-low-threshold` | the percent of disk usage after which image garbage collection is never run | | `--image-gc-min-age` | maximum age an image can be unused before it is garbage collected | | `--instance-prefix` | string to prefix Nodepool member names with | | `--instance-type` | Nodepool Compute instances type | | `--kubelet-max-pods` | maximum number of pods that can run on a node (default: 110) | | `--label` | Nodepool label (format: key=value) | | `--nvidia-mig-profile` | Nvidia MIG profile to enable on the Nodepool GPUs (e.g. 4g.24gb); the GPU family is inferred from the instance type | | `--private-network` | Nodepool Private Network NAME\|ID (can be specified multiple times) | | `--public-ip` | Configures public IP assignment of the Instances (inet4\|dual). (default: inet4) | | `--security-group` | Nodepool Security Group NAME\|ID (can be specified multiple times) | | `--size` | Nodepool size | | `--storage-lvm` | Create nodes with non-standard partitioning for persistent storage | | `--taint` | Kubernetes taint to apply to Nodepool Nodes (format: KEY=VALUE:EFFECT, can be specified multiple times) | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/delete/ --- # exo compute sks nodepool delete ``` exo compute sks nodepool delete CLUSTER-NAME|ID NODEPOOL-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/evict/ --- # exo compute sks nodepool evict ### Description This command evicts specific members from an SKS cluster Nodepool, effectively scaling down the Nodepool similar to the "exo compute sks nodepool scale" command. Note: Kubernetes Nodes should be drained from their workload prior to being evicted from their Nodepool, e.g. using "kubectl drain". Supported output template annotations: .ID, .Name, .Description, .CreationDate, .InstancePoolID, .InstancePrefix, .InstanceType, .Template, .DiskSize, .PublicIPAssignment, .IPv6, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .Version, .Size, .State, .Taints, .Labels, .NvidiaMigProfile, .AddOns, .ImageGCMin, .ImageGcLowThreshold, .ImageGcHighThreshold, .KubeletMaxPods ``` exo compute sks nodepool evict CLUSTER-NAME|ID NODEPOOL-NAME|ID NODE-NAME|ID... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for evict | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/list/ --- # exo compute sks nodepool list ### Description This command lists SKS cluster Nodepools. Supported output template annotations: .ID, .Name, .Cluster, .Size, .State, .Zone ``` exo compute sks nodepool list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/scale/ --- # exo compute sks nodepool scale ### Description This command scales an SKS cluster Nodepool size up (growing) or down (shrinking). In case of a scale-down, operators should use the "exo compute sks nodepool evict" command, allowing them to specify which specific Nodes should be evicted from the pool rather than leaving the decision to the SKS manager. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .InstancePoolID, .InstancePrefix, .InstanceType, .Template, .DiskSize, .PublicIPAssignment, .IPv6, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .Version, .Size, .State, .Taints, .Labels, .NvidiaMigProfile, .AddOns, .ImageGCMin, .ImageGcLowThreshold, .ImageGcHighThreshold, .KubeletMaxPods ``` exo compute sks nodepool scale CLUSTER-NAME|ID NODEPOOL-NAME|ID SIZE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for scale | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/show/ --- # exo compute sks nodepool show ### Description This command shows an SKS cluster Nodepool details. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .InstancePoolID, .InstancePrefix, .InstanceType, .Template, .DiskSize, .PublicIPAssignment, .IPv6, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .Version, .Size, .State, .Taints, .Labels, .NvidiaMigProfile, .AddOns, .ImageGCMin, .ImageGcLowThreshold, .ImageGcHighThreshold, .KubeletMaxPods ``` exo compute sks nodepool show CLUSTER-NAME|ID NODEPOOL-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/update/ --- # exo compute sks nodepool update ### Description This command updates an SKS Nodepool. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .InstancePoolID, .InstancePrefix, .InstanceType, .Template, .DiskSize, .PublicIPAssignment, .IPv6, .AntiAffinityGroups, .SecurityGroups, .PrivateNetworks, .Version, .Size, .State, .Taints, .Labels, .NvidiaMigProfile, .AddOns, .ImageGCMin, .ImageGcLowThreshold, .ImageGcHighThreshold, .KubeletMaxPods ``` exo compute sks nodepool update CLUSTER-NAME|ID NODEPOOL-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--anti-affinity-group` | Nodepool Anti-Affinity Group NAME\|ID (can be specified multiple times) | | `--deploy-target` | Nodepool Deploy Target NAME\|ID | | `--description` | Nodepool description | | `--disk-size` | Nodepool Compute instances disk size | | `--help, -h` | help for update | | `--instance-prefix` | string to prefix Nodepool member names with | | `--instance-type` | Nodepool Compute instances type | | `--ipv6` | Enable public IPv6 assignment to Nodepool nodes | | `--kubelet-max-pods` | maximum number of pods that can run on a node | | `--label` | Nodepool label (format: KEY=VALUE, can be repeated multiple times) | | `--name` | Nodepool name | | `--nvidia-mig-profile` | Nvidia MIG profile to enable on the Nodepool GPUs (e.g. 4g.24gb), empty to disable; the GPU family is inferred from the instance type | | `--private-network` | Nodepool Private Network NAME\|ID (can be specified multiple times) | | `--security-group` | Nodepool Security Group NAME\|ID (can be specified multiple times) | | `--taint` | Kubernetes taint to apply to Nodepool Nodes (format: KEY=VALUE:EFFECT, can be specified multiple times) | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [nodepool](https://community.exoscale.com/reference/cli/exo/compute/sks/nodepool/index.md) - Manage SKS cluster Nodepools --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-ccm-credentials/ --- # exo compute sks rotate-ccm-credentials ### Description This command rotates the Exoscale IAM credentials managed by the SKS control plane for the Kubernetes Exoscale Cloud Controller Manager. ``` exo compute sks rotate-ccm-credentials CLUSTER-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for rotate-ccm-credentials | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-csi-credentials/ --- # exo compute sks rotate-csi-credentials ### Description This command rotates the Exoscale IAM credentials managed by the SKS control plane for the Kubernetes Exoscale Container Storage Interface. ``` exo compute sks rotate-csi-credentials CLUSTER-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for rotate-csi-credentials | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-karpenter-credentials/ --- # exo compute sks rotate-karpenter-credentials ### Description This command rotates the Exoscale IAM credentials managed by the SKS control plane for the Kubernetes Karpenter addon. ``` exo compute sks rotate-karpenter-credentials CLUSTER-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for rotate-karpenter-credentials | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/rotate-operators-ca/ --- # exo compute sks rotate-operators-ca ### Description This command rotates the Exoscale certificate authority (CA) used by Kubernetes operators within the SKS control plane, ensuring secure communication and certificate management for cluster operations. ``` exo compute sks rotate-operators-ca CLUSTER-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for rotate-operators-ca | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/show/ --- # exo compute sks show ### Description This command shows an SKS cluster details. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .AutoUpgrade, .EnableKubeProxy, .Zone, .Endpoint, .Version, .ServiceLevel, .CNI, .AddOns, .AuditEnabled, .AuditEndpoint, .AuditInitialBackoff, .FeatureGates, .State, .Labels, .Nodepools, .KarpenterFeatureGates ``` exo compute sks show NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/update/ --- # exo compute sks update ### Description This command updates an SKS cluster. Supported output template annotations: .ID, .Name, .Description, .CreationDate, .AutoUpgrade, .EnableKubeProxy, .Zone, .Endpoint, .Version, .ServiceLevel, .CNI, .AddOns, .AuditEnabled, .AuditEndpoint, .AuditInitialBackoff, .FeatureGates, .State, .Labels, .Nodepools, .KarpenterFeatureGates ``` exo compute sks update NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--audit-bearer-token` | Bearer token for Kubernetes Audit endpoint authentication | | `--audit-enabled` | enable or disable Kubernetes Audit logging | | `--audit-endpoint` | Kubernetes Audit endpoint URL | | `--audit-initial-backoff` | Initial backoff for Kubernetes Audit endpoint retry (default: 10s) | | `--auto-upgrade` | enable automatic upgrading of the SKS cluster control plane Kubernetes version(--auto-upgrade=false to disable again) | | `--description` | SKS cluster description | | `--enable-csi-addon` | enable the Exoscale CSI driver | | `--enable-karpenter-addon` | enable the Karpenter autoscaler addon | | `--feature-gates` | SKS cluster feature gates to enable | | `--help, -h` | help for update | | `--karpenter-feature-gates` | Karpenter feature gates to enable (only effective when the Karpenter addon is enabled) | | `--label` | SKS cluster label (format: key=value) | | `--name` | SKS cluster name | | `--oidc-client-id` | OpenID client ID | | `--oidc-groups-claim` | OpenID JWT claim to use as the user's group | | `--oidc-groups-prefix` | OpenID prefix prepended to group claims | | `--oidc-issuer-url` | OpenID provider URL | | `--oidc-required-claim` | OpenID token required claim (format: key=value) | | `--oidc-username-claim` | OpenID JWT claim to use as the user name | | `--oidc-username-prefix` | OpenID prefix prepended to username claims | | `--zone, -z` | block storage zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/upgrade/ --- # exo compute sks upgrade ``` exo compute sks upgrade NAME|ID VERSION [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for upgrade | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/upgrade-service-level/ --- # exo compute sks upgrade-service-level ### Description This command upgrades an SKS cluster's service level to "pro". Note: once upgraded to pro, an SKS cluster service level cannot be downgraded to a lower level. ``` exo compute sks upgrade-service-level NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for upgrade-service-level | | `--zone, -z` | SKS cluster zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/sks/versions/ --- # exo compute sks versions ### Description This command lists supported SKS cluster versions. Supported output template annotations: .Version ``` exo compute sks versions [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for versions | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [sks](https://community.exoscale.com/reference/cli/exo/compute/sks/index.md) - Scalable Kubernetes Service management --- url: https://community.exoscale.com/reference/cli/exo/compute/ssh-key/ --- # exo compute ssh-key ``` exo compute ssh-key [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for ssh-key | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [compute](https://community.exoscale.com/reference/cli/exo/compute/index.md) - Compute services management * [exo compute ssh-key delete](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/delete/index.md) - Delete an SSH key * [exo compute ssh-key list](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/list/index.md) - List SSH keys * [exo compute ssh-key register](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/register/index.md) - Register an SSH key * [exo compute ssh-key show](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/show/index.md) - Show an SSH key details --- url: https://community.exoscale.com/reference/cli/exo/compute/ssh-key/delete/ --- # exo compute ssh-key delete ``` exo compute ssh-key delete NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [ssh-key](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/index.md) - SSH keys management --- url: https://community.exoscale.com/reference/cli/exo/compute/ssh-key/list/ --- # exo compute ssh-key list ### Description This command lists SSH keys. Supported output template annotations: .Name, .Fingerprint ``` exo compute ssh-key list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [ssh-key](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/index.md) - SSH keys management --- url: https://community.exoscale.com/reference/cli/exo/compute/ssh-key/register/ --- # exo compute ssh-key register ### Description This command registers a new SSH key. Supported output template annotations: .Name, .Fingerprint ``` exo compute ssh-key register NAME PUBLIC-KEY-FILE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for register | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [ssh-key](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/index.md) - SSH keys management --- url: https://community.exoscale.com/reference/cli/exo/compute/ssh-key/show/ --- # exo compute ssh-key show ### Description This command shows an SSH key details. Supported output template annotations: .Name, .Fingerprint ``` exo compute ssh-key show KEY [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [ssh-key](https://community.exoscale.com/reference/cli/exo/compute/ssh-key/index.md) - SSH keys management --- url: https://community.exoscale.com/reference/cli/exo/config/ --- # exo config ``` exo config [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for config | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo config add](https://community.exoscale.com/reference/cli/exo/config/add/index.md) - Add a new account to configuration * [exo config delete](https://community.exoscale.com/reference/cli/exo/config/delete/index.md) - Delete an account from configuration * [exo config list](https://community.exoscale.com/reference/cli/exo/config/list/index.md) - List available accounts * [exo config set](https://community.exoscale.com/reference/cli/exo/config/set/index.md) - Set an account as default account * [exo config show](https://community.exoscale.com/reference/cli/exo/config/show/index.md) - Show an account details --- url: https://community.exoscale.com/reference/cli/exo/config/add/ --- # exo config add ``` exo config add [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for add | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [config](https://community.exoscale.com/reference/cli/exo/config/index.md) - Exoscale CLI configuration management --- url: https://community.exoscale.com/reference/cli/exo/config/delete/ --- # exo config delete ``` exo config delete NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [config](https://community.exoscale.com/reference/cli/exo/config/index.md) - Exoscale CLI configuration management --- url: https://community.exoscale.com/reference/cli/exo/config/list/ --- # exo config list ### Description This command lists configured Exoscale accounts. The default account is marked with (*). Supported output template annotations: .Name, .Default ``` exo config list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [config](https://community.exoscale.com/reference/cli/exo/config/index.md) - Exoscale CLI configuration management --- url: https://community.exoscale.com/reference/cli/exo/config/set/ --- # exo config set ``` exo config set NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for set | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [config](https://community.exoscale.com/reference/cli/exo/config/index.md) - Exoscale CLI configuration management --- url: https://community.exoscale.com/reference/cli/exo/config/show/ --- # exo config show ### Description This command shows an Exoscale account details. Supported output template annotations: .Name, .APIKey, .APISecret, .Endpoint, .DefaultZone, .DefaultTemplate, .StorageAPIEndpoint, .ConfigFile, .ClientTimeout ``` exo config show NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [config](https://community.exoscale.com/reference/cli/exo/config/index.md) - Exoscale CLI configuration management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/ --- # exo dbaas ``` exo dbaas [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for dbaas | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo dbaas acl](https://community.exoscale.com/reference/cli/exo/dbaas/acl/index.md) - Manage DBaaS ACL configuration * [exo dbaas ca-certificate](https://community.exoscale.com/reference/cli/exo/dbaas/ca-certificate/index.md) - Retrieve the Database CA certificate * [exo dbaas create](https://community.exoscale.com/reference/cli/exo/dbaas/create/index.md) - Create a Database Service * [exo dbaas database](https://community.exoscale.com/reference/cli/exo/dbaas/database/index.md) - Manage DBaaS databases * [exo dbaas delete](https://community.exoscale.com/reference/cli/exo/dbaas/delete/index.md) - Delete a Database Service * [exo dbaas external-endpoint](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/index.md) - Manage DBaaS external endpoints * [exo dbaas external-integration](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/index.md) - Manage DBaaS external integrations * [exo dbaas list](https://community.exoscale.com/reference/cli/exo/dbaas/list/index.md) - List Database Services * [exo dbaas logs](https://community.exoscale.com/reference/cli/exo/dbaas/logs/index.md) - Query a Database Service logs * [exo dbaas metrics](https://community.exoscale.com/reference/cli/exo/dbaas/metrics/index.md) - Query a Database Service metrics over time * [exo dbaas migration](https://community.exoscale.com/reference/cli/exo/dbaas/migration/index.md) - database migration management * [exo dbaas read-replica](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/index.md) - Manage Database Service read replicas * [exo dbaas role](https://community.exoscale.com/reference/cli/exo/dbaas/role/index.md) - Manage DBaaS roles * [exo dbaas show](https://community.exoscale.com/reference/cli/exo/dbaas/show/index.md) - Show a Database Service details * [exo dbaas type](https://community.exoscale.com/reference/cli/exo/dbaas/type/index.md) - Database Services types management * [exo dbaas update](https://community.exoscale.com/reference/cli/exo/dbaas/update/index.md) - Update Database Service * [exo dbaas user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dbaas/acl/ --- # exo dbaas acl ``` exo dbaas acl [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for acl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas acl show](https://community.exoscale.com/reference/cli/exo/dbaas/acl/show/index.md) - Show ClickHouse ACL configuration --- url: https://community.exoscale.com/reference/cli/exo/dbaas/acl/show/ --- # exo dbaas acl show ### Description Show the current ClickHouse ACL configuration for a DBaaS service. ``` exo dbaas acl show NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [acl](https://community.exoscale.com/reference/cli/exo/dbaas/acl/index.md) - Manage DBaaS ACL configuration --- url: https://community.exoscale.com/reference/cli/exo/dbaas/ca-certificate/ --- # exo dbaas ca-certificate ### Description This command retrieves the Exoscale organization-level CA certificate required to access Database Services using a TLS connection. ``` exo dbaas ca-certificate [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for ca-certificate | | `--zone, -z` | | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/create/ --- # exo dbaas create ### Description This command creates a Database Service. Supported values for --maintenance-dow: never, monday, tuesday, wednesday, thursday, friday, saturday, sunday Supported output template annotations: .CreationDate, .DiskSize, .Maintenance, .Name, .NodeCPUs, .NodeMemory, .Nodes, .Plan, .State, .TerminationProtection, .Type, .UpdateDate, .Zone, .Grafana, .Kafka, .Mysql, .PG, .Valkey, .Opensearch, .Thanos, .Clickhouse ``` exo dbaas create TYPE PLAN NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--clickhouse-fork-from` | name of a Database Service to fork from | | `--clickhouse-ip-filter` | allow incoming connections from CIDR address block | | `--clickhouse-recovery-backup-name` | the name of the backup to restore when forking from a Database Service | | `--clickhouse-settings` | ClickHouse configuration settings (JSON format) | | `--clickhouse-version` | ClickHouse major version | | `--grafana-fork-from` | name of a Database Service to fork from | | `--grafana-ip-filter` | allow incoming connections from CIDR address block | | `--grafana-settings` | Grafana configuration settings (JSON format) | | `--help, -h` | help for create | | `--help-clickhouse` | show usage for flags specific to the clickhouse type | | `--help-grafana` | show usage for flags specific to the grafana type | | `--help-kafka` | show usage for flags specific to the kafka type | | `--help-mysql` | show usage for flags specific to the mysql type | | `--help-opensearch` | show usage for flags specific to the opensearch type | | `--help-pg` | show usage for flags specific to the pg type | | `--help-thanos` | show usage for flags specific to the thanos type | | `--help-valkey` | show usage for flags specific to the valkey type | | `--kafka-connect-settings` | Kafka Connect configuration settings (JSON format) | | `--kafka-enable-cert-auth` | enable certificate-based authentication method | | `--kafka-enable-kafka-connect` | enable Kafka Connect | | `--kafka-enable-kafka-rest` | enable Kafka REST | | `--kafka-enable-sasl-auth` | enable SASL-based authentication method | | `--kafka-enable-schema-registry` | enable Schema Registry | | `--kafka-ip-filter` | allow incoming connections from CIDR address block | | `--kafka-rest-settings` | Kafka REST configuration settings (JSON format) | | `--kafka-schema-registry-settings` | Schema Registry configuration settings (JSON format) | | `--kafka-settings` | Kafka configuration settings (JSON format) | | `--kafka-version` | Kafka major version | | `--maintenance-dow` | automated Database Service maintenance day-of-week | | `--maintenance-time` | automated Database Service maintenance time (format HH:MM:SS) | | `--mysql-admin-password` | custom password for admin user | | `--mysql-admin-username` | custom username for admin user | | `--mysql-backup-schedule` | automated backup schedule (format: HH:MM) | | `--mysql-binlog-retention-period` | the minimum amount of time in seconds to keep binlog entries before deletion | | `--mysql-fork-from` | name of a Database Service to fork from | | `--mysql-ip-filter` | allow incoming connections from CIDR address block | | `--mysql-migration-dbname` | database name for bootstrapping the initial connection | | `--mysql-migration-host` | hostname or IP address of the source server where to migrate data from | | `--mysql-migration-ignore-dbs` | list of databases which should be ignored during migration | | `--mysql-migration-method` | migration method to be used ("dump" or "replication") | | `--mysql-migration-password` | password for authenticating to the source server | | `--mysql-migration-port` | port number of the source server where to migrate data from | | `--mysql-migration-ssl` | connect to the source server using SSL | | `--mysql-migration-username` | username for authenticating to the source server | | `--mysql-recovery-backup-time` | the timestamp of the backup to restore when forking from a Database Service | | `--mysql-settings` | MySQL configuration settings (JSON format) | | `--mysql-version` | MySQL major version | | `--opensearch-dashboard-enabled` | Enable or disable OpenSearch Dashboards (default: true) | | `--opensearch-dashboard-max-old-space-size` | Memory limit in MiB for OpenSearch Dashboards. Note: The memory reserved by OpenSearch Dashboards is not available for OpenSearch. (default: 128) | | `--opensearch-dashboard-request-timeout` | Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch (default: 30000) | | `--opensearch-fork-from-service` | Service name | | `--opensearch-index-patterns` | JSON Array of index patterns (https://community.exoscale.com/reference/api/_schemas/index-patterns/) | | `--opensearch-index-template-mapping-nested-objects-limit` | The maximum number of nested cli-flag objects that a single document can contain across all nested types. Default is 10000. | | `--opensearch-index-template-number-of-replicas` | The number of replicas each primary shard has. | | `--opensearch-index-template-number-of-shards` | The number of primary shards that an index should have. | | `--opensearch-ip-filter` | Allow incoming connections from CIDR address block | | `--opensearch-keep-index-refresh-interval` | index.refresh_interval is reset to default value for every index to be sure that indices are always visible to search. Set to true disable this. | | `--opensearch-recovery-backup-name` | Name of a backup to recover from for services that support backup names | | `--opensearch-settings` | OpenSearch-specific settings (JSON) | | `--opensearch-version` | OpenSearch major version | | `--pg-admin-password` | custom password for admin user | | `--pg-admin-username` | custom username for admin user | | `--pg-backup-schedule` | automated backup schedule (format: HH:MM) | | `--pg-bouncer-settings` | PgBouncer configuration settings (JSON format) | | `--pg-fork-from` | name of a Database Service to fork from | | `--pg-ip-filter` | allow incoming connections from CIDR address block | | `--pg-lookout-settings` | pglookout configuration settings (JSON format) | | `--pg-migration-dbname` | database name for bootstrapping the initial connection | | `--pg-migration-host` | hostname or IP address of the source server where to migrate data from | | `--pg-migration-ignore-dbs` | list of databases which should be ignored during migration | | `--pg-migration-method` | migration method to be used ("dump" or "replication") | | `--pg-migration-password` | password for authenticating to the source server | | `--pg-migration-port` | port number of the source server where to migrate data from | | `--pg-migration-ssl` | connect to the source server using SSL | | `--pg-migration-username` | username for authenticating to the source server | | `--pg-recovery-backup-time` | the timestamp of the backup to restore when forking from a Database Service | | `--pg-settings` | PostgreSQL configuration settings (JSON format) | | `--pg-shared-buffers-percentage` | percentage of total RAM for shared memory buffers (valid range: 20-60) | | `--pg-synchronous-replication` | synchronous replication type (quorum or off) | | `--pg-timescaledb-settings` | TimescaleDB extension configuration settings (JSON format) | | `--pg-variant` | PostgreSQL variant (timescale or aiven) | | `--pg-version` | PostgreSQL major version | | `--pg-work-mem` | maximum memory for query operations before writing to temporary disk files, in MB | | `--termination-protection` | enable Database Service termination protection; set --termination-protection=false to disable | | `--thanos-ip-filter` | allow incoming connections from CIDR address block | | `--thanos-settings` | Thanos configuration settings (JSON format) | | `--valkey-fork-from` | name of a Database Service to fork from | | `--valkey-ip-filter` | allow incoming connections from CIDR address block | | `--valkey-migration-dbname` | database name for bootstrapping the initial connection | | `--valkey-migration-host` | hostname or IP address of the source server where to migrate data from | | `--valkey-migration-ignore-dbs` | list of databases which should be ignored during migration | | `--valkey-migration-method` | migration method to be used ("dump" or "replication") | | `--valkey-migration-password` | password for authenticating to the source server | | `--valkey-migration-port` | port number of the source server where to migrate data from | | `--valkey-migration-ssl` | connect to the source server using SSL | | `--valkey-migration-username` | username for authenticating to the source server | | `--valkey-recovery-backup-name` | the name of the backup to restore when forking from a Database Service | | `--valkey-settings` | Valkey configuration settings (JSON format) | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/database/ --- # exo dbaas database ``` exo dbaas database [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for database | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas database create](https://community.exoscale.com/reference/cli/exo/dbaas/database/create/index.md) - Create DBAAS database * [exo dbaas database delete](https://community.exoscale.com/reference/cli/exo/dbaas/database/delete/index.md) - Delete DBAAS database --- url: https://community.exoscale.com/reference/cli/exo/dbaas/database/create/ --- # exo dbaas database create ### Description This command creates a DBAAS database for the specified service. ``` exo dbaas database create NAME DATABASE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--help-pg` | show usage for flags specific to the pg type | | `--pg-lc-collate` | Default string sort order (LC_COLLATE) for PostgreSQL database | | `--pg-lc-ctype` | Default character classification (LC_CTYPE) for PostgreSQL database | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [database](https://community.exoscale.com/reference/cli/exo/dbaas/database/index.md) - Manage DBaaS databases --- url: https://community.exoscale.com/reference/cli/exo/dbaas/database/delete/ --- # exo dbaas database delete ### Description This command deletes a DBAAS database for the specified service. ``` exo dbaas database delete NAME DATABASE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [database](https://community.exoscale.com/reference/cli/exo/dbaas/database/index.md) - Manage DBaaS databases --- url: https://community.exoscale.com/reference/cli/exo/dbaas/delete/ --- # exo dbaas delete ``` exo dbaas delete NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/ --- # exo dbaas external-endpoint ``` exo dbaas external-endpoint [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for external-endpoint | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas external-endpoint create](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/create/index.md) - Create a new external endpoint for DBaaS * [exo dbaas external-endpoint delete](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/delete/index.md) - Delete a DBaaS external endpoint * [exo dbaas external-endpoint list](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/list/index.md) - List External Endpoints * [exo dbaas external-endpoint show](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/show/index.md) - Show a Database External endpoint details * [exo dbaas external-endpoint update](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/update/index.md) - Update an existing external endpoint for DBaaS --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/create/ --- # exo dbaas external-endpoint create ### Description Create a new external endpoint for DBaaS ``` exo dbaas external-endpoint create TYPE NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--datadog-api-key` | Datadog API key | | `--datadog-disable-consumer-stats` | Disable consumer group metrics | | `--datadog-kafka-consumer-check-instances` | Number of separate instances to fetch kafka consumer statistics with | | `--datadog-kafka-consumer-stats-timeout` | Number of seconds that datadog will wait to get consumer statistics from brokers | | `--datadog-max-partition-contexts` | Maximum number of partition contexts to send | | `--datadog-site` | Datadog intake site. Defaults to datadoghq.com | | `--datadog-tags` | Datadog tags. Example. '[{"comment": "ex", "tag": "aiven-asdfasda"}]' | | `--elasticsearch-ca` | PEM encoded CA certificate | | `--elasticsearch-index-days-max` | Maximum number of days of logs to keep | | `--elasticsearch-index-prefix` | Elasticsearch index prefix | | `--elasticsearch-timeout` | Elasticsearch request timeout limit | | `--elasticsearch-url` | Elasticsearch connection URL | | `--help, -h` | help for create | | `--help-datadog` | show usage for flags specific to the datadog external endpoint type | | `--help-elasticsearch` | show usage for flags specific to the elasticsearch external endpoint type | | `--help-opensearch` | show usage for flags specific to the opensearch external endpoint type | | `--help-prometheus` | show usage for flags specific to the prometheus external endpoint type | | `--help-rsyslog` | show usage for flags specific to the rsyslog external endpoint type | | `--opensearch-ca` | PEM encoded CA certificate | | `--opensearch-index-days-max` | Maximum number of days of logs to keep | | `--opensearch-index-prefix` | OpenSearch index prefix | | `--opensearch-timeout` | OpenSearch request timeout limit | | `--opensearch-url` | OpenSearch connection URL | | `--prometheus-basic-auth-password` | Prometheus basic authentication password | | `--prometheus-basic-auth-username` | Prometheus basic authentication username | | `--rsyslog-ca` | PEM encoded CA certificate | | `--rsyslog-cert` | PEM encoded client certificate | | `--rsyslog-format` | Message format | | `--rsyslog-key` | PEM encoded client key | | `--rsyslog-logline` | Custom syslog message format | | `--rsyslog-max-message-size` | Rsyslog max message size | | `--rsyslog-port` | Rsyslog server port | | `--rsyslog-sd` | Structured data block for log message | | `--rsyslog-server` | Rsyslog server IP address or hostname | | `--rsyslog-tls` | Require TLS | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-endpoint](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/index.md) - Manage DBaaS external endpoints --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/delete/ --- # exo dbaas external-endpoint delete ### Description Delete a DBaaS external endpoint ``` exo dbaas external-endpoint delete TYPE ENDPOINT-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-endpoint](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/index.md) - Manage DBaaS external endpoints --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/list/ --- # exo dbaas external-endpoint list ### Description List External Endpoints ``` exo dbaas external-endpoint list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-endpoint](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/index.md) - Manage DBaaS external endpoints --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/show/ --- # exo dbaas external-endpoint show ### Description This command shows a Database Service external endpoint details. ``` exo dbaas external-endpoint show TYPE ENDPOINT-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-endpoint](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/index.md) - Manage DBaaS external endpoints --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/update/ --- # exo dbaas external-endpoint update ### Description Update an existing external endpoint for DBaaS ``` exo dbaas external-endpoint update TYPE ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--datadog-api-key` | Datadog API key | | `--datadog-disable-consumer-stats` | Disable consumer group metrics | | `--datadog-kafka-consumer-check-instances` | Number of separate instances to fetch kafka consumer statistics with | | `--datadog-kafka-consumer-stats-timeout` | Number of seconds that datadog will wait to get consumer statistics from brokers | | `--datadog-max-partition-contexts` | Maximum number of partition contexts to send | | `--datadog-site` | Datadog intake site. Defaults to datadoghq.com | | `--datadog-tags` | Datadog tags. Example. '[{"comment": "ex", "tag": "aiven-asdfasda"}]' | | `--elasticsearch-ca` | PEM encoded CA certificate | | `--elasticsearch-index-days-max` | Maximum number of days of logs to keep | | `--elasticsearch-index-prefix` | Elasticsearch index prefix | | `--elasticsearch-timeout` | Elasticsearch request timeout limit | | `--elasticsearch-url` | Elasticsearch connection URL | | `--help, -h` | help for update | | `--help-datadog` | show usage for flags specific to the datadog external endpoint type | | `--help-elasticsearch` | show usage for flags specific to the elasticsearch external endpoint type | | `--help-opensearch` | show usage for flags specific to the opensearch external endpoint type | | `--help-prometheus` | show usage for flags specific to the prometheus external endpoint type | | `--help-rsyslog` | show usage for flags specific to the rsyslog external endpoint type | | `--opensearch-ca` | PEM encoded CA certificate | | `--opensearch-index-days-max` | Maximum number of days of logs to keep | | `--opensearch-index-prefix` | OpenSearch index prefix | | `--opensearch-timeout` | OpenSearch request timeout limit | | `--opensearch-url` | OpenSearch connection URL | | `--prometheus-basic-auth-password` | Prometheus basic authentication password | | `--prometheus-basic-auth-username` | Prometheus basic authentication username | | `--rsyslog-ca` | PEM encoded CA certificate | | `--rsyslog-cert` | PEM encoded client certificate | | `--rsyslog-format` | Message format | | `--rsyslog-key` | PEM encoded client key | | `--rsyslog-logline` | Custom syslog message format | | `--rsyslog-max-message-size` | Rsyslog max message size | | `--rsyslog-port` | Rsyslog server port | | `--rsyslog-sd` | Structured data block for log message | | `--rsyslog-server` | Rsyslog server IP address or hostname | | `--rsyslog-tls` | Require TLS | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-endpoint](https://community.exoscale.com/reference/cli/exo/dbaas/external-endpoint/index.md) - Manage DBaaS external endpoints --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/ --- # exo dbaas external-integration ``` exo dbaas external-integration [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for external-integration | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas external-integration attach](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/attach/index.md) - Attach a DBaaS service to an external endpoint * [exo dbaas external-integration detach](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/detach/index.md) - Detach a DBaaS service from an external endpoint * [exo dbaas external-integration list](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/list/index.md) - List External Integrations * [exo dbaas external-integration settings](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/index.md) - External integration settings management * [exo dbaas external-integration show](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/show/index.md) - Show External Integration --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/attach/ --- # exo dbaas external-integration attach ### Description Enable sending data from an existing DBaaS service to an external endpoint ``` exo dbaas external-integration attach TYPE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--destination-endpoint-id` | Destination external endpoint id | | `--help, -h` | help for attach | | `--source-service-name` | DBaaS source service name | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-integration](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/index.md) - Manage DBaaS external integrations --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/detach/ --- # exo dbaas external-integration detach ### Description Disable sending data from an existing DBaaS service to an external endpoint ``` exo dbaas external-integration detach SOURCE-SERVICE-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for detach | | `--integration-id` | External integration id | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-integration](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/index.md) - Manage DBaaS external integrations --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/list/ --- # exo dbaas external-integration list ### Description List External Integrations ``` exo dbaas external-integration list SERVICE-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-integration](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/index.md) - Manage DBaaS external integrations --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/ --- # exo dbaas external-integration settings ``` exo dbaas external-integration settings [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for settings | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-integration](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/index.md) - Manage DBaaS external integrations * [exo dbaas external-integration settings show](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/show/index.md) - Show External Integration Settings * [exo dbaas external-integration settings update](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/update/index.md) - Update external integration settings --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/show/ --- # exo dbaas external-integration settings show ### Description Show External Integration Settings ``` exo dbaas external-integration settings show TYPE INTEGRATION-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [settings](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/index.md) - External integration settings management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/update/ --- # exo dbaas external-integration settings update ### Description Update external integration settings ``` exo dbaas external-integration settings update TYPE INTEGRATION-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--datadog-dbm-enabled` | Enable/Disable pg stats with Datadog | | `--datadog-pgbouncer-enabled` | Enable/Disable pgbouncer stats with Datadog | | `--help, -h` | help for update | | `--help-datadog` | show usage for flags specific to the datadog external integration type | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [settings](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/settings/index.md) - External integration settings management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/show/ --- # exo dbaas external-integration show ### Description Show External Integration ``` exo dbaas external-integration show INTEGRATION-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [external-integration](https://community.exoscale.com/reference/cli/exo/dbaas/external-integration/index.md) - Manage DBaaS external integrations --- url: https://community.exoscale.com/reference/cli/exo/dbaas/list/ --- # exo dbaas list ### Description This command lists Database Services. Supported output template annotations: .Name, .Type, .Plan, .Zone ``` exo dbaas list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/logs/ --- # exo dbaas logs ### Description This command outputs a Database Service logs. Supported output template annotations: .FirstLogOffset, .Offset, .Logs - .Logs: .Time, .Node, .Unit, .Message Example usage with custom output containing only the actual log messages: exo dbaas logs MY-SERVICE --output-template \ '{{range $l := .Logs}}{{println $l.Message}}{{end}}' ``` exo dbaas logs NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for logs | | `--limit, -l` | number of log messages to retrieve | | `--offset, -o` | opaque offset identifier (can be found in the JSON output of the command) | | `--sort` | log messages sorting order (asc\|desc) | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/metrics/ --- # exo dbaas metrics ### Description This command outputs a Database Service raw metrics for the specified time period in JSON format. ``` exo dbaas metrics NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for metrics | | `--period` | metrics time period to retrieve | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/migration/ --- # exo dbaas migration ``` exo dbaas migration [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for migration | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas migration status](https://community.exoscale.com/reference/cli/exo/dbaas/migration/status/index.md) - Migration status of a Database * [exo dbaas migration stop](https://community.exoscale.com/reference/cli/exo/dbaas/migration/stop/index.md) - Stop running migration of a Database --- url: https://community.exoscale.com/reference/cli/exo/dbaas/migration/status/ --- # exo dbaas migration status ### Description This command shows the status of the migration of a Database. ``` exo dbaas migration status NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for status | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [migration](https://community.exoscale.com/reference/cli/exo/dbaas/migration/index.md) - database migration management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/migration/stop/ --- # exo dbaas migration stop ### Description This command stops the currently running migration of a Database. ``` exo dbaas migration stop NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for stop | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [migration](https://community.exoscale.com/reference/cli/exo/dbaas/migration/index.md) - database migration management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/ --- # exo dbaas read-replica ``` exo dbaas read-replica [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for read-replica | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas read-replica create](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/create/index.md) - Create a Database Service read replica * [exo dbaas read-replica list](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/list/index.md) - List Database Service read replicas * [exo dbaas read-replica promote](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/promote/index.md) - Promote a Database Service read replica to a standalone primary * [exo dbaas read-replica show](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/show/index.md) - Show Database Service read replica details --- url: https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/create/ --- # exo dbaas read-replica create ### Description Create a read replica for an existing PostgreSQL or MySQL/MariaDB primary Database Service. The replica can be created in a different zone than the primary. ``` exo dbaas read-replica create READ-REPLICA-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--plan` | subscription plan | | `--replica-zone, -z` | zone where the replica will be created | | `--source-service` | name of the primary service | | `--termination-protection` | enable Database Service termination protection; set --termination-protection=false to disable | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [read-replica](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/index.md) - Manage Database Service read replicas --- url: https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/list/ --- # exo dbaas read-replica list ### Description List all read replicas of a primary Database Service across all zones. ``` exo dbaas read-replica list SERVICE-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [read-replica](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/index.md) - Manage Database Service read replicas --- url: https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/promote/ --- # exo dbaas read-replica promote ### Description Promote a read replica to a standalone primary Database Service. This breaks the replication link. ``` exo dbaas read-replica promote REPLICA-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for promote | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [read-replica](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/index.md) - Manage Database Service read replicas --- url: https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/show/ --- # exo dbaas read-replica show ### Description Show details of a specific Database Service read replica. ``` exo dbaas read-replica show REPLICA-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [read-replica](https://community.exoscale.com/reference/cli/exo/dbaas/read-replica/index.md) - Manage Database Service read replicas --- url: https://community.exoscale.com/reference/cli/exo/dbaas/role/ --- # exo dbaas role ``` exo dbaas role [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for role | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas role delete](https://community.exoscale.com/reference/cli/exo/dbaas/role/delete/index.md) - Delete a ClickHouse role * [exo dbaas role list](https://community.exoscale.com/reference/cli/exo/dbaas/role/list/index.md) - List ClickHouse roles --- url: https://community.exoscale.com/reference/cli/exo/dbaas/role/delete/ --- # exo dbaas role delete ### Description Delete a role from a ClickHouse DBaaS service by UUID. ``` exo dbaas role delete NAME ROLE-UUID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/dbaas/role/index.md) - Manage DBaaS roles --- url: https://community.exoscale.com/reference/cli/exo/dbaas/role/list/ --- # exo dbaas role list ### Description List roles for a ClickHouse DBaaS service. ``` exo dbaas role list NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/dbaas/role/index.md) - Manage DBaaS roles --- url: https://community.exoscale.com/reference/cli/exo/dbaas/show/ --- # exo dbaas show ### Description This command shows a Database Service details. Supported output template annotations: * When showing a Database Service: .CreationDate, .DiskSize, .Maintenance, .Name, .NodeCPUs, .NodeMemory, .Nodes, .Plan, .State, .TerminationProtection, .Type, .UpdateDate, .Zone, .Grafana, .Kafka, .Mysql, .PG, .Valkey, .Opensearch, .Thanos, .Clickhouse - .Kafka: .ACL, .AuthenticationMethods, .Components, .ConnectionInfo, .IPFilter, .KafkaConnectEnabled, .KafkaRESTEnabled, .SchemaRegistryEnabled, .URI, .URIParams, .Users, .Version - .Kafka.ACL[]: .ID, .Permission, .Topic, .Username - .Kafka.AuthenticationMethods: .Certificate, .SASL - .Kafka.Components[]: .AuthenticationMethod, .Component, .Host, .Port, .Route, .Usage - .Kafka.ConnectionInfo: .AccessCert, .AccessKey, .Nodes, .RegistryURI, .RestURI - .Kafka.Users[]: .AccessCert, .AccessCertExpiry, .AccessKey, .Password, .Type, .Username - .Opensearch: .IPFilter, .URI, .URIParams, .Version, .Components, .ConnectionInfo, .Description, .IndexPatterns, .IndexTemplate, .KeepIndexRefreshInterval, .Dashboard, .Users - .Mysql: .BackupSchedule, .Components, .Databases, .IPFilter, .URI, .URIParams, .Users, .Version - .Mysql.Components[]: .Component, .Host, .Port, .Route, .Usage - .Mysql.Users[]: .Password, .Type, .Username - .PG: .BackupSchedule, .Components, .Databases, .ConnectionPools, .IPFilter, .SharedBuffersPercentage, .SynchronousReplication, .TimescaledbSettings, .URI, .URIParams, .Users, .Version, .WorkMem - .PG.Components[]: .Component, .Host, .Port, .Route, .Usage - .PG.ConnectionPools: .ConnectionURI, .Database, .Mode, .Name, .Size, .Username - .PG.Users[]: .AllowReplication, .Password, .Type, .Username * When showing a Database Service backups: .Name, .Date, .Size * When showing a Database Service notifications: .Level, .Message, .Type ``` exo dbaas show NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--backups` | show Database Service backups | | `--help, -h` | help for show | | `--notifications` | show Database Service notifications | | `--settings` | show Database Service settings (see "exo dbaas type show --help" for supported settings) | | `--uri` | show Database Service connection URI | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/type/ --- # exo dbaas type ``` exo dbaas type [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for type | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas type list](https://community.exoscale.com/reference/cli/exo/dbaas/type/list/index.md) - List Database Service types * [exo dbaas type show](https://community.exoscale.com/reference/cli/exo/dbaas/type/show/index.md) - Show a Database Service type details --- url: https://community.exoscale.com/reference/cli/exo/dbaas/type/list/ --- # exo dbaas type list ### Description This command lists available Database Service types. Supported output template annotations: .Name, .AvailableVersions, .DefaultVersion ``` exo dbaas type list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [type](https://community.exoscale.com/reference/cli/exo/dbaas/type/index.md) - Database Services types management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/type/show/ --- # exo dbaas type show ### Description This command shows a Database Service type details. Supported Database Service type settings: * grafana * opensearch * kafka, kafka-rest, kafka-connect, schema-registry * mysql * pg, pgbouncer, pglookout, timescaledb * valkey * thanos, compactor, query, query-frontend Supported output template annotations: * When showing a Database Service: .Name, .Description, .AvailableVersions, .DefaultVersion * When listing Database Service plans: .Name, .Nodes, .NodeCPUs, .NodeMemory, .DiskSpace, .Authorized ``` exo dbaas type show NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--backup-config` | show backup configuration for the Database Service type and Plan | | `--help, -h` | help for show | | `--plans` | list plans offered for the Database Service type | | `--settings` | show settings supported by the Database Service type | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [type](https://community.exoscale.com/reference/cli/exo/dbaas/type/index.md) - Database Services types management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/update/ --- # exo dbaas update ### Description This command updates a Database Service. Supported values for --maintenance-dow: never, monday, tuesday, wednesday, thursday, friday, saturday, sunday Supported output template annotations: .CreationDate, .DiskSize, .Maintenance, .Name, .NodeCPUs, .NodeMemory, .Nodes, .Plan, .State, .TerminationProtection, .Type, .UpdateDate, .Zone, .Grafana, .Kafka, .Mysql, .PG, .Valkey, .Opensearch, .Thanos, .Clickhouse ``` exo dbaas update NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--clickhouse-ip-filter` | allow incoming connections from CIDR address block | | `--clickhouse-settings` | ClickHouse configuration settings (JSON format) | | `--clickhouse-version` | ClickHouse major version | | `--force, -f` | don't prompt for confirmation before updating | | `--grafana-ip-filter` | allow incoming connections from CIDR address block | | `--grafana-settings` | MySQL configuration settings (JSON format) | | `--help, -h` | help for update | | `--help-clickhouse` | show usage for flags specific to the clickhouse type | | `--help-grafana` | show usage for flags specific to the grafana type | | `--help-kafka` | show usage for flags specific to the kafka type | | `--help-mysql` | show usage for flags specific to the mysql type | | `--help-opensearch` | show usage for flags specific to the opensearch type | | `--help-pg` | show usage for flags specific to the pg type | | `--help-thanos` | show usage for flags specific to the thanos type | | `--help-valkey` | show usage for flags specific to the valkey type | | `--kafka-connect-settings` | Kafka Connect configuration settings (JSON format) | | `--kafka-enable-cert-auth` | enable certificate-based authentication method | | `--kafka-enable-kafka-connect` | enable Kafka Connect | | `--kafka-enable-kafka-rest` | enable Kafka REST | | `--kafka-enable-sasl-auth` | enable SASL-based authentication method | | `--kafka-enable-schema-registry` | enable Schema Registry | | `--kafka-ip-filter` | allow incoming connections from CIDR address block | | `--kafka-rest-settings` | Kafka REST configuration settings (JSON format) | | `--kafka-schema-registry-settings` | Schema Registry configuration settings (JSON format) | | `--kafka-settings` | Kafka configuration settings (JSON format) | | `--maintenance-dow` | automated Database Service maintenance day-of-week | | `--maintenance-time` | automated Database Service maintenance time (format HH:MM:SS) | | `--mysql-backup-schedule` | automated backup schedule (format: HH:MM) | | `--mysql-binlog-retention-period` | the minimum amount of time in seconds to keep binlog entries before deletion | | `--mysql-ip-filter` | allow incoming connections from CIDR address block | | `--mysql-migration-dbname` | database name for bootstrapping the initial connection | | `--mysql-migration-host` | hostname or IP address of the source server where to migrate data from | | `--mysql-migration-ignore-dbs` | list of databases which should be ignored during migration | | `--mysql-migration-method` | migration method to be used ("dump" or "replication") | | `--mysql-migration-password` | password for authenticating to the source server | | `--mysql-migration-port` | port number of the source server where to migrate data from | | `--mysql-migration-ssl` | connect to the source server using SSL | | `--mysql-migration-username` | username for authenticating to the source server | | `--mysql-settings` | MySQL configuration settings (JSON format) | | `--opensearch-dashboard-enabled` | Enable or disable OpenSearch Dashboards (default: true) | | `--opensearch-dashboard-max-old-space-size` | Memory limit in MiB for OpenSearch Dashboards. Note: The memory reserved by OpenSearch Dashboards is not available for OpenSearch. (default: 128) | | `--opensearch-dashboard-request-timeout` | Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch (default: 30000) | | `--opensearch-index-patterns` | JSON Array of index patterns (https://community.exoscale.com/reference/api/_schemas/index-patterns/) | | `--opensearch-index-template-mapping-nested-objects-limit` | The maximum number of nested cli-flag objects that a single document can contain across all nested types. Default is 10000. | | `--opensearch-index-template-number-of-replicas` | The number of replicas each primary shard has. | | `--opensearch-index-template-number-of-shards` | The number of primary shards that an index should have. | | `--opensearch-ip-filter` | Allow incoming connections from CIDR address block | | `--opensearch-keep-index-refresh-interval` | index.refresh_interval is reset to default value for every index to be sure that indices are always visible to search. Set to true disable this. | | `--opensearch-settings` | OpenSearch-specific settings (JSON) | | `--pg-backup-schedule` | automated backup schedule (format: HH:MM) | | `--pg-bouncer-settings` | PgBouncer configuration settings (JSON format) | | `--pg-ip-filter` | allow incoming connections from CIDR address block | | `--pg-lookout-settings` | pglookout configuration settings (JSON format) | | `--pg-migration-dbname` | database name for bootstrapping the initial connection | | `--pg-migration-host` | hostname or IP address of the source server where to migrate data from | | `--pg-migration-ignore-dbs` | list of databases which should be ignored during migration | | `--pg-migration-method` | migration method to be used ("dump" or "replication") | | `--pg-migration-password` | password for authenticating to the source server | | `--pg-migration-port` | port number of the source server where to migrate data from | | `--pg-migration-ssl` | connect to the source server using SSL | | `--pg-migration-username` | username for authenticating to the source server | | `--pg-settings` | PostgreSQL configuration settings (JSON format) | | `--pg-shared-buffers-percentage` | percentage of total RAM for shared memory buffers (valid range: 20-60) | | `--pg-synchronous-replication` | synchronous replication type (quorum or off) | | `--pg-timescaledb-settings` | TimescaleDB extension configuration settings (JSON format) | | `--pg-variant` | PostgreSQL variant (timescale or aiven) | | `--pg-work-mem` | maximum memory for query operations before writing to temporary disk files, in MB | | `--plan` | Database Service plan | | `--termination-protection` | enable Database Service termination protection; set --termination-protection=false to disable | | `--thanos-ip-filter` | allow incoming connections from CIDR address block | | `--thanos-settings` | Thanos configuration settings (JSON format) | | `--valkey-ip-filter` | allow incoming connections from CIDR address block | | `--valkey-migration-dbname` | database name for bootstrapping the initial connection | | `--valkey-migration-host` | hostname or IP address of the source server where to migrate data from | | `--valkey-migration-ignore-dbs` | list of databases which should be ignored during migration | | `--valkey-migration-method` | migration method to be used ("dump" or "replication") | | `--valkey-migration-password` | password for authenticating to the source server | | `--valkey-migration-port` | port number of the source server where to migrate data from | | `--valkey-migration-ssl` | connect to the source server using SSL | | `--valkey-migration-username` | username for authenticating to the source server | | `--valkey-settings` | Valkey configuration settings (JSON format) | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/ --- # exo dbaas user ``` exo dbaas user [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for user | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dbaas](https://community.exoscale.com/reference/cli/exo/dbaas/index.md) - Database as a Service management * [exo dbaas user create](https://community.exoscale.com/reference/cli/exo/dbaas/user/create/index.md) - Create DBAAS user * [exo dbaas user delete](https://community.exoscale.com/reference/cli/exo/dbaas/user/delete/index.md) - Delete DBAAS user * [exo dbaas user list](https://community.exoscale.com/reference/cli/exo/dbaas/user/list/index.md) - List users of a DBAAS service * [exo dbaas user reset-credentials](https://community.exoscale.com/reference/cli/exo/dbaas/user/reset-credentials/index.md) - Reset the credentials of a DBAAS user * [exo dbaas user reveal-secrets](https://community.exoscale.com/reference/cli/exo/dbaas/user/reveal-secrets/index.md) - Show the secrets of a user * [exo dbaas user show](https://community.exoscale.com/reference/cli/exo/dbaas/user/show/index.md) - Show the details of a user --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/create/ --- # exo dbaas user create ### Description This command creates a DBAAS user for the specified service. ``` exo dbaas user create NAME USERNAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--help-mysql` | show usage for flags specific to the mysql type | | `--help-pg` | show usage for flags specific to the pg type | | `--mysql-authentication-method` | authentication method to be used ("caching_sha2_password" or "mysql_native_password"). | | `--pg-allow-replication` | | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/delete/ --- # exo dbaas user delete ### Description This command deletes a DBAAS user for the specified service. ``` exo dbaas user delete NAME USERNAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/list/ --- # exo dbaas user list ### Description This command list users and their role for a specified DBAAS service. ``` exo dbaas user list NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/reset-credentials/ --- # exo dbaas user reset-credentials ### Description This command resets the credentials of a DBAAS user for the specified service. ``` exo dbaas user reset-credentials NAME USERNAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for reset-credentials | | `--help-mysql` | show usage for flags specific to the mysql type | | `--mysql-auhentication-method` | authentication method to be used ("caching_sha2_password" or "mysql_native_password"). | | `--password` | Use a specific password instead of an automatically generated one | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/reveal-secrets/ --- # exo dbaas user reveal-secrets ### Description This command reveals a user's password and other possible secrets, depending on the service type. ``` exo dbaas user reveal-secrets NAME USERNAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for reveal-secrets | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dbaas/user/show/ --- # exo dbaas user show ### Description This command show a user and their details for a specified DBAAS service. ``` exo dbaas user show NAME USERNAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | Database Service zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [user](https://community.exoscale.com/reference/cli/exo/dbaas/user/index.md) - Manage DBaaS users --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/ --- # exo dedicated-inference ``` exo dedicated-inference [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for dedicated-inference | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo dedicated-inference api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/index.md) - Manage AI API keys * [exo dedicated-inference deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments * [exo dedicated-inference model](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/index.md) - Manage AI models --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/ --- # exo dedicated-inference api-key ``` exo dedicated-inference api-key [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for api-key | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dedicated-inference](https://community.exoscale.com/reference/cli/exo/dedicated-inference/index.md) - Dedicated AI inference management * [exo dedicated-inference api-key create](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/create/index.md) - Create AI API key * [exo dedicated-inference api-key list](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/list/index.md) - List AI API keys * [exo dedicated-inference api-key revoke](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/revoke/index.md) - Revoke AI API key * [exo dedicated-inference api-key show](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/show/index.md) - Show AI API key details * [exo dedicated-inference api-key update](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/update/index.md) - Update AI API key --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/create/ --- # exo dedicated-inference api-key create ### Description This command creates an AI API key. The API key value is only returned once, at creation time, so store it securely. Supported output template annotations: .ID, .Name, .Value, .Models, .Deployments, .AllModels, .AllDeployments ``` exo dedicated-inference api-key create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--all-deployments` | Grant access to all deployments | | `--all-models` | Grant access to all public models | | `--deployment` | Deployment ID the API key can access (repeatable) | | `--help, -h` | help for create | | `--model` | Public model name the API key can access (repeatable) | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/index.md) - Manage AI API keys --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/list/ --- # exo dedicated-inference api-key list ### Description This command lists AI API keys across all zones. Supported output template annotations: .ID, .Name, .Zone, .CreationAt, .RevokedAt ``` exo dedicated-inference api-key list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/index.md) - Manage AI API keys --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/revoke/ --- # exo dedicated-inference api-key revoke ### Description This command revokes AI API keys by ID or name. Revoked keys can no longer be used. ``` exo dedicated-inference api-key revoke ID or NAME...... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for revoke | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/index.md) - Manage AI API keys --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/show/ --- # exo dedicated-inference api-key show ### Description This command shows details of an AI API key by ID or name. ``` exo dedicated-inference api-key show ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/index.md) - Manage AI API keys --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/update/ --- # exo dedicated-inference api-key update ### Description This command updates the models and/or deployments accessible by an AI API key. Omitted properties are left unchanged. ``` exo dedicated-inference api-key update ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--all-deployments` | Grant access to all deployments; set --all-deployments=false to revoke | | `--all-models` | Grant access to all public models; set --all-models=false to revoke | | `--deployment` | Deployment ID the API key can access (repeatable) | | `--help, -h` | help for update | | `--model` | Public model name the API key can access (repeatable) | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/api-key/index.md) - Manage AI API keys --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/ --- # exo dedicated-inference deployment ``` exo dedicated-inference deployment [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for deployment | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dedicated-inference](https://community.exoscale.com/reference/cli/exo/dedicated-inference/index.md) - Dedicated AI inference management * [exo dedicated-inference deployment create](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/create/index.md) - Create AI deployment * [exo dedicated-inference deployment delete](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/delete/index.md) - Delete AI deployment * [exo dedicated-inference deployment instance-type](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/instance-type/index.md) - List AI instance types * [exo dedicated-inference deployment list](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/list/index.md) - List AI deployments * [exo dedicated-inference deployment logs](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/logs/index.md) - Get deployment logs * [exo dedicated-inference deployment reveal-api-key](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/reveal-api-key/index.md) - Reveal deployment API key * [exo dedicated-inference deployment scale](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/scale/index.md) - Scale AI deployment * [exo dedicated-inference deployment show](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/show/index.md) - Show AI deployment * [exo dedicated-inference deployment update](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/update/index.md) - Update AI deployment --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/create/ --- # exo dedicated-inference deployment create ### Description This command creates an AI deployment on dedicated inference servers. ``` exo dedicated-inference deployment create [NAME] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--gpu-count` | Number of GPUs (1-8) | | `--gpu-type` | GPU type family (e.g., gpua5000, gpu3080ti) | | `--help, -h` | help for create | | `--inference-engine-parameter-help` | Show inference engine parameters help | | `--inference-engine-params` | Space-separated inference engine server CLI arguments (e.g., "--gpu-memory-usage=0.8 --max-tokens=4096") | | `--inference-engine-version` | Inference engine version | | `--model-id` | Model ID (UUID) | | `--model-name` | Model name (as created) | | `--replicas` | Number of replicas (>=1) | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/delete/ --- # exo dedicated-inference deployment delete ### Description This command deletes an AI deployment by ID or name. ``` exo dedicated-inference deployment delete NAME|ID...... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/instance-type/ --- # exo dedicated-inference deployment instance-type ### Description This command lists AI instance types. Supported output template annotations: .Family, .Authorized, .Zone ``` exo dedicated-inference deployment instance-type [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for instance-type | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/list/ --- # exo dedicated-inference deployment list ### Description This command lists AI deployments. Supported output template annotations: .ID, .Name, .Zone, .State, .GPUType, .GPUCount, .Replicas, .ModelName ``` exo dedicated-inference deployment list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/logs/ --- # exo dedicated-inference deployment logs ### Description This command retrieves logs for the deployment's vLLM component. ``` exo dedicated-inference deployment logs ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for logs | | `--tail` | number of lines to tail (default 10) | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/reveal-api-key/ --- # exo dedicated-inference deployment reveal-api-key ### Description This command reveals the inference endpoint API key for the deployment. ``` exo dedicated-inference deployment reveal-api-key ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for reveal-api-key | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/scale/ --- # exo dedicated-inference deployment scale ### Description This command scales an AI deployment to the specified number of replicas. ``` exo dedicated-inference deployment scale ID or NAME SIZE (replicas) [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for scale | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/show/ --- # exo dedicated-inference deployment show ### Description This command shows details of an AI deployment by ID or name. ``` exo dedicated-inference deployment show ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/update/ --- # exo dedicated-inference deployment update ### Description This command updates an AI deployment. ``` exo dedicated-inference deployment update ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for update | | `--inference-engine-parameter-help` | Show inference engine parameters help | | `--inference-engine-params` | Space-separated inference engine server CLI arguments (e.g., "--gpu-memory-usage=0.8 --max-tokens=4096") | | `--inference-engine-version` | Inference engine version | | `--name` | New deployment name | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [deployment](https://community.exoscale.com/reference/cli/exo/dedicated-inference/deployment/index.md) - Manage AI deployments --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/ --- # exo dedicated-inference model ``` exo dedicated-inference model [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for model | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dedicated-inference](https://community.exoscale.com/reference/cli/exo/dedicated-inference/index.md) - Dedicated AI inference management * [exo dedicated-inference model create](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/create/index.md) - Create AI model (download from Huggingface) * [exo dedicated-inference model delete](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/delete/index.md) - Delete AI model * [exo dedicated-inference model list](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/list/index.md) - List AI models * [exo dedicated-inference model show](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/show/index.md) - Show AI model --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/create/ --- # exo dedicated-inference model create ### Description This command creates an AI model by downloading it from Huggingface. The name parameter must be a valid Huggingface model name (e.g. mistralai/Mixtral-8x7B-Instruct-v0.1). ``` exo dedicated-inference model create NAME (e.g. swiss-ai/Apertus-8B-Instruct-2509) [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | | `--huggingface-token` | Huggingface token if required by the model | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [model](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/index.md) - Manage AI models --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/delete/ --- # exo dedicated-inference model delete ### Description This command deletes an AI model by ID or name. ``` exo dedicated-inference model delete ID or NAME...... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [model](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/index.md) - Manage AI models --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/list/ --- # exo dedicated-inference model list ### Description This command lists AI models. Supported output template annotations: .ID, .Name, .Zone, .State, .ModelSize ``` exo dedicated-inference model list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--visibility` | Model visibility: public or private | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [model](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/index.md) - Manage AI models --- url: https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/show/ --- # exo dedicated-inference model show ### Description This command shows details of an AI model by ID or name. ``` exo dedicated-inference model show ID or NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--visibility` | Model visibility: public or private | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [model](https://community.exoscale.com/reference/cli/exo/dedicated-inference/model/index.md) - Manage AI models --- url: https://community.exoscale.com/reference/cli/exo/dns/ --- # exo dns ``` exo dns [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for dns | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo dns add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain * [exo dns create](https://community.exoscale.com/reference/cli/exo/dns/create/index.md) - Create a domain * [exo dns delete](https://community.exoscale.com/reference/cli/exo/dns/delete/index.md) - Delete a domain * [exo dns list](https://community.exoscale.com/reference/cli/exo/dns/list/index.md) - List domains * [exo dns remove](https://community.exoscale.com/reference/cli/exo/dns/remove/index.md) - Remove a domain record * [exo dns show](https://community.exoscale.com/reference/cli/exo/dns/show/index.md) - Show the domain records * [exo dns update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/add/ --- # exo dns add ``` exo dns add [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for add | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records * [exo dns add A](https://community.exoscale.com/reference/cli/exo/dns/add/a/index.md) - Add A record type to a domain * [exo dns add AAAA](https://community.exoscale.com/reference/cli/exo/dns/add/aaaa/index.md) - Add AAAA record type to a domain * [exo dns add ALIAS](https://community.exoscale.com/reference/cli/exo/dns/add/alias/index.md) - Add ALIAS record type to a domain * [exo dns add CAA](https://community.exoscale.com/reference/cli/exo/dns/add/caa/index.md) - Add CAA record type to a domain * [exo dns add CNAME](https://community.exoscale.com/reference/cli/exo/dns/add/cname/index.md) - Add CNAME record type to a domain * [exo dns add HINFO](https://community.exoscale.com/reference/cli/exo/dns/add/hinfo/index.md) - Add HINFO record type to a domain * [exo dns add MX](https://community.exoscale.com/reference/cli/exo/dns/add/mx/index.md) - Add MX record type to a domain * [exo dns add NAPTR](https://community.exoscale.com/reference/cli/exo/dns/add/naptr/index.md) - Add NAPTR record type to a domain * [exo dns add NS](https://community.exoscale.com/reference/cli/exo/dns/add/ns/index.md) - Add NS record type to a domain * [exo dns add POOL](https://community.exoscale.com/reference/cli/exo/dns/add/pool/index.md) - Add POOL record type to a domain * [exo dns add SRV](https://community.exoscale.com/reference/cli/exo/dns/add/srv/index.md) - Add SRV record type to a domain * [exo dns add SSHFP](https://community.exoscale.com/reference/cli/exo/dns/add/sshfp/index.md) - Add SSHFP record type to a domain * [exo dns add TXT](https://community.exoscale.com/reference/cli/exo/dns/add/txt/index.md) - Add TXT record type to a domain * [exo dns add URL](https://community.exoscale.com/reference/cli/exo/dns/add/url/index.md) - Add URL record type to a domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/a/ --- # exo dns add A ### Description Add an "A" record that points your domain or a subdomain to an IP address. ``` exo dns add A DOMAIN [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--address, -a` | Example: 127.0.0.1 | | `--help, -h` | help for A | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/aaaa/ --- # exo dns add AAAA ### Description Add an "AAAA" record that points your domain to an IPv6 address. These records are the same as A records except they use IPv6 addresses. ``` exo dns add AAAA DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--address, -a` | Example: 2001:0db8:85a3:0000:0000:EA75:1337:BEEF | | `--help, -h` | help for AAAA | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/alias/ --- # exo dns add ALIAS ### Description Add an "ALIAS" record. An ALIAS record is a special record that will map a domain to another domain transparently. It can be used like a CNAME but for a name with other records, like the root. When the record is resolved it will look up the A records for the aliased domain and return those as the records for the record name. Note: If you want to redirect to a URL, use a URL record instead. ``` exo dns add ALIAS DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--alias, -a` | Alias for: Example: some-other-site.com | | `--help, -h` | help for ALIAS | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/caa/ --- # exo dns add CAA ### Description A Certification Authority Authorization (CAA) record is used to specify which certificate authorities (CAs) are allowed to issue certificates for a domain. More information on CAA flags: https://tools.ietf.org/html/rfc6844#section-3 ``` exo dns add CAA DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--flag, -f` | An unsigned integer between 0-255. | | `--help, -h` | help for CAA | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--tag` | CAA tag "KEY,VALUE", available tags: (issue\|issuewild\|iodef) | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/cname/ --- # exo dns add CNAME ### Description Add a "CNAME" record that aliases a subdomain to another host. These types of records are used when a server is reached by several names. Only use CNAME records on subdomains. ``` exo dns add CNAME DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--alias, -a` | Alias for: Example: some-other-site.com | | `--help, -h` | help for CNAME | | `--name, -n` | You may use the * wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/hinfo/ --- # exo dns add HINFO ### Description Add an "HINFO" record is used to describe the CPU and OS of a host. ``` exo dns add HINFO DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--cpu, -c` | Example: IBM-PC/AT | | `--help, -h` | help for HINFO | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--os, -o` | The operating system of the machine, example: Linux | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/mx/ --- # exo dns add MX ### Description Add a mail exchange record that points to a mail server or relay. These types of records are used to describe which servers handle incoming email. ``` exo dns add MX DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for MX | | `--mail-server-host, -m` | Example: mail-server.example.com | | `--name, -n` | Leave this blank to create a record for DOMAIN | | `--priority, -p` | Common values are for example 1, 5 or 10 | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/naptr/ --- # exo dns add NAPTR ### Description Add an "NAPTR" record to provide a means to map a resource that is not in the domain name syntax to a label that is. More information can be found in RFC 2915. ``` exo dns add NAPTR DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--a` | Flag indicates the next lookup is for an A or AAAA record. | | `--help, -h` | help for NAPTR | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--order, -o` | Used to determine the processing order, lowest first. | | `--p` | Flag indicates that processing should continue in a protocol-specific fashion. | | `--preference` | Used to give weight to records with the same value in the 'order' field, low to high. | | `--regex` | The substitution expression. | | `--replacement` | The next record to look up, which must be a fully-qualified domain name. | | `--s` | Flag indicates the next lookup is for an SRV. | | `--service` | Service | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | | `--u` | Flag indicates the next record is the output of the regular expression as a URI. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/ns/ --- # exo dns add NS ### Description Add an "NS" record the delegates a domain to another name server. You may only delegate subdomains (for example subdomain.yourdomain.com). ``` exo dns add NS DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for NS | | `--name, -n` | You may use the * wildcard here. | | `--name-server, -s` | Example: 'ns1.example.com' | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/pool/ --- # exo dns add POOL ### Description Add a "POOL" record that aliases a subdomain to another host as part of a pool of available CNAME records. This is a DNSimple custom record type. ``` exo dns add POOL DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--alias, -a` | Alias for: Example: 'some-other-site.com' | | `--help, -h` | help for POOL | | `--name, -n` | You may use the * wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/srv/ --- # exo dns add SRV ### Description Add an "SRV" record to specify the location of servers for a specific service. ``` exo dns add SRV DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for SRV | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--port, -P` | The 'TCP' or 'UDP' port on which the service is found. | | `--priority` | Priority | | `--protocol, -p` | This will usually be 'TCP' or 'UDP'. | | `--symbolic-name, -s` | This will be a symbolic name for the service, like 'sip'. It might also be called Service at other DNS providers. | | `--target` | The canonical hostname of the machine providing the service. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | | `--weight, -w` | A relative weight for 'SRV' records with the same priority. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/sshfp/ --- # exo dns add SSHFP ### Description Edit an "SSHFP" record to share your SSH fingerprint with others. ``` exo dns add SSHFP DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--algorithm, -a` | RSA(1) \| DSA(2) \| ECDSA(3) \| ED25519(4) | | `--fingerprint, -f` | Fingerprint | | `--fingerprint-type` | SHA1(1) \| SHA256(2) | | `--help, -h` | help for SSHFP | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/txt/ --- # exo dns add TXT ### Description Add a "TXT" record. This is useful for domain records that are not covered by the standard record types. For example, Google uses this type of record for domain verification. ``` exo dns add TXT DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Content record | | `--help, -h` | help for TXT | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/add/url/ --- # exo dns add URL ### Description Add an URL redirection record that points your domain to a URL. This type of record uses an HTTP redirect to redirect visitors from a domain to a web site. ``` exo dns add URL DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--destination-url, -d` | Example: https://www.example.com | | `--help, -h` | help for URL | | `--name, -n` | Leave this blank to create a record for DOMAIN, You may use the '*' wildcard here. | | `--ttl, -t` | The time in seconds to live (refresh rate) of the record. | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [add](https://community.exoscale.com/reference/cli/exo/dns/add/index.md) - Add record to domain --- url: https://community.exoscale.com/reference/cli/exo/dns/create/ --- # exo dns create ``` exo dns create DOMAIN-NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records --- url: https://community.exoscale.com/reference/cli/exo/dns/delete/ --- # exo dns delete ``` exo dns delete DOMAIN-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records --- url: https://community.exoscale.com/reference/cli/exo/dns/list/ --- # exo dns list ### Description This command lists existing DNS Domains. Optional patterns can be provided to filter results by ID, or name. Supported output template annotations: .ID, .Name ``` exo dns list [FILTER]... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records --- url: https://community.exoscale.com/reference/cli/exo/dns/remove/ --- # exo dns remove ``` exo dns remove DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for remove | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records --- url: https://community.exoscale.com/reference/cli/exo/dns/show/ --- # exo dns show ### Description This command shows a DNS Domain records. Supported output template annotations: .ID, .DomainID, .Name, .RecordType, .Content, .Prio, .TTL, .CreatedAt, .UpdatedAt ``` exo dns show DOMAIN-NAME|ID [RECORD-TYPE]... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--name, -n` | List records by name | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records --- url: https://community.exoscale.com/reference/cli/exo/dns/update/ --- # exo dns update ``` exo dns update [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for update | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [dns](https://community.exoscale.com/reference/cli/exo/dns/index.md) - DNS cmd lets you host your zones and manage records * [exo dns update A](https://community.exoscale.com/reference/cli/exo/dns/update/a/index.md) - Update A record type to a domain * [exo dns update AAAA](https://community.exoscale.com/reference/cli/exo/dns/update/aaaa/index.md) - Update AAAA record type to a domain * [exo dns update ALIAS](https://community.exoscale.com/reference/cli/exo/dns/update/alias/index.md) - Update ALIAS record type to a domain * [exo dns update CAA](https://community.exoscale.com/reference/cli/exo/dns/update/caa/index.md) - Update CAA record type to a domain * [exo dns update CNAME](https://community.exoscale.com/reference/cli/exo/dns/update/cname/index.md) - Update CNAME record type to a domain * [exo dns update HINFO](https://community.exoscale.com/reference/cli/exo/dns/update/hinfo/index.md) - Update HINFO record type to a domain * [exo dns update MX](https://community.exoscale.com/reference/cli/exo/dns/update/mx/index.md) - Update MX record type to a domain * [exo dns update NAPTR](https://community.exoscale.com/reference/cli/exo/dns/update/naptr/index.md) - Update NAPTR record type to a domain * [exo dns update NS](https://community.exoscale.com/reference/cli/exo/dns/update/ns/index.md) - Update NS record type to a domain * [exo dns update POOL](https://community.exoscale.com/reference/cli/exo/dns/update/pool/index.md) - Update POOL record type to a domain * [exo dns update SPF](https://community.exoscale.com/reference/cli/exo/dns/update/spf/index.md) - Update SPF record type to a domain * [exo dns update SRV](https://community.exoscale.com/reference/cli/exo/dns/update/srv/index.md) - Update SRV record type to a domain * [exo dns update SSHFP](https://community.exoscale.com/reference/cli/exo/dns/update/sshfp/index.md) - Update SSHFP record type to a domain * [exo dns update TXT](https://community.exoscale.com/reference/cli/exo/dns/update/txt/index.md) - Update TXT record type to a domain --- url: https://community.exoscale.com/reference/cli/exo/dns/update/a/ --- # exo dns update A ``` exo dns update A DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for A | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/aaaa/ --- # exo dns update AAAA ``` exo dns update AAAA DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for AAAA | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/alias/ --- # exo dns update ALIAS ``` exo dns update ALIAS DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for ALIAS | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/caa/ --- # exo dns update CAA ``` exo dns update CAA DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for CAA | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/cname/ --- # exo dns update CNAME ``` exo dns update CNAME DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for CNAME | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/hinfo/ --- # exo dns update HINFO ``` exo dns update HINFO DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for HINFO | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/mx/ --- # exo dns update MX ``` exo dns update MX DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for MX | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/naptr/ --- # exo dns update NAPTR ``` exo dns update NAPTR DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for NAPTR | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/ns/ --- # exo dns update NS ``` exo dns update NS DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for NS | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/pool/ --- # exo dns update POOL ``` exo dns update POOL DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for POOL | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/spf/ --- # exo dns update SPF ``` exo dns update SPF DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for SPF | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/srv/ --- # exo dns update SRV ``` exo dns update SRV DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for SRV | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/sshfp/ --- # exo dns update SSHFP ``` exo dns update SSHFP DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for SSHFP | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/dns/update/txt/ --- # exo dns update TXT ``` exo dns update TXT DOMAIN-NAME|ID RECORD-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--content, -c` | Update Content | | `--help, -h` | help for TXT | | `--name, -n` | Update name | | `--priority, -p` | Update priority | | `--ttl, -t` | Update ttl | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [update](https://community.exoscale.com/reference/cli/exo/dns/update/index.md) - Update domain record --- url: https://community.exoscale.com/reference/cli/exo/iam/ --- # exo iam ``` exo iam [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for iam | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo iam api-key](https://community.exoscale.com/reference/cli/exo/iam/api-key/index.md) - API Key management * [exo iam org-policy](https://community.exoscale.com/reference/cli/exo/iam/org-policy/index.md) - IAM Organization Policy management * [exo iam role](https://community.exoscale.com/reference/cli/exo/iam/role/index.md) - IAM Role management --- url: https://community.exoscale.com/reference/cli/exo/iam/api-key/ --- # exo iam api-key ``` exo iam api-key [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for api-key | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [iam](https://community.exoscale.com/reference/cli/exo/iam/index.md) - Identity and Access Management * [exo iam api-key create](https://community.exoscale.com/reference/cli/exo/iam/api-key/create/index.md) - Create API Key * [exo iam api-key delete](https://community.exoscale.com/reference/cli/exo/iam/api-key/delete/index.md) - Delete an API Key * [exo iam api-key list](https://community.exoscale.com/reference/cli/exo/iam/api-key/list/index.md) - List API Keys --- url: https://community.exoscale.com/reference/cli/exo/iam/api-key/create/ --- # exo iam api-key create ### Description This command creates a new API Key. Because Secret is only printed during API Key creation, --quiet (-Q) flag is not implemented for this command. Supported output template annotations: .Name, .Key, .Secret, .Role ``` exo iam api-key create NAME ROLE-NAME|ROLE-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for create | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/iam/api-key/index.md) - API Key management --- url: https://community.exoscale.com/reference/cli/exo/iam/api-key/delete/ --- # exo iam api-key delete ### Description This command deletes existing API Key. ``` exo iam api-key delete NAME|KEY [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/iam/api-key/index.md) - API Key management --- url: https://community.exoscale.com/reference/cli/exo/iam/api-key/list/ --- # exo iam api-key list ### Description This command lists all API Keys. Supported output template annotations: .Name, .Key, .Role ``` exo iam api-key list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [api-key](https://community.exoscale.com/reference/cli/exo/iam/api-key/index.md) - API Key management --- url: https://community.exoscale.com/reference/cli/exo/iam/org-policy/ --- # exo iam org-policy ``` exo iam org-policy [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for org-policy | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [iam](https://community.exoscale.com/reference/cli/exo/iam/index.md) - Identity and Access Management * [exo iam org-policy reset](https://community.exoscale.com/reference/cli/exo/iam/org-policy/reset/index.md) - Reset Org policy to default * [exo iam org-policy show](https://community.exoscale.com/reference/cli/exo/iam/org-policy/show/index.md) - Show Org policy details * [exo iam org-policy update](https://community.exoscale.com/reference/cli/exo/iam/org-policy/update/index.md) - Update Org policy --- url: https://community.exoscale.com/reference/cli/exo/iam/org-policy/reset/ --- # exo iam org-policy reset ### Description This command resets the IAM Organization Policy to the default (allow all). This will remove any constraints that were set in the Org Policy. ``` exo iam org-policy reset [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for reset | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [org-policy](https://community.exoscale.com/reference/cli/exo/iam/org-policy/index.md) - IAM Organization Policy management --- url: https://community.exoscale.com/reference/cli/exo/iam/org-policy/show/ --- # exo iam org-policy show ### Description This command shows IAM Org Policy details. Supported output template annotations: .Type, .Rules ``` exo iam org-policy show [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [org-policy](https://community.exoscale.com/reference/cli/exo/iam/org-policy/index.md) - IAM Organization Policy management --- url: https://community.exoscale.com/reference/cli/exo/iam/org-policy/update/ --- # exo iam org-policy update ### Description This command replaces the complete IAM Organization Policy with the new one provided in JSON format. To read the Policy from STDIN provide '-' as an argument. Pro Tip: you can get the policy in JSON format with the command: exo iam org-policy show --output-format json Supported output template annotations: .DefaultServiceStrategy, .Services ``` exo iam org-policy update POLICY [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for update | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [org-policy](https://community.exoscale.com/reference/cli/exo/iam/org-policy/index.md) - IAM Organization Policy management --- url: https://community.exoscale.com/reference/cli/exo/iam/role/ --- # exo iam role ``` exo iam role [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for role | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [iam](https://community.exoscale.com/reference/cli/exo/iam/index.md) - Identity and Access Management * [exo iam role create](https://community.exoscale.com/reference/cli/exo/iam/role/create/index.md) - Create IAM Role * [exo iam role delete](https://community.exoscale.com/reference/cli/exo/iam/role/delete/index.md) - Delete IAM Role * [exo iam role list](https://community.exoscale.com/reference/cli/exo/iam/role/list/index.md) - List IAM Roles * [exo iam role show](https://community.exoscale.com/reference/cli/exo/iam/role/show/index.md) - Show Role details * [exo iam role update](https://community.exoscale.com/reference/cli/exo/iam/role/update/index.md) - Update an IAM Role --- url: https://community.exoscale.com/reference/cli/exo/iam/role/create/ --- # exo iam role create ### Description This command creates a new IAM Role. To read the Policy from STDIN, append '-' to the '--policy' flag. Pro Tip: you can reuse an existing role policy by providing the output of the show command as input: exo iam role show --policy --output-format json | exo iam role create --policy - Supported output template annotations: .ID, .Name, .Description, .Editable, .Labels, .Permissions, .Policy ``` exo iam role create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Role description | | `--editable` | Set --editable=false do prevent editing Policy after creation | | `--help, -h` | help for create | | `--label` | Role labels (format: key=value) | | `--permissions` | Role permissions | | `--policy` | Role policy (use '-' to read from STDIN) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/iam/role/index.md) - IAM Role management --- url: https://community.exoscale.com/reference/cli/exo/iam/role/delete/ --- # exo iam role delete ### Description This command deletes an existing IAM Role. It will fail if the Role is attached to an IAM Key. ``` exo iam role delete ID|NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/iam/role/index.md) - IAM Role management --- url: https://community.exoscale.com/reference/cli/exo/iam/role/list/ --- # exo iam role list ### Description This command lists existing IAM Roles. Supported output template annotations: .ID, .Name, .Editable ``` exo iam role list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/iam/role/index.md) - IAM Role management --- url: https://community.exoscale.com/reference/cli/exo/iam/role/show/ --- # exo iam role show ### Description This command shows IAM Role details. Supported output template annotations: .ID, .Name, .Description, .Editable, .Labels, .Permissions, .Policy ``` exo iam role show ID|NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--policy` | Print IAM Role policy | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/iam/role/index.md) - IAM Role management --- url: https://community.exoscale.com/reference/cli/exo/iam/role/update/ --- # exo iam role update ### Description This command updates an IAM Role. When you supply '-' as a flag argument to '--policy', the new policy will be read from STDIN. Supported output template annotations: .DefaultServiceStrategy, .Services ``` exo iam role update ID|NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Role description | | `--help, -h` | help for update | | `--label` | Role labels (format: key=value) | | `--permissions` | Role permissions | | `--policy` | Role policy (use '-' to read from STDIN) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [role](https://community.exoscale.com/reference/cli/exo/iam/role/index.md) - IAM Role management --- url: https://community.exoscale.com/reference/cli/exo/kms/ --- # exo kms ``` exo kms [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for kms | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo kms crypto](https://community.exoscale.com/reference/cli/exo/kms/crypto/index.md) - KMS key cryptographic operations * [exo kms key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/crypto/ --- # exo kms crypto ``` exo kms crypto [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for crypto | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [kms](https://community.exoscale.com/reference/cli/exo/kms/index.md) - Key management * [exo kms crypto decrypt](https://community.exoscale.com/reference/cli/exo/kms/crypto/decrypt/index.md) - Decrypt a ciphertext. * [exo kms crypto encrypt](https://community.exoscale.com/reference/cli/exo/kms/crypto/encrypt/index.md) - Encrypt a plaintext. * [exo kms crypto generate-data-key](https://community.exoscale.com/reference/cli/exo/kms/crypto/generate-data-key/index.md) - Generate a Data Encryption Key from a given KMS Key. * [exo kms crypto reencrypt](https://community.exoscale.com/reference/cli/exo/kms/crypto/reencrypt/index.md) - Decrypts and encrypts an exisiting ciphertext with newest key material or a different KMS key. --- url: https://community.exoscale.com/reference/cli/exo/kms/crypto/decrypt/ --- # exo kms crypto decrypt ### Description Decrypt a ciphertext. ``` exo kms crypto decrypt ID CIPHERTEXT [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--encryption-context, -e` | encryption context to use for decryption | | `--help, -h` | help for decrypt | | `--zone, -z` | crypto zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [crypto](https://community.exoscale.com/reference/cli/exo/kms/crypto/index.md) - KMS key cryptographic operations --- url: https://community.exoscale.com/reference/cli/exo/kms/crypto/encrypt/ --- # exo kms crypto encrypt ### Description Encrypt a plaintext. ``` exo kms crypto encrypt ID PLAINTEXT_b64 [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--encryption-context, -e` | encryption context to use for encryption | | `--help, -h` | help for encrypt | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [crypto](https://community.exoscale.com/reference/cli/exo/kms/crypto/index.md) - KMS key cryptographic operations --- url: https://community.exoscale.com/reference/cli/exo/kms/crypto/generate-data-key/ --- # exo kms crypto generate-data-key ### Description Generate a Data Encryption Key from a given KMS Key. ``` exo kms crypto generate-data-key ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--bytes-count, -b` | number of bytes for DEK (1 - 1024) | | `--encryption-context, -e` | encryption context to use for DEK generation | | `--help, -h` | help for generate-data-key | | `--key-spec, -s` | key spec for DEK [AES-256] | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [crypto](https://community.exoscale.com/reference/cli/exo/kms/crypto/index.md) - KMS key cryptographic operations --- url: https://community.exoscale.com/reference/cli/exo/kms/crypto/reencrypt/ --- # exo kms crypto reencrypt ### Description Decrypts an existing ciphertext using its original key material and re-encrypts the underlying plaintext using a specified KMS key or the latest key material of the same KMS Key. ``` exo kms crypto reencrypt SRC_ID DEST_ID CIPHERTEXT [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--dest-encryption-context, -d` | encryption context to use for destination ciphertext encryption | | `--help, -h` | help for reencrypt | | `--source-encryption-context, -s` | encryption context to use for source ciphertext decryption | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [crypto](https://community.exoscale.com/reference/cli/exo/kms/crypto/index.md) - KMS key cryptographic operations --- url: https://community.exoscale.com/reference/cli/exo/kms/key/ --- # exo kms key ``` exo kms key [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for key | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [kms](https://community.exoscale.com/reference/cli/exo/kms/index.md) - Key management * [exo kms key cancel-deletion](https://community.exoscale.com/reference/cli/exo/kms/key/cancel-deletion/index.md) - Cancel the scheduled deletion of a KMS Key. * [exo kms key create](https://community.exoscale.com/reference/cli/exo/kms/key/create/index.md) - Create a KMS Key in a given zone with a given name. * [exo kms key disable](https://community.exoscale.com/reference/cli/exo/kms/key/disable/index.md) - Disables a KMS Key. * [exo kms key disable-rotation](https://community.exoscale.com/reference/cli/exo/kms/key/disable-rotation/index.md) - Disable the periodic rotation of a KMS Key. * [exo kms key enable](https://community.exoscale.com/reference/cli/exo/kms/key/enable/index.md) - Enables a KMS Key. * [exo kms key enable-rotation](https://community.exoscale.com/reference/cli/exo/kms/key/enable-rotation/index.md) - Enable the periodic rotation of a KMS Key. * [exo kms key list](https://community.exoscale.com/reference/cli/exo/kms/key/list/index.md) - List KMS Keys details for an organization in a given zone. * [exo kms key list-rotation](https://community.exoscale.com/reference/cli/exo/kms/key/list-rotation/index.md) - List all the key material versions of a KMS Key. * [exo kms key replicate](https://community.exoscale.com/reference/cli/exo/kms/key/replicate/index.md) - Replicate a KMS key to a target zone. * [exo kms key rotate](https://community.exoscale.com/reference/cli/exo/kms/key/rotate/index.md) - Perform a manual rotation of the key material for a symmetric key. * [exo kms key schedule-deletion](https://community.exoscale.com/reference/cli/exo/kms/key/schedule-deletion/index.md) - Schedule a KMS key for deletion after a delay. * [exo kms key show](https://community.exoscale.com/reference/cli/exo/kms/key/show/index.md) - Retrieve KMS Key details. --- url: https://community.exoscale.com/reference/cli/exo/kms/key/cancel-deletion/ --- # exo kms key cancel-deletion ### Description Cancel the scheduled deletion of a KMS Key. ``` exo kms key cancel-deletion ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for cancel-deletion | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/create/ --- # exo kms key create ### Description Create a KMS Key in a given zone with a given name. ``` exo kms key create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description, -d` | key description | | `--help, -h` | help for create | | `--multizone, -m` | allow replication accross zones (default: false) | | `--usage, -u` | key usage [encrypt-decrypt] | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/disable/ --- # exo kms key disable ### Description Disables a KMS Key. ``` exo kms key disable ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for disable | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/disable-rotation/ --- # exo kms key disable-rotation ### Description Disable the periodic rotation of a KMS Key. ``` exo kms key disable-rotation ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for disable-rotation | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/enable/ --- # exo kms key enable ### Description Enables a KMS Key. ``` exo kms key enable ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for enable | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/enable-rotation/ --- # exo kms key enable-rotation ### Description Enable the periodic rotation of a KMS Key. ``` exo kms key enable-rotation ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for enable-rotation | | `--rotation-period, -r` | number of days for auto rotation period (90 - 2560, default: 365) | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/list/ --- # exo kms key list ### Description List KMS Keys details for an organization in a given zone. ``` exo kms key list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--ignore-replica, -i` | filter out replicas | | `--status, -s` | filter by key status [enabled\|disabled\|pending-deletion] | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/list-rotation/ --- # exo kms key list-rotation ### Description List all the key material versions of a KMS Key. ``` exo kms key list-rotation ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list-rotation | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/replicate/ --- # exo kms key replicate ### Description Replicate a KMS key to a target zone. ``` exo kms key replicate ID TARGET_ZONE [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for replicate | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/rotate/ --- # exo kms key rotate ### Description Perform a manual rotation of the key material for a symmetric key. ``` exo kms key rotate ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for rotate | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/schedule-deletion/ --- # exo kms key schedule-deletion ### Description Schedule a KMS key for deletion after a delay. ``` exo kms key schedule-deletion ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--delay-days, -d` | number of days before deletion (7 - 30, default: 30) | | `--help, -h` | help for schedule-deletion | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/kms/key/show/ --- # exo kms key show ### Description Retrieve KMS Key details. ``` exo kms key show ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | key zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [key](https://community.exoscale.com/reference/cli/exo/kms/key/index.md) - KMS key lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/limits/ --- # exo limits ### Description This command lists the safety limits currently enforced on your account. Supported output template annotations: .Resource, .Used, .Max ``` exo limits [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for limits | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo limits gpu](https://community.exoscale.com/reference/cli/exo/limits/gpu/index.md) - Show per-family GPU limits --- url: https://community.exoscale.com/reference/cli/exo/limits/gpu/ --- # exo limits gpu ### Description Show per-family GPU quotas (A5000, A30, 3080 Ti, RTX 6000 Pro, GPU2, GPU3). Supported output template annotations: .Resource, .Used, .Max ``` exo limits gpu [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for gpu | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [limits](https://community.exoscale.com/reference/cli/exo/limits/index.md) - Current account limits --- url: https://community.exoscale.com/reference/cli/exo/networking/ --- # exo networking ``` exo networking [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for networking | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo networking vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/ --- # exo networking vpc ``` exo networking vpc [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for vpc | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [networking](https://community.exoscale.com/reference/cli/exo/networking/index.md) - Networking services management * [exo networking vpc create](https://community.exoscale.com/reference/cli/exo/networking/vpc/create/index.md) - Create a VPC * [exo networking vpc delete](https://community.exoscale.com/reference/cli/exo/networking/vpc/delete/index.md) - Delete a VPC * [exo networking vpc list](https://community.exoscale.com/reference/cli/exo/networking/vpc/list/index.md) - List VPCs * [exo networking vpc route](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/index.md) - Manage VPC routes * [exo networking vpc show](https://community.exoscale.com/reference/cli/exo/networking/vpc/show/index.md) - Show a VPC details * [exo networking vpc subnet](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/index.md) - Manage VPC Subnets * [exo networking vpc update](https://community.exoscale.com/reference/cli/exo/networking/vpc/update/index.md) - Update a VPC --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/create/ --- # exo networking vpc create ### Description This command creates a Virtual Private Cloud. Supported output template annotations: .ID, .Name, .Description, .Default, .Zone, .CreatedAt, .DhcpOptions, .Labels, .Subnets ``` exo networking vpc create NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | VPC description | | `--dns-server` | DHCP option 6: DNS servers (can be specified multiple times) | | `--domain-search` | DHCP option 119: domain search list (can be specified multiple times) | | `--help, -h` | help for create | | `--label` | VPC label (format: key=value) | | `--ntp-server` | DHCP option 42: NTP servers (can be specified multiple times) | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/delete/ --- # exo networking vpc delete ``` exo networking vpc delete VPC-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/list/ --- # exo networking vpc list ### Description This command lists Virtual Private Clouds. Supported output template annotations: .ID, .Name, .Zone, .Default, .Description ``` exo networking vpc list [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | zone to filter results to | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/route/ --- # exo networking vpc route ``` exo networking vpc route [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for route | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management * [exo networking vpc route create](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/create/index.md) - Create a VPC route * [exo networking vpc route delete](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/delete/index.md) - Delete a VPC route * [exo networking vpc route list](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/list/index.md) - List VPC routes --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/route/create/ --- # exo networking vpc route create ### Description This command creates a route on a VPC Subnet. Routes are scoped to a Subnet, so --subnet is required. Route target explanation can be found here https://community.exoscale.com/product/networking/vpc/how-to/using-routing-rules/ ``` exo networking vpc route create VPC-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | route description | | `--destination` | route destination CIDR (e.g. 10.9.0.0/24) | | `--help, -h` | help for create | | `--subnet` | Subnet to create the route in (NAME\|ID) | | `--target` | route target, as ip=<IP address> (e.g. ip=10.0.0.5). Find more details at https://community.exoscale.com/product/networking/vpc/how-to/using-routing-rules/ | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [route](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/index.md) - Manage VPC routes --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/route/delete/ --- # exo networking vpc route delete ### Description This command deletes a route from a VPC Subnet. Routes associated to a VPC directly can't be deleted, so --subnet is required. ``` exo networking vpc route delete VPC-NAME|ID ROUTE-ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--subnet` | Subnet the route belongs to (NAME\|ID) | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [route](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/index.md) - Manage VPC routes --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/route/list/ --- # exo networking vpc route list ### Description This command lists the routes of a Virtual Private Cloud. Without --subnet, the routes attached to the VPC are list. With --subnet, all the routes impacting the Subnet are listed Supported output template annotations: .ID, .Kind, .Destination, .Target, .Description ``` exo networking vpc route list VPC-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--subnet` | only list routes of this Subnet (NAME\|ID) | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [route](https://community.exoscale.com/reference/cli/exo/networking/vpc/route/index.md) - Manage VPC routes --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/show/ --- # exo networking vpc show ### Description This command shows a Virtual Private Cloud details. Supported output template annotations for VPC: .ID, .Name, .Description, .Default, .Zone, .CreatedAt, .DhcpOptions, .Labels, .Subnets Supported output template annotations for VPC subnets: .Name, .IPv4Block ``` exo networking vpc show VPC-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/ --- # exo networking vpc subnet ``` exo networking vpc subnet [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for subnet | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management * [exo networking vpc subnet create](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/create/index.md) - Create a VPC Subnet * [exo networking vpc subnet delete](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/delete/index.md) - Delete a VPC Subnet * [exo networking vpc subnet list](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/list/index.md) - List VPC Subnets * [exo networking vpc subnet show](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/show/index.md) - Show a VPC Subnet details * [exo networking vpc subnet update](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/update/index.md) - Update a VPC Subnet --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/create/ --- # exo networking vpc subnet create ### Description This command creates a Subnet in a Virtual Private Cloud. --address-family and --address-space are required. Supported output template annotations: .ID, .Name, .Description, .Zone, .CreatedAt, .AddressFamily, .AddressSpace, .IPv4Block, .Labels, .Instances ``` exo networking vpc subnet create VPC-NAME|ID NAME [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--address-family` | Subnet address family (currently only "inet4" is supported) | | `--address-space` | Subnet address space (currently only "private" is supported) | | `--description` | Subnet description | | `--help, -h` | help for create | | `--ipv4-block` | Subnet IPv4 CIDR (e.g. 10.0.0.0/24) | | `--label` | Subnet label (format: key=value) | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [subnet](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/index.md) - Manage VPC Subnets --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/delete/ --- # exo networking vpc subnet delete ``` exo networking vpc subnet delete VPC-NAME|ID SUBNET-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | don't prompt for confirmation | | `--help, -h` | help for delete | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [subnet](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/index.md) - Manage VPC Subnets --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/list/ --- # exo networking vpc subnet list ### Description This command lists the Subnets of a Virtual Private Cloud. Supported output template annotations: .ID, .Name, .IPv4Block, .AddressFamily, .Description ``` exo networking vpc subnet list VPC-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for list | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [subnet](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/index.md) - Manage VPC Subnets --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/show/ --- # exo networking vpc subnet show ### Description This command shows a VPC Subnet details. Supported output template annotations for Subnet: .ID, .Name, .Description, .Zone, .CreatedAt, .AddressFamily, .AddressSpace, .IPv4Block, .Labels, .Instances Supported output template annotations for Subnet instances: .Name, .IPv4 ``` exo networking vpc subnet show VPC-NAME|ID SUBNET-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [subnet](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/index.md) - Manage VPC Subnets --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/update/ --- # exo networking vpc subnet update ### Description This command updates a VPC Subnet. Supported output template annotations: .ID, .Name, .Description, .Zone, .CreatedAt, .AddressFamily, .AddressSpace, .IPv4Block, .Labels, .Instances ``` exo networking vpc subnet update VPC-NAME|ID SUBNET-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | Subnet description | | `--help, -h` | help for update | | `--label` | Subnet label (format: key=value), clearing the labels is possible by passing [=] | | `--name` | Subnet name | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [subnet](https://community.exoscale.com/reference/cli/exo/networking/vpc/subnet/index.md) - Manage VPC Subnets --- url: https://community.exoscale.com/reference/cli/exo/networking/vpc/update/ --- # exo networking vpc update ### Description This command updates a Virtual Private Cloud. Supported output template annotations: .ID, .Name, .Description, .Default, .Zone, .CreatedAt, .DhcpOptions, .Labels, .Subnets ``` exo networking vpc update VPC-NAME|ID [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--description` | VPC description | | `--dns-server` | DHCP option 6: DNS servers (can be specified multiple times) | | `--domain-search` | DHCP option 119: domain search list (can be specified multiple times) | | `--help, -h` | help for update | | `--label` | VPC label (format: key=value), clearing the labels is possible by passing [=] | | `--name` | VPC name | | `--ntp-server` | DHCP option 42: NTP servers (can be specified multiple times) | | `--zone, -z` | VPC zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [vpc](https://community.exoscale.com/reference/cli/exo/networking/vpc/index.md) - Virtual Private Cloud management --- url: https://community.exoscale.com/reference/cli/exo/status/ --- # exo status ``` exo status [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for status | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily --- url: https://community.exoscale.com/reference/cli/exo/storage/ --- # exo storage ### Description Manage Exoscale Object Storage ``` exo storage [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for storage | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily * [exo storage bucket](https://community.exoscale.com/reference/cli/exo/storage/bucket/index.md) - Object Storage Bucket management * [exo storage copy](https://community.exoscale.com/reference/cli/exo/storage/copy/index.md) - Copy objects within a bucket or across buckets * [exo storage cors](https://community.exoscale.com/reference/cli/exo/storage/cors/index.md) - Manage buckets CORS configuration * [exo storage delete](https://community.exoscale.com/reference/cli/exo/storage/delete/index.md) - Delete objects * [exo storage download](https://community.exoscale.com/reference/cli/exo/storage/download/index.md) - Download files from a bucket * [exo storage headers](https://community.exoscale.com/reference/cli/exo/storage/headers/index.md) - Manage objects HTTP headers * [exo storage list](https://community.exoscale.com/reference/cli/exo/storage/list/index.md) - List buckets and objects * [exo storage mb](https://community.exoscale.com/reference/cli/exo/storage/mb/index.md) - Create a new bucket * [exo storage metadata](https://community.exoscale.com/reference/cli/exo/storage/metadata/index.md) - Manage objects metadata * [exo storage move](https://community.exoscale.com/reference/cli/exo/storage/move/index.md) - Move objects within a bucket or across buckets * [exo storage presign](https://community.exoscale.com/reference/cli/exo/storage/presign/index.md) - Generate a pre-signed URL to an object * [exo storage purge](https://community.exoscale.com/reference/cli/exo/storage/purge/index.md) - Purge objects and their versions * [exo storage rb](https://community.exoscale.com/reference/cli/exo/storage/rb/index.md) - Delete a bucket * [exo storage setacl](https://community.exoscale.com/reference/cli/exo/storage/setacl/index.md) - Set a bucket/objects ACL * [exo storage show](https://community.exoscale.com/reference/cli/exo/storage/show/index.md) - Show a bucket/object details * [exo storage upload](https://community.exoscale.com/reference/cli/exo/storage/upload/index.md) - Upload files to a bucket --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/ --- # exo storage bucket ### Description Object Storage Bucket management ``` exo storage bucket [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for bucket | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management * [exo storage bucket lifecycle](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/index.md) - Object Storage Bucket lifecycle management * [exo storage bucket object-ownership](https://community.exoscale.com/reference/cli/exo/storage/bucket/object-ownership/index.md) - Manage the Object Ownership setting of a Storage Bucket * [exo storage bucket replication](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/index.md) - Object Storage Bucket replication management * [exo storage bucket versioning](https://community.exoscale.com/reference/cli/exo/storage/bucket/versioning/index.md) - Manage the Object Versioning setting of a Storage Bucket --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/ --- # exo storage bucket lifecycle ### Description Object Storage Bucket lifecycle management ``` exo storage bucket lifecycle [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for lifecycle | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [bucket](https://community.exoscale.com/reference/cli/exo/storage/bucket/index.md) - Object Storage Bucket management * [exo storage bucket lifecycle delete](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/delete/index.md) - Delete lifecycle configuration * [exo storage bucket lifecycle set](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/set/index.md) - Set lifecycle configuration * [exo storage bucket lifecycle show](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/show/index.md) - Retrieve lifecycle configuration --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/delete/ --- # exo storage bucket lifecycle delete ### Description Delete lifecycle configuration ``` exo storage bucket lifecycle delete sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for delete | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [lifecycle](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/index.md) - Object Storage Bucket lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/set/ --- # exo storage bucket lifecycle set ### Description Set a lifecycle configuration for a bucket. Example of a valid lifecycle configuration: { "Rules": [ { "Status": "Enabled", "Expiration": { "Days": 30 }, "Filter": { "Prefix": "" }, "ID": "expire-after-30-days" } ] } ``` exo storage bucket lifecycle set sos://BUCKET path/to/lifecycle.json [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for set | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [lifecycle](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/index.md) - Object Storage Bucket lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/show/ --- # exo storage bucket lifecycle show ### Description Retrieve lifecycle configuration ``` exo storage bucket lifecycle show sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [lifecycle](https://community.exoscale.com/reference/cli/exo/storage/bucket/lifecycle/index.md) - Object Storage Bucket lifecycle management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/object-ownership/ --- # exo storage bucket object-ownership ### Description Manage the Object Ownership setting of a Storage Bucket ``` exo storage bucket object-ownership {status,object-writer,bucket-owner-enforced,bucket-owner-preferred} sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for object-ownership | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [bucket](https://community.exoscale.com/reference/cli/exo/storage/bucket/index.md) - Object Storage Bucket management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/ --- # exo storage bucket replication ### Description Object Storage Bucket replication management ``` exo storage bucket replication [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for replication | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [bucket](https://community.exoscale.com/reference/cli/exo/storage/bucket/index.md) - Object Storage Bucket management * [exo storage bucket replication delete](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/delete/index.md) - Delete replication configuration * [exo storage bucket replication set](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/set/index.md) - set replication configuration * [exo storage bucket replication show](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/show/index.md) - Retrieve replication configuration --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/delete/ --- # exo storage bucket replication delete ``` exo storage bucket replication delete sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for delete | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [replication](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/index.md) - Object Storage Bucket replication management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/set/ --- # exo storage bucket replication set ### Description Set a replication configuration for a bucket. Bucket versioning needs to be enabled for both source and target bucket Example of a valid replication configuration: { "Role": "role-uuid", "Rules": [ { "Status": "Enabled", "Priority": 1, "DeleteMarkerReplication": { "Status": "Disabled" }, "Filter" : { "Prefix": ""}, "Destination": { "Bucket": "target-bucket" }, "ID": "foo" } ] } More information at https://docs.aws.amazon.com/cli/latest/reference/s3api/put-bucket-replication.html#options & https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html ``` exo storage bucket replication set sos://BUCKET path/to/replication.json [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for set | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [replication](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/index.md) - Object Storage Bucket replication management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/show/ --- # exo storage bucket replication show ``` exo storage bucket replication show sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [replication](https://community.exoscale.com/reference/cli/exo/storage/bucket/replication/index.md) - Object Storage Bucket replication management --- url: https://community.exoscale.com/reference/cli/exo/storage/bucket/versioning/ --- # exo storage bucket versioning ### Description Manage the Object Versioning setting of a Storage Bucket ``` exo storage bucket versioning {status,enable,suspend} sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for versioning | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [bucket](https://community.exoscale.com/reference/cli/exo/storage/bucket/index.md) - Object Storage Bucket management --- url: https://community.exoscale.com/reference/cli/exo/storage/copy/ --- # exo storage copy ### Description Copy objects within a bucket or across buckets. This command copies objects server-side without downloading them. Object metadata, headers, and ACLs are preserved. Existing destination objects are overwritten. Multi-object prefix copies are processed serially. A trailing slash on the source selects prefix mode; -r controls recursion into subdirectories. Examples: exo storage copy sos://my-bucket/file-a sos://my-bucket/folder/file-a exo storage copy sos://my-bucket/file-a sos://other-bucket/file-a exo storage copy -r sos://my-bucket/prefix/ sos://other-bucket/prefix/ exo storage copy -n sos://my-bucket/file-a sos://other-bucket/file-a ``` exo storage copy sos://BUCKET/[OBJECT|PREFIX/] sos://BUCKET/[OBJECT|PREFIX/] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--dry-run, -n` | simulate the copy operation | | `--force, -f` | skip confirmation prompt | | `--help, -h` | help for copy | | `--multipart-concurrency` | number of concurrent parts for multipart copies | | `--recursive, -r` | copy objects recursively | | `--verbose, -v` | output copied objects | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/cors/ --- # exo storage cors ### Description These commands allow you to manage the CORS configuration of a bucket. For more information on CORS, please refer to the Exoscale Storage documentation: https://community.exoscale.com/documentation/storage/cors/ Notes: * It is not possible to edit a CORS configuration rule once it's been created, nor to delete rules individually -- the whole configuration must be reset using the "exo storage cors reset" command. ``` exo storage cors [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for cors | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management * [exo storage cors add](https://community.exoscale.com/reference/cli/exo/storage/cors/add/index.md) - Add a CORS configuration rule to a bucket * [exo storage cors delete](https://community.exoscale.com/reference/cli/exo/storage/cors/delete/index.md) - Delete the CORS configuration of a bucket --- url: https://community.exoscale.com/reference/cli/exo/storage/cors/add/ --- # exo storage cors add ### Description This command adds a new rule to the current bucket CORS configuration. Example: exo storage cors add sos://my-bucket \ --allowed-origin "https://my-website.net" \ --allowed-method "*" ``` exo storage cors add sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--allowed-header` | allowed header (can be repeated multiple times) | | `--allowed-method` | allowed method (can be repeated multiple times) | | `--allowed-origin` | allowed origin (can be repeated multiple times) | | `--help, -h` | help for add | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [cors](https://community.exoscale.com/reference/cli/exo/storage/cors/index.md) - Manage buckets CORS configuration --- url: https://community.exoscale.com/reference/cli/exo/storage/cors/delete/ --- # exo storage cors delete ``` exo storage cors delete sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for delete | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [cors](https://community.exoscale.com/reference/cli/exo/storage/cors/index.md) - Manage buckets CORS configuration --- url: https://community.exoscale.com/reference/cli/exo/storage/delete/ --- # exo storage delete ### Description This command deletes objects stored in a bucket. If you want to target objects under a "directory" prefix, suffix the path argument with "/": exo storage delete sos://my-bucket/ exo storage delete -r sos://my-bucket/some-directory/ ``` exo storage delete sos://BUCKET/[OBJECT|PREFIX/] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for delete | | `--recursive, -r` | delete objects recursively | | `--verbose, -v` | output deleted objects | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/download/ --- # exo storage download ### Description This command downloads files from a bucket. If no destination argument is provided, files will be stored into the current directory. Examples: # Download a single file exo storage download sos://my-bucket/file-a # Download a single file and rename it locally exo storage download sos://my-bucket/file-a file-z # Download a prefix recursively (creating the folder tree if needed) exo storage download -r sos://my-bucket/public/ /tmp/public/ ``` exo storage download sos://BUCKET/[OBJECT|PREFIX/] [DESTINATION] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--dry-run, -n` | simulate files download, don't actually do it | | `--force, -f` | overwrite existing destination files | | `--help, -h` | help for download | | `--recursive, -r` | download prefix recursively | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/headers/ --- # exo storage headers ``` exo storage headers [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for headers | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management * [exo storage headers add](https://community.exoscale.com/reference/cli/exo/storage/headers/add/index.md) - Add HTTP headers to an object * [exo storage headers delete](https://community.exoscale.com/reference/cli/exo/storage/headers/delete/index.md) - Delete HTTP headers from an object --- url: https://community.exoscale.com/reference/cli/exo/storage/headers/add/ --- # exo storage headers add ### Description This command adds response HTTP headers to objects. Example: exo storage headers add sos://my-bucket/data.json \ --content-type=application/json \ --cache-control=no-store Note: adding an already existing header will overwrite its value. Supported output template annotations: .Path, .Bucket, .LastModified, .Size, .ACL, .Metadata, .Headers, .URL, .ReplicationStatus ``` exo storage headers add sos://BUCKET/(OBJECT|PREFIX/) [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--cache-control` | value for "Cache-Control" header | | `--content-disposition` | value for "Content-Disposition" header | | `--content-encoding` | value for "Content-Encoding" header | | `--content-language` | value for "Content-Language" header | | `--content-type` | value for "Content-Type" header | | `--expires` | value for "Expires" header | | `--help, -h` | help for add | | `--recursive, -r` | add headers recursively (with object prefix only) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [headers](https://community.exoscale.com/reference/cli/exo/storage/headers/index.md) - Manage objects HTTP headers --- url: https://community.exoscale.com/reference/cli/exo/storage/headers/delete/ --- # exo storage headers delete ### Description This command deletes response HTTP headers from objects. Example: exo storage headers delete sos://my-bucket/data.json \ --cache-control \ --expires Note: the "Content-Type" header cannot be removed, it is reset to its default value "application/binary". Supported output template annotations: .Path, .Bucket, .LastModified, .Size, .ACL, .Metadata, .Headers, .URL, .ReplicationStatus ``` exo storage headers delete sos://BUCKET/(OBJECT|PREFIX/) [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--cache-control` | delete the "Cache-Control" header | | `--content-disposition` | delete the "Content-Disposition" header | | `--content-encoding` | delete the "Content-Encoding" header | | `--content-language` | delete the "Content-Language" header | | `--content-type` | delete the "Content-Type" header | | `--expires` | delete the "Expires" header | | `--help, -h` | help for delete | | `--recursive, -r` | delete headers recursively (with object prefix only) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [headers](https://community.exoscale.com/reference/cli/exo/storage/headers/index.md) - Manage objects HTTP headers --- url: https://community.exoscale.com/reference/cli/exo/storage/list/ --- # exo storage list ### Description This command lists buckets and their objects. If no argument is passed, this commands lists existing buckets. If a prefix is specified (e.g. "sos://my-bucket/.../") the command lists the objects stored in the bucket under the corresponding prefix. Supported output template annotations: * When listing buckets: .Name, .Zone, .Size, .Created * When listing objects: .Path, .Size, .LastModified, .Dir, .VersionID, .VersionNumber ``` exo storage list [sos://BUCKET[/[PREFIX/]] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--exclude-versions` | exclude versions from being listed; accepts comma separated version IDs(865029700534464769) and numbers(v123); implies --versions | | `--help, -h` | help for list | | `--newer-than` | only objects newer than a duration. Accepts durations in the format of Go's time.ParseDuration. examples: "2h45m", "10m", "45s" | | `--newer-than-timestamp` | only objects newer than an ISO 8601 timestamp. examples: '2023-06-07T10:00:00+02:00', use the date command $(date -d "yesterday 10am" --iso-8601=seconds) | | `--older-than` | only objects older than a duration. Accepts durations in the format of Go's time.ParseDuration. examples: "2h45m", "10m", "45s" | | `--older-than-timestamp` | only objects older than an ISO 8601 timestamp. examples: '2023-06-07T10:00:00+02:00', use the date command $(date -d "yesterday 10am" --iso-8601=seconds) | | `--only-versions` | limit the versions to be listed; accepts comma separated version IDs(865029700534464769) and numbers(v123); implies --versions | | `--recursive, -r` | list bucket recursively | | `--stream, -s` | stream listed files instead of waiting for complete listing (useful for large buckets) | | `--versions` | list all versions of objects(if the bucket is versioned) | | `--zone, -z` | Exoscale zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/mb/ --- # exo storage mb ### Description This command creates a new bucket. Supported output template annotations: .Name, .Zone, .ACL, .CORS, .ObjectOwnership ``` exo storage mb sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--acl` | canned ACL to set on bucket (private\|public-read\|public-read-write\|authenticated-read) | | `--help, -h` | help for mb | | `--zone, -z` | bucket zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/metadata/ --- # exo storage metadata ``` exo storage metadata [command] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for metadata | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management * [exo storage metadata add](https://community.exoscale.com/reference/cli/exo/storage/metadata/add/index.md) - Add key/value metadata to an object * [exo storage metadata delete](https://community.exoscale.com/reference/cli/exo/storage/metadata/delete/index.md) - Delete metadata from an object --- url: https://community.exoscale.com/reference/cli/exo/storage/metadata/add/ --- # exo storage metadata add ### Description This command adds key/value metadata to an object. Example: exo storage metadata add sos://my-bucket/object-a \ k1=v1 \ k2=v2 Notes: * Adding an already existing key will overwrite its value. * The following characters are not allowed in keys: ( ) < > @ , ; ! : \ \ ' & " / [ ] ? _ = { } Supported output template annotations: .Path, .Bucket, .LastModified, .Size, .ACL, .Metadata, .Headers, .URL, .ReplicationStatus ``` exo storage metadata add sos://BUCKET/(OBJECT|PREFIX/) KEY=VALUE... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for add | | `--recursive, -r` | add metadata recursively (with object prefix only) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [metadata](https://community.exoscale.com/reference/cli/exo/storage/metadata/index.md) - Manage objects metadata --- url: https://community.exoscale.com/reference/cli/exo/storage/metadata/delete/ --- # exo storage metadata delete ### Description This command deletes key/value metadata from an object. Example: exo storage metadata delete sos://my-bucket/object-a k1 Supported output template annotations: .Path, .Bucket, .LastModified, .Size, .ACL, .Metadata, .Headers, .URL, .ReplicationStatus ``` exo storage metadata delete sos://BUCKET/(OBJECT|PREFIX/) KEY... [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for delete | | `--recursive, -r` | delete metadata recursively (with object prefix only) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [metadata](https://community.exoscale.com/reference/cli/exo/storage/metadata/index.md) - Manage objects metadata --- url: https://community.exoscale.com/reference/cli/exo/storage/move/ --- # exo storage move ### Description Move objects within a bucket or across buckets. This command moves objects by performing a server-side copy followed by a delete of the source object. Object metadata, headers, and ACLs are preserved. Warning: move is implemented as server-side copy followed by delete. If the delete step fails after a successful copy, the object will remain in both locations. There is no automatic rollback. Multi-object prefix moves are processed serially. A trailing slash on the source selects prefix mode; -r controls recursion into subdirectories. Examples: exo storage move sos://my-bucket/file-a sos://my-bucket/folder/file-a exo storage move sos://my-bucket/file-a sos://other-bucket/file-a exo storage move -r sos://my-bucket/prefix/ sos://other-bucket/prefix/ exo storage move -n sos://my-bucket/file-a sos://other-bucket/file-a ``` exo storage move sos://BUCKET/[OBJECT|PREFIX/] sos://BUCKET/[OBJECT|PREFIX/] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--dry-run, -n` | simulate the move operation | | `--force, -f` | skip confirmation prompt | | `--help, -h` | help for move | | `--multipart-concurrency` | number of concurrent parts for multipart moves | | `--recursive, -r` | move objects recursively | | `--verbose, -v` | output moved objects | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/presign/ --- # exo storage presign ``` exo storage presign sos://BUCKET/OBJECT [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--expires, -e` | expiration duration for the generated pre-signed URL (e.g. "1h45m", "30s"); supported units: "s", "m", "h" | | `--help, -h` | help for presign | | `--method, -m` | pre-signed URL method (get\|put) | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/purge/ --- # exo storage purge ### Description This command purges objects and object versions stored in a bucket. exo storage purge sos://my-bucket/ exo storage purge sos://my-bucket/some-prefix/ ``` exo storage purge sos://BUCKET/[OBJECT|PREFIX/] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for purge | | `--verbose, -v` | output deleted objects | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/rb/ --- # exo storage rb ``` exo storage rb sos://BUCKET [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--force, -f` | attempt to perform the operation without prompting for confirmation | | `--help, -h` | help for rb | | `--recursive, -r` | empty the bucket before deleting it | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/setacl/ --- # exo storage setacl ### Description This command sets bucket/objects ACL. It can be used in 2 (mutually exclusive) forms: * With a "canned" ACL: exo storage setacl sos://my-bucket public-read * With explicit Access Control Policy (ACP) grantees: exo storage setacl sos://my-bucket \ --full-control alice@example.net \ --read bob@example.net Supported canned ACLs: * For buckets: private, public-read, public-read-write, authenticated-read * For objects: private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control In ACP mode, it is possible to use the following special values to reference pre-defined groups: * ALL_USERS (as in "public-read" canned ACL) * AUTHENTICATED_USERS (as in "authenticated-read" canned ACL) For more information on ACL, please refer to the Exoscale Storage documentation: https://community.exoscale.com/documentation/storage/acl/ If you want to target objects under a "directory" prefix, suffix the path argument with "/": exo storage setacl sos://my-bucket/ --full-control alice@example.net exo storage setacl -r sos://my-bucket/public/ public-read Supported output template annotations: * When showing a bucket: .Name, .Zone, .ACL, .CORS, .ObjectOwnership * When showing an object: .Path, .Bucket, .LastModified, .Size, .ACL, .Metadata, .Headers, .URL, .ReplicationStatus ``` exo storage setacl sos://BUCKET/[OBJECT|PREFIX/] [CANNED-ACL] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--full-control` | ACP Full Control grantee | | `--help, -h` | help for setacl | | `--read` | ACL Read grantee | | `--read-acp` | ACP Read ACP grantee | | `--recursive, -r` | set ACL recursively (with object prefix only) | | `--write` | ACP Write grantee | | `--write-acp` | ACP Write ACP grantee | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/show/ --- # exo storage show ### Description This command lists Storage buckets and objects. Supported output template annotations: * When showing a bucket: .Name, .Zone, .ACL, .CORS, .ObjectOwnership * When showing an object: .Path, .Bucket, .LastModified, .Size, .ACL, .Metadata, .Headers, .URL, .ReplicationStatus ``` exo storage show sos://BUCKET/[OBJECT] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for show | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/storage/upload/ --- # exo storage upload ### Description This command uploads local files to a bucket. Examples: # Upload files at the root of the bucket exo storage upload a b c sos://my-bucket # Upload files in a directory (trailing "/" in destination) exo storage upload index.html sos://my-bucket/public/ # Upload a file under a different name exo storage upload a.txt sos://my-bucket/z.txt # Upload a directory recursively exo storage upload -r my-files/ sos://my-bucket ``` exo storage upload FILE... sos://BUCKET/[PREFIX/] [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--acl` | canned ACL to set on object (private\|public-read\|public-read-write\|authenticated-read\|aws-exec-read\|bucket-owner-read\|bucket-owner-full-control) | | `--dry-run, -n` | simulate files upload, don't actually do it | | `--help, -h` | help for upload | | `--recursive, -r` | upload directories recursively | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [storage](https://community.exoscale.com/reference/cli/exo/storage/index.md) - Object Storage management --- url: https://community.exoscale.com/reference/cli/exo/version/ --- # exo version ``` exo version [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for version | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily --- url: https://community.exoscale.com/reference/cli/exo/zone/ --- # exo zone ### Description This command lists available Exoscale zones. Supported output template annotations: .Name ``` exo zone [flags] ``` ### Options | Option | Description | | --------- | ------------ | | `--help, -h` | help for zone | ### Options inherited from parent commands | Option | Description | | --------- | ------------ | | `--config, -C` | Specify an alternate config file [env EXOSCALE_CONFIG] | | `--output-format, -O` | Output format (table\|json\|text), see "exo output --help" for more information | | `--output-template` | Template to use if output format is "text" | | `--quiet, -Q` | Quiet mode (disable non-essential command output) | | `--timeout` | Per-zone timeout for list operations; -1s disables timeout [env EXOSCALE_TIMEOUT] | | `--use-account, -A` | Account to use in config file [env EXOSCALE_ACCOUNT] | ### Related Commands * [exo](https://community.exoscale.com/reference/cli/exo/index.md) - Manage your Exoscale infrastructure easily