summaryrefslogtreecommitdiff
path: root/docs/vyos.vyos.vyos_static_route_module.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/vyos.vyos.vyos_static_route_module.rst')
-rw-r--r--docs/vyos.vyos.vyos_static_route_module.rst95
1 files changed, 89 insertions, 6 deletions
diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst
index 854cc7f..848d5a0 100644
--- a/docs/vyos.vyos.vyos_static_route_module.rst
+++ b/docs/vyos.vyos.vyos_static_route_module.rst
@@ -62,7 +62,7 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
- </div>
+ / <span style="color: purple">elements=dictionary</span> </div>
</td>
<td>
</td>
@@ -70,7 +70,92 @@ Parameters
<div>List of static route definitions</div>
</td>
</tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>admin_distance</b>
+ <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+ <div style="font-size: small">
+ <span style="color: purple">integer</span>
+ </div>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Admin distance of the static route.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>mask</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>Network prefix mask of the static route.</div>
+ </td>
+ </tr>
<tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>next_hop</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>Next hop IP of the static route.</div>
+ </td>
+ </tr>
+ <tr>
+ <td class="elbow-placeholder"></td>
+ <td colspan="1">
+ <div class="ansibleOptionAnchor" id="parameter-"></div>
+ <b>prefix</b>
+ <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>
+ </td>
+ <td>
+ </td>
+ <td>
+ <div>Network prefix of the static route. <code>mask</code> param should be ignored if <code>prefix</code> is provided with <code>mask</code> value <code>prefix/mask</code>.</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 static route configuration.</div>
+ </td>
+ </tr>
+
+ <tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>mask</b>
@@ -142,7 +227,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 +262,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 +294,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>