HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Nomad
Nomad Home

nomad acl role update command reference

The acl role update command is used to update existing ACL Roles.

Usage

nomad acl role update [options] <role_id>

The acl role update command requires an existing role's ID.

Options

  • -name: Sets the human-readable name for the ACL Role. It is required and can contain alphanumeric characters and dashes. This name must be unique and must not exceed 128 characters.

  • -description: A free form text description of the role that must not exceed 256 characters.

  • -policy: Specifies a policy to associate with the role identified by their name. This flag can be specified multiple times and must be specified at least once.

  • -no-merge: Do not merge the current role information with what is provided to the command. Instead, overwrite all fields with the exception of the role ID which is immutable.

  • -json: Output the ACL role in a JSON format.

  • -t: Format and display the ACL role using a Go template.

Examples

Update an existing ACL token:

$ nomad acl role update -name="example-acl-role-updated" a53b0095-c28a-6181-0586-807b82e665e4
ID           = a53b0095-c28a-6181-0586-807b82e665e4
Name         = example-acl-role-updated
Description  = <none>
Policies     = general-write
Create Index = 71
Modify Index = 80

General options

  • -address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.

  • -region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region.

  • -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set. This option takes precedence over -force-color.

  • -force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR may be set. This option has no effect if -no-color is also used.

  • -ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_CACERT environment variable if set.

  • -ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -ca-cert and -ca-path are specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment variable if set.

  • -client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -client-key. Overrides the NOMAD_CLIENT_CERT environment variable if set.

  • -client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY environment variable if set.

  • -tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.

  • -tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.

  • -token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.

Edit this page on GitHub