blob: bc5921d68ccb524d6265787b18e0fee853a38983 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
.. _vyos.rest.vyos_configure_module:
************************
vyos.rest.vyos_configure
************************
**Send raw set/delete commands to a VyOS device via REST API.**
Version added: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- Sends one or more set/delete configuration commands to a VyOS device via the HTTPS REST API as a single atomic batch commit.
- Useful for configuration not covered by dedicated resource modules, or for test setup and teardown tasks.
- Commands are parsed from CLI-style strings (``set ...`` / ``delete ...``).
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>commands</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span>
/ <span style="color: red">required</span>
</div>
</td>
<td>
</td>
<td>
<div>List of CLI-style configuration commands.</div>
<div>Each command must start with <code>set</code> or <code>delete</code>.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>save</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b> ←</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>Whether to save the configuration after applying commands.</div>
</td>
</tr>
</table>
<br/>
See Also
--------
.. seealso::
:ref:`vyos.vyos.vyos_config_module`
The official documentation on the **vyos.vyos.vyos_config** module.
Examples
--------
.. code-block:: yaml
- name: Add loopback address for testing
vyos.rest.vyos_configure:
commands:
- set interfaces loopback lo address 20.1.1.1/32
save: false
- name: Remove loopback address after testing
vyos.rest.vyos_configure:
commands:
- delete interfaces loopback lo address 20.1.1.1/32
save: false
- name: Multiple commands in one atomic commit
vyos.rest.vyos_configure:
commands:
- set system host-name vyos-test
- set system domain-name example.com
save: true
Return Values
-------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div>
<b>commands</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
</div>
</td>
<td>always</td>
<td>
<div>Parsed command payloads sent to the device.</div>
<br/>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div>
<b>response</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>when commands are applied</td>
<td>
<div>Raw API response.</div>
<br/>
</td>
</tr>
</table>
<br/><br/>
Status
------
Authors
~~~~~~~
- VyOS Community (@vyos)
|
