Skip to content

Commit 0c71340

Browse files
QalthosQalthos
committed
Regenerate docs with antsibull collection-plugins 
1 parent 30eb278 commit 0c71340

File tree

37 files changed

+7313
-5943
lines changed

37 files changed

+7313
-5943
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
---
22
repos:
3-
- repo: https://github.com/ansible-network/collection_prep
4-
rev: 1.1.1
5-
hooks:
6-
- id: update-docs
7-
83
- repo: https://github.com/pre-commit/pre-commit-hooks
94
rev: v4.5.0
105
hooks:

‎docs/ansible.netcommon.cli_backup_module.rst‎

Lines changed: 115 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1-
.. _ansible.netcommon.cli_backup_module:
21

2+
.. Created with antsibull-docs 2.9.0
33
4-
****************************
5-
ansible.netcommon.cli_backup
6-
****************************
4+
ansible.netcommon.cli_backup module -- Back up device configuration from network devices over network\_cli
5+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
76

8-
**Back up device configuration from network devices over network_cli**
7+
This module is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).
98

9+
It is not included in ``ansible-core``.
10+
To check whether it is installed, run ``ansible-galaxy collection list``.
1011

11-
Version added: 4.2.0
12+
To install it, use: :code:`ansible-galaxy collection install ansible.netcommon`.
13+
14+
To use it in a playbook, specify: ``ansible.netcommon.cli_backup``.
15+
16+
New in ansible.netcommon 4.2.0
1217

1318
.. contents::
1419
:local:
@@ -17,7 +22,13 @@ Version added: 4.2.0
1722

1823
Synopsis
1924
--------
20-
- This module provides platform agnostic way of backing up text based configuration from network devices over network_cli connection plugin.
25+
26+
- This module provides platform agnostic way of backing up text based configuration from network devices over network\_cli connection plugin.
27+
28+
This module has a corresponding action plugin.
29+
30+
31+
2132

2233

2334

@@ -27,123 +38,130 @@ Parameters
2738

2839
.. raw:: html
2940

30-
<table border=0 cellpadding=0 class="documentation-table">
31-
<tr>
32-
<th colspan="1">Parameter</th>
33-
<th>Choices/<font color="blue">Defaults</font></th>
34-
<th width="100%">Comments</th>
35-
</tr>
36-
<tr>
37-
<td colspan="1">
38-
<div class="ansibleOptionAnchor" id="parameter-"></div>
39-
<b>defaults</b>
40-
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
41-
<div style="font-size: small">
42-
<span style="color: purple">boolean</span>
43-
</div>
44-
</td>
45-
<td>
46-
<ul style="margin: 0; padding: 0"><b>Choices:</b>
47-
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
48-
<li>yes</li>
49-
</ul>
50-
</td>
51-
<td>
52-
<div>The <em>defaults</em> argument will influence how the running-config is collected from the device. When the value is set to true, the command used to collect the running-config is append with the all keyword. When the value is set to false, the command is issued without the all keyword.</div>
53-
</td>
54-
</tr>
55-
<tr>
56-
<td colspan="1">
57-
<div class="ansibleOptionAnchor" id="parameter-"></div>
58-
<b>dir_path</b>
59-
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
60-
<div style="font-size: small">
61-
<span style="color: purple">path</span>
62-
</div>
63-
</td>
64-
<td>
65-
</td>
66-
<td>
67-
<div>This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of <code>filename</code> or default filename as described in <code>filename</code> options description. If the path value is not given in that case a <em>backup</em> directory will be created in the current working directory and backup configuration will be copied in <code>filename</code> within <em>backup</em> directory.</div>
68-
</td>
69-
</tr>
70-
<tr>
71-
<td colspan="1">
72-
<div class="ansibleOptionAnchor" id="parameter-"></div>
73-
<b>filename</b>
74-
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
75-
<div style="font-size: small">
76-
<span style="color: purple">string</span>
77-
</div>
78-
</td>
79-
<td>
80-
</td>
81-
<td>
82-
<div>The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by &lt;hostname&gt;_config.&lt;current-date&gt;@&lt;current-time&gt;</div>
83-
</td>
84-
</tr>
85-
</table>
86-
<br/>
41+
<table style="width: 100%;">
42+
<thead>
43+
<tr>
44+
<th><p>Parameter</p></th>
45+
<th><p>Comments</p></th>
46+
</tr>
47+
</thead>
48+
<tbody>
49+
<tr>
50+
<td valign="top">
51+
<div class="ansibleOptionAnchor" id="parameter-defaults"></div>
52+
<p style="display: inline;"><strong>defaults</strong></p>
53+
<a class="ansibleOptionLink" href="#parameter-defaults" title="Permalink to this option"></a>
54+
<p style="font-size: small; margin-bottom: 0;">
55+
<span style="color: purple;">boolean</span>
56+
</p>
57+
</td>
58+
<td valign="top">
59+
<p>The <em>defaults</em> argument will influence how the running-config is collected from the device. When the value is set to true, the command used to collect the running-config is append with the all keyword. When the value is set to false, the command is issued without the all keyword.</p>
60+
<p style="margin-top: 8px;"><b">Choices:</b></p>
61+
<ul>
62+
<li><p><code style="color: blue;"><b>false</b></code> <span style="color: blue;">← (default)</span></p></li>
63+
<li><p><code>true</code></p></li>
64+
</ul>
65+
66+
</td>
67+
</tr>
68+
<tr>
69+
<td valign="top">
70+
<div class="ansibleOptionAnchor" id="parameter-dir_path"></div>
71+
<p style="display: inline;"><strong>dir_path</strong></p>
72+
<a class="ansibleOptionLink" href="#parameter-dir_path" title="Permalink to this option"></a>
73+
<p style="font-size: small; margin-bottom: 0;">
74+
<span style="color: purple;">path</span>
75+
</p>
76+
</td>
77+
<td valign="top">
78+
<p>This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of <code class='docutils literal notranslate'>filename</code> or default filename as described in <code class='docutils literal notranslate'>filename</code> options description. If the path value is not given in that case a <em>backup</em> directory will be created in the current working directory and backup configuration will be copied in <code class='docutils literal notranslate'>filename</code> within <em>backup</em> directory.</p>
79+
</td>
80+
</tr>
81+
<tr>
82+
<td valign="top">
83+
<div class="ansibleOptionAnchor" id="parameter-filename"></div>
84+
<p style="display: inline;"><strong>filename</strong></p>
85+
<a class="ansibleOptionLink" href="#parameter-filename" title="Permalink to this option"></a>
86+
<p style="font-size: small; margin-bottom: 0;">
87+
<span style="color: purple;">string</span>
88+
</p>
89+
</td>
90+
<td valign="top">
91+
<p>The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by &lt;hostname&gt;_config.&lt;current-date&gt;@&lt;current-time&gt;</p>
92+
</td>
93+
</tr>
94+
</tbody>
95+
</table>
96+
97+
8798
8899
89100
Notes
90101
-----
91102
92-
.. note::
93-
- This module is supported on ``ansible_network_os`` network platforms. See the :ref:`Network Platform Options <platform_options>` for details.
94-
103+
- This module is supported on \ :literal:`ansible\_network\_os`\ network platforms. See the :ref:\`Network Platform Options \<platform\_options\>\` for details.
95104
96105
97106
Examples
98107
--------
99108
100109
.. code-block:: yaml
101110
111+
102112
- name: configurable backup path
103113
ansible.netcommon.cli_backup:
104114
filename: backup.cfg
105115
dir_path: /home/user
106116
107117
108118
119+
120+
109121
Return Values
110122
-------------
111-
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:
123+
The following are the fields unique to this module:
112124
113125
.. raw:: html
114126
115-
<table border=0 cellpadding=0 class="documentation-table">
116-
<tr>
117-
<th colspan="1">Key</th>
118-
<th>Returned</th>
119-
<th width="100%">Description</th>
120-
</tr>
121-
<tr>
122-
<td colspan="1">
123-
<div class="ansibleOptionAnchor" id="return-"></div>
124-
<b>backup_path</b>
125-
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
126-
<div style="font-size: small">
127-
<span style="color: purple">string</span>
128-
</div>
129-
</td>
130-
<td>always</td>
131-
<td>
132-
<div>The full path to the backup file</div>
133-
<br/>
134-
<div style="font-size: smaller"><b>Sample:</b></div>
135-
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">/playbooks/ansible/backup/hostname_config.2016-07-16@22:28:34</div>
136-
</td>
137-
</tr>
138-
</table>
139-
<br/><br/>
140-
141-
142-
Status
143-
------
127+
<table style="width: 100%;">
128+
<thead>
129+
<tr>
130+
<th><p>Key</p></th>
131+
<th><p>Description</p></th>
132+
</tr>
133+
</thead>
134+
<tbody>
135+
<tr>
136+
<td valign="top">
137+
<div class="ansibleOptionAnchor" id="return-backup_path"></div>
138+
<p style="display: inline;"><strong>backup_path</strong></p>
139+
<a class="ansibleOptionLink" href="#return-backup_path" title="Permalink to this return value"></a>
140+
<p style="font-size: small; margin-bottom: 0;">
141+
<span style="color: purple;">string</span>
142+
</p>
143+
</td>
144+
<td valign="top">
145+
<p>The full path to the backup file</p>
146+
<p style="margin-top: 8px;"><b>Returned:</b> always</p>
147+
<p style="margin-top: 8px; color: blue; word-wrap: break-word; word-break: break-all;"><b style="color: black;">Sample:</b> <code>&#34;/playbooks/ansible/backup/hostname_config.2016-07-16@22:28:34&#34;</code></p>
148+
</td>
149+
</tr>
150+
</tbody>
151+
</table>
152+
153+
144154
145155
146156
Authors
147157
~~~~~~~
148158
149159
- Kate Case (@Qalthos)
160+
161+
162+
163+
Collection links
164+
~~~~~~~~~~~~~~~~
165+
166+
* `Issue Tracker <https://github.com/ansible-collections/ansible.netcommon/issues>`__
167+
* `Repository (Sources) <https://github.com/ansible-collections/ansible.netcommon>`__

0 commit comments

Comments
 (0)