Manage Runners
Documentation menu

manage-runners external-runner update

Update an external runner's name, platform, labels, --dashboard or --send-to; the server gets changed settings only from a new install command

Required scopes runners:read, runners:write
Required flags none
Changes state yes
Destructive no
Paid resource effect none
Confirmation none
Non-interactive use supported

Usage

Update an external runner's name, platform, labels, --dashboard or --send-to; the server gets changed settings only from a new install command

Usage:
  manage-runners external-runner update [flags]

Flags:
      --dashboard string          show metrics in the dashboard: on|off; on requires an active paid subscription
      --id string                 external runner id
      --label stringArray         label; repeat for several; on update the given labels replace all, and --label '' removes them
      --name string               exact external runner name; resolving it needs runners:read
      --new-name string           rename the runner
      --no-send-to[=true|false]   send metrics to no connection
      --platform string           CI platform of the server: gitlab|github; autoscaling registers its burst runners there, so it cannot change while the runner has a policy
      --profile string            configuration profile
      --send-to string            send metrics to this Metrics connection: id, or a name, which needs runners:read; see metrics list; requires an active paid subscription

Every command also accepts the global flags. For machine-readable help, run manage-runners help external-runner update --output json.