website: document machine-readable output
This commit is contained in:
Mitchell Hashimoto
parent
42a71a953d
commit
15d639c8dc
|
|
@ -30,7 +30,7 @@ module VagrantPlugins
|
|||
"#{current_state.short_description} (#{machine.provider_name})"
|
||||
|
||||
opts = { scope: machine.name.to_s }
|
||||
@env.ui.machine("provider", machine.provider_name, opts)
|
||||
@env.ui.machine("provider-name", machine.provider_name, opts)
|
||||
@env.ui.machine("state", current_state.id, opts)
|
||||
@env.ui.machine("state-human-short", current_state.short_description, opts)
|
||||
@env.ui.machine("state-human-long", current_state.long_description, opts)
|
||||
|
|
|
|||
|
|
@ -119,6 +119,7 @@
|
|||
<li<%= sidebar_current("cli-status") %>><a href="/v2/cli/status.html">status</a></li>
|
||||
<li<%= sidebar_current("cli-suspend") %>><a href="/v2/cli/suspend.html">suspend</a></li>
|
||||
<li<%= sidebar_current("cli-up") %>><a href="/v2/cli/up.html">up</a></li>
|
||||
<li<%= sidebar_current("cli-machinereadable") %>><a href="/v2/cli/machine-readable.html">Machine Readable Output</a></li>
|
||||
</ul>
|
||||
<% end %>
|
||||
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ h6 {
|
|||
line-height: @font-size;
|
||||
}
|
||||
|
||||
p {
|
||||
p, td {
|
||||
letter-spacing: 1px;
|
||||
line-height: 32px;
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,11 @@
|
|||
/* compontents */
|
||||
|
||||
table.mr-types {
|
||||
th.mr-type {
|
||||
width: 200px;
|
||||
}
|
||||
}
|
||||
|
||||
//search
|
||||
.search-bar {
|
||||
border-bottom: 1px solid fade(@black, 10%);
|
||||
|
|
|
|||
|
|
@ -0,0 +1,110 @@
|
|||
---
|
||||
page_title: "Machine Readable Output - Command-Line Interface"
|
||||
sidebar_current: "cli-machinereadable"
|
||||
---
|
||||
|
||||
# Machine Readable Output
|
||||
|
||||
Every Vagrant commands accepts a `--machine-readable` flag which enables
|
||||
machine readable output mode. In this mode, the output to the terminal
|
||||
is replaced with machine-friendly output.
|
||||
|
||||
This mode makes it easy to programmatically execute Vagrant and read data
|
||||
out of it. This output format is protected by our
|
||||
[backwards compatibility](/v2/installation/backwards-compatibility.html)
|
||||
policy. Until Vagrant 2.0 is released, however, the machine readable output
|
||||
may change as we determine more use cases for it. But the backwards
|
||||
compatibility promise should make it safe to write client libraries to
|
||||
parse the output format.
|
||||
|
||||
<div class="alert alert-block alert-warn">
|
||||
<p>
|
||||
<strong>Advanced topic!</strong> This is an advanced topic for use only if
|
||||
you want to programmatically execute Vagrant. If you're just getting started
|
||||
with Vagrant, you may safely skip this section.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Format
|
||||
|
||||
The machine readable format is a line-oriented, comma-delimeted text format.
|
||||
This makes it extremely easy to parse using standard Unix tools such as awk or
|
||||
grep in addition to full programming languages like Ruby or Python.
|
||||
|
||||
The format is:
|
||||
|
||||
```
|
||||
timestamp,target,type,data...
|
||||
```
|
||||
|
||||
Each component is explained below:
|
||||
|
||||
* **timestamp** is a Unix timestamp in UTC of when the message was printed.
|
||||
|
||||
* **target** is the target of the following output. This is empty if the
|
||||
message is related to Vagrant globally. Otherwise, this is generally a machine
|
||||
name so you can relate output to a specific machine when multi-VM is in use.
|
||||
|
||||
* **type** is the type of machine-readable message being outputted. There are
|
||||
a set of standard types which are covered later.
|
||||
|
||||
* **data** is zero or more comma-seperated values associated with the prior
|
||||
type. The exact amount and meaning of this data is type-dependent, so you
|
||||
must read the documentation associated with the type to understand fully.
|
||||
|
||||
Within the format, if data contains a comma, it is replaced with
|
||||
`%!(VAGRANT_COMMA)`. This was preferred over an escape character such as \'
|
||||
because it is more friendly to tools like awk.
|
||||
|
||||
Newlines within the format are replaced with their respective standard escape
|
||||
sequence. Newlines become a literal `\n` within the output. Carriage returns
|
||||
become a literal `\r`.
|
||||
|
||||
## Types
|
||||
|
||||
This section documents all the available types that may be outputted
|
||||
with the machine-readable output.
|
||||
|
||||
<table class="table table-hover table-bordered mr-types">
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="mr-type">Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tr>
|
||||
<td>provider-name</td>
|
||||
<td>
|
||||
The provider name of the target machine.
|
||||
<span class="label">targetted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>state</td>
|
||||
<td>
|
||||
The state ID of the target machine.
|
||||
<span class="label">targetted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>state-human-long</td>
|
||||
<td>
|
||||
Human-readable description of the state of the machine. This is the
|
||||
long version, and may be a paragraph or longer.
|
||||
<span class="label">targetted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>state-human-short</td>
|
||||
<td>
|
||||
Human-readable description of the state of the machine. This is the
|
||||
short version, limited to at most a sentence.
|
||||
<span class="label">targetted</span>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
Loading…
Reference in New Issue