HashiConf 2024 Now streaming live from Boston! Attend for free
Nomad
Nomad Home

Command: acl role info

The acl role info command is used to fetch information about an existing ACL Role.

Usage

nomad acl role info [options] <role_id> or <role_name>

The acl role info command requires an existing role's ID or name.

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.

Info Options

  • -by-name: Look up the ACL role using its name as the identifier. The command defaults to expecting the ACL ID as the argument.

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

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

Examples

Fetch information about an existing ACL Role using its ID:

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

Fetch information about an existing ACL Role using its name:

$ nomad acl role info -by-name example-acl-role
ID           = a53b0095-c28a-6181-0586-807b82e665e4
Name         = example-acl-role
Description  = <none>
Policies     = general-write
Create Index = 71
Modify Index = 71
Edit this page on GitHub