2017-10-12 01:24:58 +00:00
|
|
|
---
|
2020-02-06 23:45:31 +00:00
|
|
|
layout: docs
|
|
|
|
|
page_title: 'Commands: ui'
|
|
|
|
|
sidebar_title: ui
|
|
|
|
|
description: |
|
2017-10-12 01:24:58 +00:00
|
|
|
The ui command is used to open the Nomad Web UI.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Command: ui
|
|
|
|
|
|
|
|
|
|
The `ui` command is used to open the Nomad Web UI.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2019-10-22 13:44:00 +00:00
|
|
|
```plaintext
|
2017-10-12 01:24:58 +00:00
|
|
|
nomad ui [options] <identifier>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The `ui` command can be called with no arguments, in which case the UI homepage
|
|
|
|
|
will be opened in the default browser.
|
|
|
|
|
|
|
|
|
|
An identifier may be provided, in which case the UI will be opened to view the
|
|
|
|
|
details for that object. Supported identifiers are jobs, allocations and nodes.
|
|
|
|
|
|
2021-02-24 19:51:20 +00:00
|
|
|
If ACLs are enabled, the web UI will start in an unauthenticated state and you
|
|
|
|
|
may see a 403 Unauthorized page if anonymous read access is denied. The `nomad
|
2021-02-26 16:30:35 +00:00
|
|
|
ui -authenticate` option will exchange your command line client's Nomad ACL
|
|
|
|
|
token for a one-time token, which is passed to the web UI. That one-time token
|
|
|
|
|
will be exchanged for your Nomad ACL token and stored in the browser's local
|
|
|
|
|
storage for authentication.
|
2021-02-24 19:51:20 +00:00
|
|
|
|
2017-10-12 01:24:58 +00:00
|
|
|
## General Options
|
|
|
|
|
|
2020-11-19 18:02:48 +00:00
|
|
|
@include 'general_options_no_namespace.mdx'
|
2017-10-12 01:24:58 +00:00
|
|
|
|
2021-02-24 19:51:20 +00:00
|
|
|
## UI Options
|
|
|
|
|
|
2021-02-26 16:30:35 +00:00
|
|
|
- `-authenticate`: Exchange your Nomad ACL token for a one-time token in the
|
|
|
|
|
web UI.
|
2021-02-24 19:51:20 +00:00
|
|
|
|
2017-10-12 01:24:58 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
Open the UI homepage:
|
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ nomad ui
|
2017-10-12 01:24:58 +00:00
|
|
|
Opening URL "http://127.0.0.1:4646"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Open the UI directly to look at a job:
|
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ nomad ui redis-job
|
2017-10-12 16:42:11 +00:00
|
|
|
http://127.0.0.1:4646/ui/jobs/redis-job
|
2017-10-12 01:24:58 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Open the UI directly to look at an allocation:
|
|
|
|
|
|
2020-05-18 20:53:06 +00:00
|
|
|
```shell-session
|
|
|
|
|
$ nomad ui d4005969
|
2017-10-12 01:24:58 +00:00
|
|
|
Opening URL "http://127.0.0.1:4646/ui/allocations/d4005969-b16f-10eb-4fe1-a5374986083d"
|
|
|
|
|
```
|
2021-02-24 19:51:20 +00:00
|
|
|
|
2021-02-26 16:30:35 +00:00
|
|
|
Open the UI and authenticate using your ACL token:
|
2021-02-24 19:51:20 +00:00
|
|
|
|
|
|
|
|
```shell-session
|
2021-02-26 16:30:35 +00:00
|
|
|
$ NOMAD_ACL_TOKEN=e9674b26-763b-4637-a28f-0df95c53cdda nomad ui -authenticate
|
2021-02-24 19:51:20 +00:00
|
|
|
Opening URL "http://127.0.0.1:4646" with token
|
|
|
|
|
```
|
