metalcloud-cli site agents

List all agents deployed in a specific site

Synopsis

List all agents deployed in a specific site (datacenter) including their status and configuration.

This command retrieves information about all agents that are deployed within the specified site. Agents are software components that manage and monitor infrastructure within a datacenter. The output includes agent details such as ID, name, status, and deployment information.

Required Arguments: site_id_or_name Site identifier (ID or name) to list agents for

Required Permissions: sites:read - Permission to view site information

Examples:

List agents in a site by name

metalcloud-cli site agents “datacenter-01”

List agents in a site by ID

metalcloud-cli site agents 12345

List agents with JSON output

metalcloud-cli site agents “datacenter-01” –format json

metalcloud-cli site agents site_id_or_name [flags]

Options

  -h, --help   help for agents

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

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