summaryrefslogtreecommitdiff
path: root/docs/vyos.vyos.vyos_logging_module.rst
diff options
context:
space:
mode:
authorGomathiselviS <gomathiselvi@gmail.com>2020-07-31 17:53:09 -0400
committerGitHub <noreply@github.com>2020-07-31 21:53:09 +0000
commit1b58f4b0195b866b5d322c314ce66dcf72f8a9af (patch)
treedc36dad6a908abb339c831b891ebaebdd753436b /docs/vyos.vyos.vyos_logging_module.rst
parent84e5bb7da5cbafdd64325d26d57abc9bcf79b2dc (diff)
downloadvyos.vyos-1b58f4b0195b866b5d322c314ce66dcf72f8a9af.tar.gz
vyos.vyos-1b58f4b0195b866b5d322c314ce66dcf72f8a9af.zip
Update docs (#73)
vyos: Update docs Reviewed-by: GomathiselviS https://github.com/GomathiselviS
Diffstat (limited to 'docs/vyos.vyos.vyos_logging_module.rst')
-rw-r--r--docs/vyos.vyos.vyos_logging_module.rst114
1 files changed, 102 insertions, 12 deletions
diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst
index 37d9a34e..c54f6361 100644
--- a/docs/vyos.vyos.vyos_logging_module.rst
+++ b/docs/vyos.vyos.vyos_logging_module.rst
@@ -39,8 +39,8 @@ Parameters
<b>aggregate</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
- <span style="color: purple">-</span>
- </div>
+ <span style="color: purple">list</span>
+ / <span style="color: purple">elements=dictionary</span> </div>
</td>
<td>
</td>
@@ -48,13 +48,105 @@ Parameters
<div>List of logging definitions.</div>
</td>
</tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>dest</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>console</li>
+ <li>file</li>
+ <li>global</li>
+ <li>host</li>
+ <li>user</li>
+ </ul>
+ </td>
+ <td>
+ <div>Destination of the logs.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>facility</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set logging facility.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>level</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Set logging severity levels.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>name</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>If value of <code>dest</code> is <em>file</em> it indicates file-name, for <em>user</em> it indicates username and for <em>host</em> indicates the host name to be notified.</div>
+ </td>
+ </tr>
<tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>state</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">string</span>
+ </div>
+ </td>
+ <td>
+ <ul style="margin: 0; padding: 0"><b>Choices:</b>
+ <li>present</li>
+ <li>absent</li>
+ </ul>
+ </td>
+ <td>
+ <div>State of the logging configuration.</div>
+ </td>
+ </tr>
+
+ <tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>dest</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
- <span style="color: purple">-</span>
+ <span style="color: purple">string</span>
</div>
</td>
<td>
@@ -76,7 +168,7 @@ Parameters
<b>facility</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
- <span style="color: purple">-</span>
+ <span style="color: purple">string</span>
</div>
</td>
<td>
@@ -91,7 +183,7 @@ Parameters
<b>level</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
- <span style="color: purple">-</span>
+ <span style="color: purple">string</span>
</div>
</td>
<td>
@@ -106,7 +198,7 @@ Parameters
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
- <span style="color: purple">-</span>
+ <span style="color: purple">string</span>
</div>
</td>
<td>
@@ -142,7 +234,7 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
- / <span style="color: red">required</span> </div>
+ </div>
</td>
<td>
</td>
@@ -177,8 +269,7 @@ Parameters
</div>
</td>
<td>
- <b>Default:</b><br/><div style="color: blue">22</div>
- </td>
+ </td>
<td>
<div>Specifies the port to use when building the connection to the remote device.</div>
</td>
@@ -210,8 +301,7 @@ Parameters
</div>
</td>
<td>
- <b>Default:</b><br/><div style="color: blue">10</div>
- </td>
+ </td>
<td>
<div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div>
</td>
@@ -239,7 +329,7 @@ Parameters
<b>state</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
- <span style="color: purple">-</span>
+ <span style="color: purple">string</span>
</div>
</td>
<td>