github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/acl/role/info.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: acl role info'
     4  description: |
     5    The role info command is used to fetch information about an existing ACL
     6    Role.
     7  ---
     8  
     9  # Command: acl role info
    10  
    11  The `acl role info` command is used to fetch information about an existing ACL Role.
    12  
    13  ## Usage
    14  
    15  ```plaintext
    16  nomad acl role info [options] <role_id> or <role_name>
    17  ```
    18  
    19  The `acl role info` command requires an existing role's ID or name.
    20  
    21  ## General Options
    22  
    23  @include 'general_options_no_namespace.mdx'
    24  
    25  ## Info Options
    26  
    27  - `-by-name`: Look up the ACL role using its name as the identifier. The
    28    command defaults to expecting the ACL ID as the argument.
    29  
    30  - `-json`: Output the ACL role in a JSON format.
    31  
    32  - `-t`: Format and display the ACL role using a Go template.
    33  
    34  ## Examples
    35  
    36  Fetch information about an existing ACL Role using its ID:
    37  
    38  ```shell-session
    39  $ nomad acl role info a53b0095-c28a-6181-0586-807b82e665e4
    40  ID           = a53b0095-c28a-6181-0586-807b82e665e4
    41  Name         = example-acl-role
    42  Description  = <none>
    43  Policies     = general-write
    44  Create Index = 71
    45  Modify Index = 71
    46  ```
    47  
    48  Fetch information about an existing ACL Role using its name:
    49  
    50  ```shell-session
    51  $ nomad acl role info -by-name example-acl-role
    52  ID           = a53b0095-c28a-6181-0586-807b82e665e4
    53  Name         = example-acl-role
    54  Description  = <none>
    55  Policies     = general-write
    56  Create Index = 71
    57  Modify Index = 71
    58  ```