NAME

grid-agent-list — List all agents

SYNOPSIS

grid agent list [FLAGS]

DESCRIPTION

List all agents in grid. If the service_id flag is specified, only agents corresponding to that service_id will be shown.

FLAGS

-F, --format

Specifies the output format of the list. Possible values for formatting are human and csv. Defaults to human.

-h, --help

Prints help information

--line-per-role

Displays agent information for each role on it’s own line. Useful when filtering by role.

-q, --quiet

Do not display output

-V, --version

Prints version information

-v

Increases verbosity (the opposite of -q). Specify multiple times for more output

OPTIONS

--service-id

The ID of the service the payload should be sent to; required if running on Splinter. Format: <circuit-id>::<service-id>.

--url

URL for the REST API

EXAMPLES

The command

$ grid agent list

Will list all agents and their associated roles

PUBLIC_KEY     ORG_ID ACTIVE ROLES              
03a3374bc95... crgl   true   productowner, admin

$ grid agent list --line-per-role

Will list all agents with roles on their own lines.

PUBLIC_KEY     ORG_ID ACTIVE ROLES              
03a3374bc95... crgl   true   productowner
03a3374bc95... crgl   true   admin

ENVIRONMENT VARIABLES

GRID_DAEMON_ENDPOINT

Specifies a default value for --url

GRID_SERVICE_ID

Specifies a default value for --service-id

SEE ALSO