github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/docs/commands/recommendation/list.mdx (about)

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