open-nomad/website/pages/docs/commands/sentinel/read.mdx

47 lines
822 B
Plaintext
Raw Normal View History

2017-09-19 14:47:10 +00:00
---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: sentinel read'
sidebar_title: read
description: |
2017-09-19 14:47:10 +00:00
The sentinel read command is used to inspect a Sentinel policies.
---
# Command: sentinel read
The `sentinel read` command is used to inspect a Sentinel policy.
2018-03-22 20:39:18 +00:00
~> Sentinel commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
2017-09-19 14:47:10 +00:00
## Usage
```plaintext
2017-09-19 14:47:10 +00:00
nomad sentinel read [options] <Policy Name>
```
The `sentinel read` command requires a single argument, the policy name.
## General Options
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
2017-09-19 14:47:10 +00:00
## Read Options
- `-raw` : Output the raw policy only.
2017-09-19 14:47:10 +00:00
## Examples
Read all policies:
```shell
2017-09-19 14:47:10 +00:00
$ nomad sentinel read foo
Name = foo
Scope = submit-job
Enforcement Level = advisory
Description = my test policy
Policy:
main = rule { true }
```