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

     1  ---
     2  layout: docs
     3  page_title: 'Commands: recommendation list'
     4  description: |
     5    The recommendation list command is used to list the available recommendations.
     6  ---
     7  
     8  # Command: recommendation list
     9  
    10  The `recommendation list` command is used to list the available recommendations.
    11  
    12  ~> Recommendation commands are new in Nomad 1.0 and are only available with
    13  Nomad Enterprise.
    14  
    15  ## Usage
    16  
    17  ```plaintext
    18  nomad recommendation list [options]
    19  ```
    20  
    21  The `recommendation list` command requires no arguments.
    22  
    23  When ACLs are enabled, this command requires a token with the `submit-job`,
    24  `read-job`, and `submit-recommendation` capabilities for the namespace being
    25  queried.
    26  
    27  ## General Options
    28  
    29  @include 'general_options.mdx'
    30  
    31  ## List Options
    32  
    33  - `-job`: Specifies the job ID to filter the recommendations list by.
    34  
    35  - `-group`: Specifies the task group name to filter within a job. If specified,
    36    the `-job` flag must also be specified.
    37  
    38  - `-task`: Specifies the task name to filter within a job and task group. If
    39    specified, the `-job` and `-group` flags must also be specified.
    40  
    41  - `-json`: Output the recommendations in its JSON format.
    42  
    43  - `-t`: Format and display the recommendations using a Go template.
    44  
    45  ## Examples
    46  
    47  List all available recommendations:
    48  
    49  ```shell-session
    50  $ nomad recommendation list
    51  ID                                    Job      Group     Task   Resource  Value
    52  ea130ac3-1410-cfe0-f34d-adc3ca94712d  example  cache-lb  nginx  CPU       57
    53  68236421-c90f-efa6-fc02-37ae2d59bf03  example  cache     redis  CPU       57
    54  980c2554-7a1b-0c51-933a-f46850a228bd  example  cache     redis  MemoryMB  10
    55  ```
    56  
    57  List all available recommendations for the job `example` and the task group `cache`:
    58  
    59  ```shell-session
    60  $ nomad recommendation list -job=example -group=cache
    61  ID                                    Job      Group  Task   Resource  Value
    62  68236421-c90f-efa6-fc02-37ae2d59bf03  example  cache  redis  CPU       57
    63  980c2554-7a1b-0c51-933a-f46850a228bd  example  cache  redis  MemoryMB  10
    64  ```