Skip to content
Documentation

metalcloud-cli vm-pool config-example

Display a complete VM pool configuration example

Synopsis

Section titled “Synopsis”

Display a sample VM pool configuration in JSON format showing all available fields.

This command outputs an example configuration that can be used as a template for creating new VM pools. The example includes all required and optional fields with sample values.

The generated configuration can be:

  • Saved to a file and modified as needed
  • Used directly with the ‘create’ command via pipe

EXAMPLES:

Display configuration example

Section titled “Display configuration example”

metalcloud-cli vm-pool config-example

Save example to file for editing

Section titled “Save example to file for editing”

metalcloud-cli vm-pool config-example > vmpool-config.json

Create VM pool using example as template

Section titled “Create VM pool using example as template”

metalcloud-cli vm-pool config-example | jq ‘.name = “my-vmpool”’ | metalcloud-cli vm-pool create —config-source pipe

metalcloud-cli vm-pool config-example [flags]

Options

Section titled “Options”
  -h, --help   help for config-example

Options inherited from parent commands

Section titled “Options inherited from parent commands”
  -k, --api_key string         MetalCloud API key
  -c, --config string          Config file path
  -d, --debug                  Set to enable debug logging
  -e, --endpoint string        MetalCloud API endpoint
  -f, --format string          Output format. Supported values are 'text','csv','md','json','yaml'. (default "text")
  -i, --insecure_skip_verify   Set to allow insecure transport
  -l, --log_file string        Log file path
  -v, --verbosity string       Log level verbosity (default "INFO")

SEE ALSO

Section titled “SEE ALSO”

Auto generated by spf13/cobra on 11-Aug-2025

Section titled “Auto generated by spf13/cobra on 11-Aug-2025”