Fix filter and test docs (#215)
* Fix filter and test documentation syntax errors. Most cases were strings that were YAML-parsable as dictionaries due to colons, sometimes of the form `str: str`, and sometimes of the form `str: list`. Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>pull/219/head
Felix Fontein
GitHub
parent
3f05496840
commit
b73ed61a47
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
trivial:
|
||||
- Fix the filter and test documentation to render well on the Ansible docsite.
|
||||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents an IP address of a host or network</div>
|
||||
<div>{'For example': '10.1.1.1'}</div>
|
||||
<div>For example: <code>10.1.1.1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -69,7 +69,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A list of string and each string represents a network address in CIDR form</div>
|
||||
<div>{'For example': ['10.0.0.0/8', '192.168.1.0/24']}</div>
|
||||
<div>For example: <code>['10.0.0.0/8', '192.168.1.0/24']</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents an IP address</div>
|
||||
<div>{'For example': '10.1.1.1'}</div>
|
||||
<div>For example: <code>10.1.1.1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -69,7 +69,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the network address in CIDR form</div>
|
||||
<div>{'For example': '10.0.0.0/8'}</div>
|
||||
<div>For example: <code>10.0.0.0/8</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents an IP address</div>
|
||||
<div>{'For example': '10.1.1.1'}</div>
|
||||
<div>For example: <code>10.1.1.1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -69,7 +69,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A list of string and each string represents a network address in CIDR form</div>
|
||||
<div>{'For example': ['10.0.0.0/8', '192.168.1.0/24']}</div>
|
||||
<div>For example: <code>['10.0.0.0/8', '192.168.1.0/24']</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -132,7 +132,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>The value used to test each list item against.</div>
|
||||
<div>{'Not required for simple tests (eg': '<code>true</code>, <code>false</code>, <code>even</code>, <code>odd</code>)'}</div>
|
||||
<div>Not required for simple tests (eg: <code>true</code>, <code>false</code>, <code>even</code>, <code>odd</code>)</div>
|
||||
<div>May be a <code>string</code>, <code>boolean</code>, <code>number</code>, <code>regular expression</code> <code>dict</code> and so on, depending on the <code>test</code> used</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', 'hello-world']}</div>
|
||||
<div>For example: <code>10.1.1.1</code> or <code>"hello-world"</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', '2001:db8:a::123', 'hello-world']}</div>
|
||||
<div>For example: <code>10.1.1.1</code>, <code>2001:db8:a::123</code>, or <code>"hello-world"</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ Parameters
|
|||
<td>
|
||||
<div>You can provide a single argument to each ipaddr() filter.</div>
|
||||
<div>The filter will then treat it as a query and return values modified by that query.</div>
|
||||
<div>{'Types of queries include': [{'query by name': "ansible.utils.ipaddr('address'), ansible.utils.ipv4('network');"}, {'query by CIDR range': "ansible.utils.ipaddr('192.168.0.0/24'), ansible.utils.ipv6('2001:db8::/32');"}, {'query by index number': "ansible.utils.ipaddr('1'), ansible.utils.ipaddr('-1');"}]}</div>
|
||||
<div>Types of queries include: 1. query by name: ansible.utils.ipaddr('address'), ansible.utils.ipv4('network'); 2. query by CIDR range: ansible.utils.ipaddr('192.168.0.0/24'), ansible.utils.ipv6('2001:db8::/32'); 3. query by index number: ansible.utils.ipaddr('1'), ansible.utils.ipaddr('-1');</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', '10.0.0.0/8', 'fe80::216:3eff:fee4:16f3']}</div>
|
||||
<div>For example: <code>10.1.1.1</code>, <code>10.0.0.0/8</code>, or <code>fe80::216:3eff:fee4:16f3</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['0.1.255.255', '255.255.255.0']}</div>
|
||||
<div>For example: <code>0.1.255.255</code> or <code>255.255.255.0</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['0.1.255.255', '255.255.255.0']}</div>
|
||||
<div>For example: <code>0.1.255.255</code> or <code>255.255.255.0</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', '10.0.0.0/8', 'fe80::216:3eff:fee4:16f3']}</div>
|
||||
<div>For example: <code>10.1.1.1</code>, <code>10.0.0.0/8</code>, or <code>fe80::216:3eff:fee4:16f3</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', '10.0.0.0/8', 'fe80::216:3eff:fee4:16f3']}</div>
|
||||
<div>For example: <code>10.1.1.1</code>, <code>10.0.0.0/8</code>, or <code>fe80::216:3eff:fee4:16f3</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['::FFFF:10.1.1.1', '::AAAA:10.1.1.1', 'helloworld']}</div>
|
||||
<div>For example: <code>::FFFF:10.1.1.1</code>, <code>::AAAA:10.1.1.1</code>, or <code>"helloworld"</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['2002:c0a8:6301:1::1', '::AAAA:10.1.1.1', 'hello_world']}</div>
|
||||
<div>For example: <code>2002:c0a8:6301:1::1</code>, <code>::AAAA:10.1.1.1</code>, or <code>"hello_world"</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['2001::c0a8:6301:1', '2002::c0a8:6301:1', 'hello_world']}</div>
|
||||
<div>For example: <code>2001::c0a8:6301:1</code>, <code>2002::c0a8:6301:1</code>, or <code>"hello_world"</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', '10.0.0.0/8', 'fe80::216:3eff:fee4:16f3']}</div>
|
||||
<div>For example: <code>10.1.1.1</code>, <code>10.0.0.0/8</code>, or <code>fe80::216:3eff:fee4:16f3</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['127.0.0.1', '2002::c0a8:6301:1']}</div>
|
||||
<div>For example: <code>127.0.0.1</code> or <code>2002::c0a8:6301:1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['02:16:3e:e4:16:f3', '02-16-3e-e4-16-f3', '0216.3ee4.16f3', '02163ee416f3']}</div>
|
||||
<div>For example: <code>02:16:3e:e4:16:f3</code>, <code>02-16-3e-e4-16-f3</code>, <code>0216.3ee4.16f3</code>, or <code>02163ee416f3</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['224.0.0.1', '127.0.0.1']}</div>
|
||||
<div>For example: <code>224.0.0.1</code> or <code>127.0.0.1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['10.1.1.1', '8.8.8.8', '192.168.1.250']}</div>
|
||||
<div>For example: <code>10.1.1.1</code>, <code>8.8.8.8</code>, or <code>192.168.1.250</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['8.8.8.8', '10.1.1.1', '192.168.1.250']}</div>
|
||||
<div>For example: <code>8.8.8.8</code>, <code>10.1.1.1</code>, or <code>192.168.1.250</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['253.0.0.1', '128.146.1.7']}</div>
|
||||
<div>For example: <code>253.0.0.1</code> or <code>128.146.1.7</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the IP address or the host name</div>
|
||||
<div>{'For example': ['docs.ansible.com', '127.0.0.1', '::1']}</div>
|
||||
<div>For example: <code>"docs.ansible.com"</code>, <code>127.0.0.1</code>, or <code>::1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the first network address</div>
|
||||
<div>{'For example': ['10.1.1.0/24']}</div>
|
||||
<div>For example: <code>10.1.1.0/24</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -69,7 +69,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the second network address</div>
|
||||
<div>{'For example': ['10.0.0.0/8']}</div>
|
||||
<div>For example: <code>10.0.0.0/8</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the first network address</div>
|
||||
<div>{'For example': ['10.1.1.0/24']}</div>
|
||||
<div>For example: <code>10.1.1.0/24</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -69,7 +69,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the second network address</div>
|
||||
<div>{'For example': ['10.0.0.0/8']}</div>
|
||||
<div>For example: <code>10.0.0.0/8</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents the value against which the test is going to be performed</div>
|
||||
<div>{'For example': ['0.0.0.0', '0:0:0:0:0:0:0:0', '::', '::1']}</div>
|
||||
<div>For example: <code>0.0.0.0</code>, <code>0:0:0:0:0:0:0:0</code>, <code>::</code>, or <code>::1</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Parameters
|
|||
</td>
|
||||
<td>
|
||||
<div>A string that represents an IP address of network in CIDR form</div>
|
||||
<div>{'For example': ['10.0.0.0/24', '2001:db8:abcd:0012::0/124']}</div>
|
||||
<div>For example: <code>10.0.0.0/24</code> or <code>2001:db8:abcd:0012::0/124</code></div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ DOCUMENTATION = """
|
|||
value:
|
||||
description:
|
||||
- The value used to test each list item against.
|
||||
- Not required for simple tests (eg: C(true), C(false), C(even), C(odd))
|
||||
- 'Not required for simple tests (eg: C(true), C(false), C(even), C(odd))'
|
||||
- May be a C(string), C(boolean), C(number), C(regular expression) C(dict) and so on, depending on the C(test) used
|
||||
type: raw
|
||||
key:
|
||||
|
|
|
|||
|
|
@ -61,10 +61,11 @@ DOCUMENTATION = """
|
|||
description:
|
||||
- You can provide a single argument to each ipaddr() filter.
|
||||
- The filter will then treat it as a query and return values modified by that query.
|
||||
- Types of queries include:
|
||||
- query by name: ansible.utils.ipaddr('address'), ansible.utils.ipv4('network');
|
||||
- query by CIDR range: ansible.utils.ipaddr('192.168.0.0/24'), ansible.utils.ipv6('2001:db8::/32');
|
||||
- query by index number: ansible.utils.ipaddr('1'), ansible.utils.ipaddr('-1');
|
||||
- >-
|
||||
Types of queries include:
|
||||
1. query by name: ansible.utils.ipaddr('address'), ansible.utils.ipv4('network');
|
||||
2. query by CIDR range: ansible.utils.ipaddr('192.168.0.0/24'), ansible.utils.ipv6('2001:db8::/32');
|
||||
3. query by index number: ansible.utils.ipaddr('1'), ansible.utils.ipaddr('-1');
|
||||
type: str
|
||||
default: ''
|
||||
version:
|
||||
|
|
|
|||
|
|
@ -31,9 +31,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents an IP address of network in CIDR form
|
||||
- For example:
|
||||
- "10.0.0.0/24"
|
||||
- "2001:db8:abcd:0012::0/124"
|
||||
- 'For example: C(10.0.0.0/24) or C(2001:db8:abcd:0012::0/124)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents an IP address of a host or network
|
||||
- For example: "10.1.1.1"
|
||||
- 'For example: C(10.1.1.1)'
|
||||
type: str
|
||||
required: True
|
||||
networks:
|
||||
description:
|
||||
- A list of string and each string represents a network address in CIDR form
|
||||
- For example: ['10.0.0.0/8', '192.168.1.0/24']
|
||||
- "For example: C(['10.0.0.0/8', '192.168.1.0/24'])"
|
||||
type: list
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -30,13 +30,13 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents an IP address
|
||||
- For example: "10.1.1.1"
|
||||
- 'For example: C(10.1.1.1)'
|
||||
type: str
|
||||
required: True
|
||||
network:
|
||||
description:
|
||||
- A string that represents the network address in CIDR form
|
||||
- For example: "10.0.0.0/8"
|
||||
- 'For example: C(10.0.0.0/8)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -28,13 +28,13 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents an IP address
|
||||
- For example: "10.1.1.1"
|
||||
- 'For example: C(10.1.1.1)'
|
||||
type: str
|
||||
required: True
|
||||
networks:
|
||||
description:
|
||||
- A list of string and each string represents a network address in CIDR form
|
||||
- For example: ['10.0.0.0/8', '192.168.1.0/24']
|
||||
- "For example: C(['10.0.0.0/8', '192.168.1.0/24'])"
|
||||
type: list
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "2001:db8:a::123"
|
||||
- "hello-world"
|
||||
- 'For example: C(10.1.1.1), C(2001:db8:a::123), or C("hello-world")'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,9 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "hello-world"
|
||||
- 'For example: C(10.1.1.1) or C("hello-world")'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "10.0.0.0/8"
|
||||
- "fe80::216:3eff:fee4:16f3"
|
||||
- 'For example: C(10.1.1.1), C(10.0.0.0/8), or C(fe80::216:3eff:fee4:16f3)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "10.0.0.0/8"
|
||||
- "fe80::216:3eff:fee4:16f3"
|
||||
- 'For example: C(10.1.1.1), C(10.0.0.0/8), or C(fe80::216:3eff:fee4:16f3)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,9 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "0.1.255.255"
|
||||
- "255.255.255.0"
|
||||
- 'For example: C(0.1.255.255) or C(255.255.255.0)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,9 +29,7 @@ DOCUMENTATION = """
|
|||
mask:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "0.1.255.255"
|
||||
- "255.255.255.0"
|
||||
- 'For example: C(0.1.255.255) or C(255.255.255.0)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "10.0.0.0/8"
|
||||
- "fe80::216:3eff:fee4:16f3"
|
||||
- 'For example: C(10.1.1.1), C(10.0.0.0/8), or C(fe80::216:3eff:fee4:16f3)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "10.0.0.0/8"
|
||||
- "fe80::216:3eff:fee4:16f3"
|
||||
- 'For example: C(10.1.1.1), C(10.0.0.0/8), or C(fe80::216:3eff:fee4:16f3)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "::FFFF:10.1.1.1"
|
||||
- "::AAAA:10.1.1.1"
|
||||
- "helloworld"
|
||||
- 'For example: C(::FFFF:10.1.1.1), C(::AAAA:10.1.1.1), or C("helloworld")'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "2002:c0a8:6301:1::1"
|
||||
- "::AAAA:10.1.1.1"
|
||||
- "hello_world"
|
||||
- 'For example: C(2002:c0a8:6301:1::1), C(::AAAA:10.1.1.1), or C("hello_world")'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "2001::c0a8:6301:1"
|
||||
- "2002::c0a8:6301:1"
|
||||
- "hello_world"
|
||||
- 'For example: C(2001::c0a8:6301:1), C(2002::c0a8:6301:1), or C("hello_world")'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,9 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "127.0.0.1"
|
||||
- "2002::c0a8:6301:1"
|
||||
- 'For example: C(127.0.0.1) or C(2002::c0a8:6301:1)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -27,11 +27,7 @@ DOCUMENTATION = """
|
|||
mac:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "02:16:3e:e4:16:f3"
|
||||
- "02-16-3e-e4-16-f3"
|
||||
- "0216.3ee4.16f3"
|
||||
- "02163ee416f3"
|
||||
- 'For example: C(02:16:3e:e4:16:f3), C(02-16-3e-e4-16-f3), C(0216.3ee4.16f3), or C(02163ee416f3)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,9 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "224.0.0.1"
|
||||
- "127.0.0.1"
|
||||
- 'For example: C(224.0.0.1) or C(127.0.0.1)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "10.1.1.1"
|
||||
- "8.8.8.8"
|
||||
- "192.168.1.250"
|
||||
- 'For example: C(10.1.1.1), C(8.8.8.8), or C(192.168.1.250)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,10 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "8.8.8.8"
|
||||
- "10.1.1.1"
|
||||
- "192.168.1.250"
|
||||
- 'For example: C(8.8.8.8), C(10.1.1.1), or C(192.168.1.250)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,9 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "253.0.0.1"
|
||||
- "128.146.1.7"
|
||||
- 'For example: C(253.0.0.1) or C(128.146.1.7)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -36,10 +36,7 @@ DOCUMENTATION = """
|
|||
host:
|
||||
description:
|
||||
- A string that represents the IP address or the host name
|
||||
- For example:
|
||||
- "docs.ansible.com"
|
||||
- 127.0.0.1
|
||||
- ::1
|
||||
- 'For example: C("docs.ansible.com"), C(127.0.0.1), or C(::1)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -30,15 +30,13 @@ DOCUMENTATION = """
|
|||
network_a:
|
||||
description:
|
||||
- A string that represents the first network address
|
||||
- For example:
|
||||
- "10.1.1.0/24"
|
||||
- 'For example: C(10.1.1.0/24)'
|
||||
type: str
|
||||
required: True
|
||||
network_b:
|
||||
description:
|
||||
- A string that represents the second network address
|
||||
- For example:
|
||||
- "10.0.0.0/8"
|
||||
- 'For example: C(10.0.0.0/8)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -30,15 +30,13 @@ DOCUMENTATION = """
|
|||
network_a:
|
||||
description:
|
||||
- A string that represents the first network address
|
||||
- For example:
|
||||
- "10.1.1.0/24"
|
||||
- 'For example: C(10.1.1.0/24)'
|
||||
type: str
|
||||
required: True
|
||||
network_b:
|
||||
description:
|
||||
- A string that represents the second network address
|
||||
- For example:
|
||||
- "10.0.0.0/8"
|
||||
- 'For example: C(10.0.0.0/8)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
|
|
@ -29,11 +29,7 @@ DOCUMENTATION = """
|
|||
ip:
|
||||
description:
|
||||
- A string that represents the value against which the test is going to be performed
|
||||
- For example:
|
||||
- "0.0.0.0"
|
||||
- "0:0:0:0:0:0:0:0"
|
||||
- "::"
|
||||
- "::1"
|
||||
- 'For example: C(0.0.0.0), C(0:0:0:0:0:0:0:0), C(::), or C(::1)'
|
||||
type: str
|
||||
required: True
|
||||
notes:
|
||||
|
|
|
|||
Loading…
Reference in New Issue