Consul Operator Utilization

Command: consul operator utilization

Corresponding HTTP API Endpoint: [GET] /v1/operator/utilization

The operator utilization command generates a license utilization bundle that you may share with HashiCorp. This command writes the bundle to a JSON file and optionally sends the bundle automatically to HashiCorp during generation.

Air-gapped environments or environments that are unable to satisfy automatic reporting requirements can use the operator utilization command to generate a license utilization report that you can send to HashiCorp directly or submit using a different process.

Refer to Automated license utilization reporting for more details.

The following tableshows this command's required ACLs. Commands do not support configuration of blocking queries or agent caching, but the corresponding HTTP endpoint may support that configuration. | ACL Required | | ---------------- | | operator:read |

Usage

Usage: consul operator utilization [options]

Command options

• -message=<string> - Optional context that is logged with the utilization export.

• -today-only - Include only the most recent utilization snapshot.

• -y - Automatically send the utilization report to HashiCorp.

Examples

This example exports all snapshots in a bundle.

$ consul operator utilization -message "Change Control 12345"

Use the -today-only parameter to export only today's data.

$ consul operator utilization -today-only

Use the -output parameter to specify a custom file path for bundle output.

$ consul operator utilization -output "/reports/latest.json"