internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 06:12:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[WIP] Network module docs 2.3 (#22454)

Browse Source 
* Tidy up docs for network 2.3 modules

* Use suboptions

* Correct indentation

* more tidyup

* bulk updates

* more tidyup

* Bulk changes

* nxos_mtu is dead

* revert

* NXOS_mtu is dead, also better layout

* rebase

* rebase
This commit is contained in:
John R Barker
2017-03-15 16:00:43 +00:00
committed by GitHub
parent b606bcec04
commit f82239e1f7
20 changed files with 594 additions and 767 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
lib/ansible/modules/network/eos/eos_banner.py
View File

@@ -35,27 +35,21 @@ extends_documentation_fragment: eos
options:
banner:
description:
- The C(banner) argument specifies the banner that should be
configured on the remote device. Current this module supports
configuration of either C(login) or C(motd) banners.
- Specifies which banner that should be
configured on the remote device.
required: true
default: null
choices: ['login', 'banner']
text:
description:
- The C(text) argument specifics the banner text that should be
- The banner text that should be
present in the remote device running configuration. This argument
accepts a multiline string.
required: false
accepts a multiline string. Requires I(state=present).
default: null
state:
description:
- The C(state) argument specifies whether or not the configuration is
present in the current devices active running configuration. When
this value is set to C(present), the configuration stanzas should be
in the current device configuration. When this value is set to
C(absent), the configuration should not be in the current running
configuration.
required: false
- Specifies whether or not the configuration is
present in the current devices active running configuration.
default: present
choices: ['present', 'absent']
"""
@@ -88,7 +82,7 @@ commands:
- EOF
session_name:
description: The EOS config session name used to load the configuration
returned: always
returned: if changes
type: str
sample: ansible_1479315771
"""

44
lib/ansible/modules/network/eos/eos_system.py
View File

@@ -36,55 +36,41 @@ extends_documentation_fragment: eos
options:
hostname:
description:
- The C(hostname) argument will configure the device hostname
parameter on Arista EOS devices. The C(hostname) value is an
ASCII string value.
required: false
default: null
- Configure the device hostname parameter. This option takes an ASCII string value.
domain_name:
description:
- The C(description) argument will configure the IP domain name
on the remote device to the provided value. The C(domain_name)
argument should be in the dotted name form and will be
- Configure the IP domain name
on the remote device to the provided value. Value
should be in the dotted name form and will be
appended to the C(hostname) to create a fully-qualified
domain name
required: false
default: null
domain_list:
domain name.
domain_search:
description:
- The C(domain_list) provides the list of domain suffixes to
- Provides the list of domain suffixes to
append to the hostname for the purpose of doing name resolution.
This argument accepts a list of names and will be reconciled
with the current active configuration on the running node.
required: false
default: null
lookup_source:
description:
- The C(lookup_source) argument provides one or more source
- Provides one or more source
interfaces to use for performing DNS lookups. The interface
provided in C(lookup_source) can only exist in a single VRF. This
argument accepts either a list of interface names or a list of
hashes that configure the interface name and VRF name. See
examples.
required: false
default: null
name_servers:
description:
- The C(name_serves) argument accepts a list of DNS name servers by
way of either FQDN or IP address to use to perform name resolution
lookups. This argument accepts wither a list of DNS servers or
- List of DNS name servers by IP address to use to perform name resolution
lookups. This argument accepts either a list of DNS servers or
a list of hashes that configure the name server and VRF name. See
examples.
required: false
default: null
state:
description:
- The C(state) argument configures the state of the configuration
- State of the configuration
values in the device's current active configuration. When set
to I(present), the values should be configured in the device active
configuration and when set to I(absent) the values should not be
in the device active configuration
required: false
default: present
choices: ['present', 'absent']
"""
@@ -93,7 +79,7 @@ EXAMPLES = """
- name: configure hostname and domain-name
eos_system:
hostname: eos01
domain_name: eng.ansible.com
domain_name: test.example.com
- name: remove configuration
eos_system:
@@ -131,10 +117,10 @@ commands:
type: list
sample:
- hostname eos01
- ip domain-name eng.ansible.com
- ip domain-name test.example.com
session_name:
description: The EOS config session name used to load the configuration
returned: when changed is True
returned: changed
type: str
sample: ansible_1479315771
"""
@@ -301,7 +287,7 @@ def main():
hostname=dict(),
domain_name=dict(),
domain_list=dict(type='list'),
domain_list=dict(type='list', aliases=['domain_search']),
# { interface: <str>, vrf: <str> }
lookup_source=dict(type='list'),

37
lib/ansible/modules/network/eos/eos_user.py
View File

@@ -41,15 +41,11 @@ options:
Arista EOS device. The list entries can either be the username
or a hash of username and properties. This argument is mutually
exclusive with the C(username) argument.
required: false
default: null
username:
description:
- The username to be configured on the remote Arista EOS
device. This argument accepts a stringv value and is mutually
exclusive with the C(users) argument.
required: false
default: null
update_password:
description:
- Since passwords are encrypted in the device running config, this
@@ -57,7 +53,6 @@ options:
set to C(always), the password will always be updated in the device
and when set to C(on_create) the password will be updated only if
the username is created.
required: false
default: always
choices: ['on_create', 'always']
privilege:
@@ -65,47 +60,37 @@ options:
- The C(privilege) argument configures the privilege level of the
user when logged into the system. This argument accepts integer
values in the range of 1 to 15.
required: false
default: null
role:
description:
- The C(role) argument configures the role for the username in the
- Configures the role for the username in the
device running configuration. The argument accepts a string value
defining the role name. This argument does not check if the role
has been configured on the device.
required: false
default: null
sshkey:
description:
- The C(sshkey) argument defines the SSH public key to configure
for the username. This argument accepts a valid SSH key value.
required: false
default: null
- Specifies the SSH public key to configure
for the given username. This argument accepts a valid SSH key value.
nopassword:
description:
- The C(nopassword) argument defines the username without assigning
- Defines the username without assigning
a password. This will allow the user to login to the system
without being authenticated by a password. This argument accepts
boolean values.
required: false
default: null
choices: ['true', 'false']
without being authenticated by a password.
type: bool
purge:
description:
- The C(purge) argument instructs the module to consider the
- Instructs the module to consider the
resource definition absolute. It will remove any previously
configured usernames on the device with the exception of the
`admin` user which cannot be deleted per EOS constraints.
required: false
type: bool
default: false
state:
description:
- The C(state) argument configures the state of the uername definition
- Configures the state of the username definition
as it relates to the device operational configuration. When set
to I(present), the username(s) should be configured in the device active
configuration and when set to I(absent) the username(s) should not be
in the device active configuration
required: false
default: present
choices: ['present', 'absent']
"""
@@ -121,7 +106,7 @@ EXAMPLES = """
eos_user:
purge: yes
- name: set multiple users to privilege level
- name: set multiple users to privilege level 15
users:
- username: netop
- username: netend
@@ -301,7 +286,7 @@ def main():
""" main entry point for module execution
"""
argument_spec = dict(
users=dict(type='list', no_log=True),
users=dict(type='list'),
username=dict(),
password=dict(no_log=True),