Manage self-managed workers

You can use the following procedures to manage self-managed workers in HCP Boundary:

View available workers

Use the following command to view a list of any available workers:

$ boundary workers listWorker information:  ID:                        w_r61cCrlm4M    Type:                    pki    Version:                 1    Address:                 100.24.18.207:9202    Last Status Time:        Mon, 19 Sep 2022 22:40:02 UTC    Authorized Actions:      no-op      read      update      delete      add-worker-tags      set-worker-tags      remove-worker-tags  ID:                        w_FYy3CJipUd    Type:                    kms    Version:                 1    Name:                    797132fe-1fcb-1bb8-122c-abfb32acad39-worker    Address:                 797132fe-1fcb-1bb8-122c-abfb32acad39.proxy.boundary.hashicorp.cloud:9202    Last Status Time:        Mon, 19 Sep 2022 22:40:02 UTC    Authorized Actions:      no-op      read      delete      add-worker-tags      set-worker-tags      remove-worker-tags  ID:                        w_djfIunfBrR    Type:                    kms    Version:                 1    Name:                    78eaad58-5e3f-4b04-83f6-360ef8828f07-worker    Address:                 78eaad58-5e3f-4b04-83f6-360ef8828f07.proxy.boundary.hashicorp.cloud:9202    Last Status Time:        Mon, 19 Sep 2022 22:40:03 UTC    Authorized Actions:      no-op      read      delete      add-worker-tags      set-worker-tags      remove-worker-tags  ID:                        w_xv0uKOxQW5    Type:                    kms    Version:                 1    Name:                    33c9d3bd-7326-2cf8-58ba-ee99ec43d34a-worker    Address:                 33c9d3bd-7326-2cf8-58ba-ee99ec43d34a.proxy.boundary.hashicorp.cloud:9202    Last Status Time:        Mon, 19 Sep 2022 22:40:03 UTC    Authorized Actions:      no-op      read      delete      add-worker-tags      set-worker-tags      remove-worker-tags

View worker details

You can view information about the workers you have registered with HCP. Viewing worker information can be useful if you need to copy worker details, such as the self-managed worker ID (w_r61cCrlm4M in the example below).

Use the following command to read the worker details:

$ boundary workers read -id w_r61cCrlm4MWorker information:  Active Connection Count:   0  Address:                   100.24.18.207:9202  Created Time:              Mon, 19 Sep 2022 16:39:44 MDT  ID:                        w_r61cCrlm4M  Last Status Time:          2022-09-19 22:40:41.133773 +0000 UTC  Type:                      pki  Updated Time:              Mon, 19 Sep 2022 16:40:41 MDT  Version:                   1  Scope:    ID:                      global    Name:                    global    Type:                    global  Tags:    Configuration:      type: ["worker" "dev"]    Canonical:      type: ["worker" "dev"]  Authorized Actions:    no-op    read    update    delete    add-worker-tags    set-worker-tags    remove-worker-tags

Update self-managed workers

To update a self-managed worker, issue an update request using the worker ID. The request should include the fields to update.

$ boundary workers update -id=w_r61cCrlm4M -name="worker1" -description="my first self-managed worker"Worker information:  Active Connection Count:   0  Address:                   100.24.18.207:9202  Created Time:              Mon, 19 Sep 2022 16:39:44 MDT  Description:               my first self-managed worker  ID:                        w_r61cCrlm4M  Last Status Time:          2022-09-19 22:41:04.793293 +0000 UTC  Name:                      worker1  Type:                      pki  Updated Time:              Mon, 19 Sep 2022 16:41:05 MDT  Version:                   2  Scope:    ID:                      global    Name:                    global    Type:                    global  Tags:    Configuration:      type: ["worker" "dev"]    Canonical:      type: ["worker" "dev"]  Authorized Actions:    no-op    read    update    delete    add-worker-tags    set-worker-tags    remove-worker-tags

Updating a worker will return the updated resource details.

Delete self-managed workers

Use the boundary workers delete command and pass the worker ID, to delete a self-managed worker. To verify deletion, check the worker no longer exists with boundary workers list.