mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Reword documentation for IOS L2/L3 interface modules (#44870)
* Update documentation to be cohesive with ios_l2_interface * Fix small typo in documentation
This commit is contained in:
parent
fdb1d1146f
commit
c9adfdf68b
2 changed files with 8 additions and 8 deletions
|
@ -19,7 +19,7 @@ extends_documentation_fragment: ios
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
short_description: Manage Layer-2 interface on Cisco IOS devices.
|
short_description: Manage Layer-2 interface on Cisco IOS devices.
|
||||||
description:
|
description:
|
||||||
- This module provides declarative management of Layer-2 interface on
|
- This module provides declarative management of Layer-2 interfaces on
|
||||||
Cisco IOS devices.
|
Cisco IOS devices.
|
||||||
author:
|
author:
|
||||||
- Nathaniel Case (@qalthos)
|
- Nathaniel Case (@qalthos)
|
||||||
|
|
|
@ -17,33 +17,33 @@ DOCUMENTATION = """
|
||||||
module: ios_l3_interface
|
module: ios_l3_interface
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
author: "Ganesh Nalawade (@ganeshrn)"
|
author: "Ganesh Nalawade (@ganeshrn)"
|
||||||
short_description: Manage L3 interfaces on Cisco IOS network devices.
|
short_description: Manage Layer-3 interfaces on Cisco IOS network devices.
|
||||||
description:
|
description:
|
||||||
- This module provides declarative management of L3 interfaces
|
- This module provides declarative management of Layer-3 interfaces
|
||||||
on IOS network devices.
|
on IOS network devices.
|
||||||
notes:
|
notes:
|
||||||
- Tested against IOS 15.2
|
- Tested against IOS 15.2
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the L3 interface to be configured eg. GigabitEthernet0/2
|
- Name of the Layer-3 interface to be configured eg. GigabitEthernet0/2
|
||||||
ipv4:
|
ipv4:
|
||||||
description:
|
description:
|
||||||
- IPv4 address to be set for the L3 interface mentioned in I(name) option.
|
- IPv4 address to be set for the Layer-3 interface mentioned in I(name) option.
|
||||||
The address format is <ipv4 address>/<mask>, the mask is number
|
The address format is <ipv4 address>/<mask>, the mask is number
|
||||||
in range 0-32 eg. 192.168.0.1/24
|
in range 0-32 eg. 192.168.0.1/24
|
||||||
ipv6:
|
ipv6:
|
||||||
description:
|
description:
|
||||||
- IPv6 address to be set for the L3 interface mentioned in I(name) option.
|
- IPv6 address to be set for the Layer-3 interface mentioned in I(name) option.
|
||||||
The address format is <ipv6 address>/<mask>, the mask is number
|
The address format is <ipv6 address>/<mask>, the mask is number
|
||||||
in range 0-128 eg. fd5d:12c9:2201:1::1/64
|
in range 0-128 eg. fd5d:12c9:2201:1::1/64
|
||||||
aggregate:
|
aggregate:
|
||||||
description:
|
description:
|
||||||
- List of L3 interfaces definitions. Each of the entry in aggregate list should
|
- List of Layer-3 interfaces definitions. Each of the entry in aggregate list should
|
||||||
define name of interface C(name) and a optional C(ipv4) or C(ipv6) address.
|
define name of interface C(name) and a optional C(ipv4) or C(ipv6) address.
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- State of the L3 interface configuration. It indicates if the configuration should
|
- State of the Layer-3 interface configuration. It indicates if the configuration should
|
||||||
be present or absent on remote device.
|
be present or absent on remote device.
|
||||||
default: present
|
default: present
|
||||||
choices: ['present', 'absent']
|
choices: ['present', 'absent']
|
||||||
|
|
Loading…
Reference in a new issue