doc_fragments: Clean up parameter types (network) (#52176)

* module_utils: Clean up parameter types

This PR includes:
- Parameter types added
- Copyright format fixes
- Short license statement
- Description fixes (only for a few files, then I stopped :-))

* More network stuff

* Fix typo

* Fix PEP8

* Fix booleans

* Fix typo
pull/52320/head
Dag Wieers 6 years ago committed by John R Barker
parent 2f3960558d
commit 9c1033422b

@ -1,28 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2016, John Barker <jobarker@redhat.com>
# # Copyright: (c) 2016, John Barker <jobarker@redhat.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
notes:
- "Requires A10 Networks aXAPI 2.1"
options: options:
host: host:
description: description:
@ -49,12 +34,14 @@ options:
so care should be taken when specifying C(yes). so care should be taken when specifying C(yes).
type: bool type: bool
default: no default: no
version_added: 2.2 version_added: '2.2'
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be used - If C(no), SSL certificates will not be validated.
on personally controlled devices using self-signed certificates. - This should only be used on personally controlled devices using self-signed certificates.
type: bool type: bool
default: yes default: yes
version_added: 2.2 version_added: '2.2'
""" notes:
- Requires A10 Networks aXAPI 2.1.
'''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2017, James Mighion <@jmighion>
# # Copyright: (c) 2017, James Mighion <@jmighion>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -28,38 +15,41 @@ options:
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote device over the specified transport.
device over the specified transport. The value of host is used as - The value of host is used as the destination address for the transport.
the destination address for the transport. type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote. - Specifies the port to use when building the connection to the remote device.
device. type: int
default: 22 default: 22
username: username:
description: description:
- Configures the username to use to authenticate the connection to - Configures the username to use to authenticate the connection to the remote device.
the remote device. This value is used to authenticate - This value is used to authenticate the SSH session.
the SSH session. If the value is not specified in the task, the - If the value is not specified in the task, the value of environment variable
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to the remote device.
the remote device. This value is used to authenticate - This value is used to authenticate the SSH session.
the SSH session. If the value is not specified in the task, the - If the value is not specified in the task, the value of environment variable
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands.
exceeded before the operation is completed, the module will error. - If the timeout is exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
- Specifies the SSH key to use to authenticate the connection to - Specifies the SSH key to use to authenticate the connection to the remote device.
the remote device. This value is the path to the - This value is the path to the key used to authenticate the SSH session.
key used to authenticate the SSH session. If the value is not specified - If the value is not specified in the task, the value of environment variable
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
will be used instead. type: path
""" '''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2017, James Mighion <@jmighion>
# # Copyright: (c) 2017, James Mighion <@jmighion>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -31,11 +18,13 @@ options:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote. - Specifies the port to use when building the connection to the remote.
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -43,17 +32,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -62,4 +54,5 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
""" type: path
'''

@ -1,27 +1,14 @@
# # -*- coding: utf-8 -*-
# (c) 2016, Peter Sprygada <psprygada@ansible.com>
# (c) 2016, Patrick Ogenstad <@ogenstad> # Copyright: (c) 2016, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2016, Patrick Ogenstad <@ogenstad>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
authorize: authorize:
description: description:
@ -35,11 +22,12 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
context: context:
description: description:
- Specifies which context to target if you are running in the ASA in - Specifies which context to target if you are running in the ASA in
multiple context mode. Defaults to the current context you login to. multiple context mode. Defaults to the current context you login to.
type: str
provider: provider:
description: description:
- B(Deprecated) - B(Deprecated)
@ -53,10 +41,12 @@ options:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: host
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -64,12 +54,14 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
ssh_keyfile: ssh_keyfile:
description: description:
- Specifies the SSH key to use to authenticate the connection to - Specifies the SSH key to use to authenticate the connection to
@ -77,6 +69,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
authorize: authorize:
description: description:
- Instructs the module to enter privileged mode on the remote device - Instructs the module to enter privileged mode on the remote device
@ -85,19 +78,21 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies idle timeout in seconds for the connection, in seconds. Useful - Specifies idle timeout in seconds for the connection, in seconds. Useful
if the console freezes before continuing. For example when saving if the console freezes before continuing. For example when saving
configurations. configurations.
type: int
default: 10 default: 10
notes: notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
""" '''

@ -1,63 +1,56 @@
# # -*- coding: utf-8 -*-
# Created on December 12, 2016 # Created on December 12, 2016
# @author: Gaurav Rastogi (grastogi@avinetworks.com) # @author: Gaurav Rastogi (grastogi@avinetworks.com)
# Avi Version: 16.3.4 # Avi Version: 16.3.4
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Avi common documentation fragment # Avi common documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
controller: controller:
description: description:
- IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER).
type: str
default: '' default: ''
username: username:
description: description:
- Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME).
type: str
default: '' default: ''
password: password:
description: description:
- Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD).
type: str
default: '' default: ''
tenant: tenant:
description: description:
- Name of tenant used for all Avi API calls and context of object. - Name of tenant used for all Avi API calls and context of object.
type: str
default: admin default: admin
tenant_uuid: tenant_uuid:
description: description:
- UUID of tenant used for all Avi API calls and context of object. - UUID of tenant used for all Avi API calls and context of object.
type: str
default: '' default: ''
api_version: api_version:
description: description:
- Avi API version of to use for Avi API and objects. - Avi API version of to use for Avi API and objects.
default: "16.4.4" type: str
default: 16.4.4
avi_credentials: avi_credentials:
description: description:
- Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
type: str
version_added: "2.5" version_added: "2.5"
api_context: api_context:
description: description:
- Avi API context that includes current session ID and CSRF Token. - Avi API context that includes current session ID and CSRF Token.
- This allows user to perform single login and re-use the session. - This allows user to perform single login and re-use the session.
type: str
version_added: "2.5" version_added: "2.5"
notes: notes:
- For more information on using Ansible to manage Avi Network devices see U(https://www.ansible.com/ansible-avi-networks). - For more information on using Ansible to manage Avi Network devices see U(https://www.ansible.com/ansible-avi-networks).
""" '''

@ -1,25 +1,12 @@
# Copyright (C) 2017 Lenovo, Inc. # -*- coding: utf-8 -*-
#
# This file is part of Ansible # Copyright: (c) 2017, Lenovo, Inc.
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard CNOS documentation fragment # Standard CNOS documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
outputfile: outputfile:
description: description:
@ -28,8 +15,9 @@ options:
template file and each response from the device are saved here. template file and each response from the device are saved here.
Usually the location is the results folder, but you can Usually the location is the results folder, but you can
choose another location based on your write permission. choose another location based on your write permission.
type: path
required: true required: true
version_added: 2.3 version_added: '2.3'
host: host:
description: description:
- This is the variable used to search the hosts file at - This is the variable used to search the hosts file at
@ -38,8 +26,9 @@ options:
keyword {{ inventory_hostname }} is specified in the playbook as keyword {{ inventory_hostname }} is specified in the playbook as
an abstraction of the group of network elements that need to be an abstraction of the group of network elements that need to be
configured. configured.
type: str
required: true required: true
version_added: 2.3 version_added: '2.3'
username: username:
description: description:
- Configures the username used to authenticate the connection to - Configures the username used to authenticate the connection to
@ -48,8 +37,9 @@ options:
come from the inventory file, you can also specify it as a come from the inventory file, you can also specify it as a
variable. This parameter is optional. If it is not specified, no variable. This parameter is optional. If it is not specified, no
default value will be used. default value will be used.
type: str
required: true required: true
version_added: 2.3 version_added: '2.3'
password: password:
description: description:
- Configures the password used to authenticate the connection to - Configures the password used to authenticate the connection to
@ -58,8 +48,9 @@ options:
come from the inventory file, you can also specify it as a come from the inventory file, you can also specify it as a
variable. This parameter is optional. If it is not specified, no variable. This parameter is optional. If it is not specified, no
default value will be used. default value will be used.
type: str
required: true required: true
version_added: 2.3 version_added: '2.3'
enablePassword: enablePassword:
description: description:
- Configures the password used to enter Global Configuration - Configures the password used to enter Global Configuration
@ -68,16 +59,26 @@ options:
should come from the inventory file, you can also specify it as a should come from the inventory file, you can also specify it as a
variable. This parameter is optional. If it is not specified, variable. This parameter is optional. If it is not specified,
no default value will be used. no default value will be used.
version_added: 2.3 type: str
version_added: '2.3'
deviceType: deviceType:
description: description:
- This specifies the type of device where the method is executed. - This specifies the type of device where the method is executed.
The choices NE1072T,NE1032,NE1032T,NE10032,NE2572 are added The choices NE1072T,NE1032,NE1032T,NE10032,NE2572 are added
since version 2.4. The choice NE0152T is added since 2.8 since Ansible 2.4. The choice NE0152T is added since 2.8
required: Yes type: str
choices: [g8272_cnos,g8296_cnos,g8332_cnos,NE1072T,NE1032, required: true
NE1032T,NE10032,NE2572,NE0152T] choices:
version_added: 2.3 - g8272_cnos
- g8296_cnos
- g8332_cnos
- NE0152T
- NE1072T
- NE1032
- NE1032T
- NE10032
- NE2572
version_added: '2.3'
notes: notes:
- For more information on using Ansible to manage Lenovo Network devices see U(https://www.ansible.com/ansible-lenovo). - For more information on using Ansible to manage Lenovo Network devices see U(https://www.ansible.com/ansible-lenovo).
''' '''

@ -8,44 +8,51 @@
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
- User to authenticate the SSH session to the remote device. If the - User to authenticate the SSH session to the remote device. If the
value is not specified in the task, the value of environment variable value is not specified in the task, the value of environment variable
C(ANSIBLE_NET_USERNAME) will be used instead. C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Password to authenticate the SSH session to the remote device. If the - Password to authenticate the SSH session to the remote device. If the
value is not specified in the task, the value of environment variable value is not specified in the task, the value of environment variable
C(ANSIBLE_NET_PASSWORD) will be used instead. C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
ssh_keyfile: ssh_keyfile:
description: description:
- Path to an ssh key used to authenticate the SSH session to the remote - Path to an ssh key used to authenticate the SSH session to the remote
device. If the value is not specified in the task, the value of device. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: path
timeout: timeout:
description: description:
- Specifies idle timeout (in seconds) for the connection. Useful if the - Specifies idle timeout (in seconds) for the connection. Useful if the
console freezes before continuing. For example when saving console freezes before continuing. For example when saving
configurations. configurations.
type: int
default: 10 default: 10
notes: notes:
- For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking). - For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking).
""" '''

@ -8,11 +8,12 @@
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
@ -44,7 +45,7 @@ options:
- Path to an ssh key used to authenticate the SSH session to the remote - Path to an ssh key used to authenticate the SSH session to the remote
device. If the value is not specified in the task, the value of device. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: str type: path
timeout: timeout:
description: description:
- Specifies idle timeout (in seconds) for the connection. Useful if the - Specifies idle timeout (in seconds) for the connection. Useful if the
@ -54,4 +55,4 @@ options:
default: 10 default: 10
notes: notes:
- For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking). - For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking).
""" '''

@ -8,7 +8,7 @@
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -45,7 +45,7 @@ options:
- Path to an ssh key used to authenticate the SSH session to the remote - Path to an ssh key used to authenticate the SSH session to the remote
device. If the value is not specified in the task, the value of device. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: str type: path
timeout: timeout:
description: description:
- Specifies idle timeout (in seconds) for the connection. Useful if the - Specifies idle timeout (in seconds) for the connection. Useful if the
@ -55,4 +55,4 @@ options:
default: 10 default: 10
notes: notes:
- For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking). - For more information on using Ansible to manage Dell EMC Network devices see U(https://www.ansible.com/ansible-dell-networking).
""" '''

@ -1,20 +1,14 @@
# (C) 2017 Red Hat Inc. # -*- coding: utf-8 -*-
# Copyright (C) 2017 Lenovo.
# # Copyright: (c) 2017, Red Hat Inc.
# GNU General Public License v3.0+ # Copyright: (c) 2017, Lenovo.
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
authorize: authorize:
description: description:
@ -24,7 +18,7 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
@ -34,16 +28,19 @@ options:
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote device. - Specifies the port to use when building the connection to the remote device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -51,17 +48,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -70,6 +70,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
authorize: authorize:
description: description:
- Instructs the module to enter privileged mode on the remote device - Instructs the module to enter privileged mode on the remote device
@ -78,11 +79,12 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
''' '''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
authorize: authorize:
description: description:
@ -35,7 +22,7 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- B(Deprecated) - B(Deprecated)
@ -47,6 +34,7 @@ options:
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
provider: provider:
description: description:
- B(Deprecated) - B(Deprecated)
@ -55,12 +43,14 @@ options:
- For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html). - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
- HORIZONTALLINE - HORIZONTALLINE
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
@ -68,6 +58,7 @@ options:
device. This value applies to either I(cli) or I(eapi). The port device. This value applies to either I(cli) or I(eapi). The port
value will default to the appropriate transport common port if value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443). none is provided in the task. (cli=22, http=80, https=443).
type: int
default: 0 (use common port) default: 0 (use common port)
username: username:
description: description:
@ -76,17 +67,20 @@ options:
either the CLI login or the eAPI authentication depending on which either the CLI login or the eAPI authentication depending on which
transport is used. If the value is not specified in the task, the transport is used. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This is a common argument used for either I(cli) the remote device. This is a common argument used for either I(cli)
or I(eapi) transports. If the value is not specified in the task, the or I(eapi) transports. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -94,6 +88,7 @@ options:
the remote device. This argument is only used for I(cli) transports. the remote device. This argument is only used for I(cli) transports.
If the value is not specified in the task, the value of environment If the value is not specified in the task, the value of environment
variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: path
authorize: authorize:
description: description:
- Instructs the module to enter privileged mode on the remote device - Instructs the module to enter privileged mode on the remote device
@ -102,29 +97,29 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
transport: transport:
description: description:
- Configures the transport connection to use when connecting to the - Configures the transport connection to use when connecting to the
remote device. remote device.
required: true required: true
choices: type: str
- eapi choices: [ cli, eapi ]
- cli
default: cli default: cli
use_ssl: use_ssl:
description: description:
- Configures the I(transport) to use SSL if set to true only when the - Configures the I(transport) to use SSL if set to C(yes) only when the
C(transport=eapi). If the transport C(transport=eapi). If the transport
argument is not eapi, this value is ignored. argument is not eapi, this value is ignored.
type: bool type: bool
default: 'yes' default: yes
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be used - If C(no), SSL certificates will not be validated. This should only be used
@ -135,7 +130,7 @@ options:
description: description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
type: bool type: bool
default: 'yes' default: yes
version_added: "2.5" version_added: "2.5"
notes: notes:
@ -143,4 +138,4 @@ notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Arista EOS devices see the `Arista integration page <https://www.ansible.com/ansible-arista-networks>`_. - For more information on using Ansible to manage Arista EOS devices see the `Arista integration page <https://www.ansible.com/ansible-arista-networks>`_.
""" '''

@ -1,47 +1,38 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
#
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard F5 documentation fragment # Standard F5 documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
password: password:
description: description:
- The password for the user account used to connect to the BIG-IP. - The password for the user account used to connect to the BIG-IP.
- You may omit this option by setting the environment variable C(F5_PASSWORD). - You may omit this option by setting the environment variable C(F5_PASSWORD).
type: str
required: true required: true
aliases: ['pass', 'pwd'] aliases: [ pass, pwd ]
server: server:
description: description:
- The BIG-IP host. - The BIG-IP host.
- You may omit this option by setting the environment variable C(F5_SERVER). - You may omit this option by setting the environment variable C(F5_SERVER).
type: str
required: true required: true
server_port: server_port:
description: description:
- The BIG-IP server port. - The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT). - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
default: 443 default: 443
version_added: 2.2 version_added: '2.2'
user: user:
description: description:
- The username to connect to the BIG-IP with. This user must have - The username to connect to the BIG-IP with. This user must have
administrative privileges on the device. administrative privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER). - You may omit this option by setting the environment variable C(F5_USER).
type: str
required: true required: true
validate_certs: validate_certs:
description: description:
@ -49,62 +40,67 @@ options:
on personally controlled sites using self-signed certificates. on personally controlled sites using self-signed certificates.
- You may omit this option by setting the environment variable - You may omit this option by setting the environment variable
C(F5_VALIDATE_CERTS). C(F5_VALIDATE_CERTS).
default: yes
type: bool type: bool
version_added: 2.0 default: yes
version_added: '2.0'
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
default: null type: dict
version_added: 2.5 version_added: '2.5'
suboptions: suboptions:
password: password:
description: description:
- The password for the user account used to connect to the BIG-IP. - The password for the user account used to connect to the BIG-IP.
- You may omit this option by setting the environment variable C(F5_PASSWORD). - You may omit this option by setting the environment variable C(F5_PASSWORD).
type: str
required: true required: true
aliases: ['pass', 'pwd'] aliases: [ pass, pwd ]
server: server:
description: description:
- The BIG-IP host. - The BIG-IP host.
- You may omit this option by setting the environment variable C(F5_SERVER). - You may omit this option by setting the environment variable C(F5_SERVER).
type: str
required: true required: true
server_port: server_port:
description: description:
- The BIG-IP server port. - The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT). - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
default: 443 default: 443
user: user:
description: description:
- The username to connect to the BIG-IP with. This user must have - The username to connect to the BIG-IP with. This user must have
administrative privileges on the device. administrative privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER). - You may omit this option by setting the environment variable C(F5_USER).
type: str
required: true required: true
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates are not validated. Use this only - If C(no), SSL certificates are not validated. Use this only
on personally controlled sites using self-signed certificates. on personally controlled sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS). - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
default: yes
type: bool type: bool
default: yes
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
- Specifies the SSH keyfile to use to authenticate the connection to - Specifies the SSH keyfile to use to authenticate the connection to
the remote device. This argument is only used for I(cli) transports. the remote device. This argument is only used for I(cli) transports.
- You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE). - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
type: path
transport: transport:
description: description:
- Configures the transport connection to use when connecting to the - Configures the transport connection to use when connecting to the
remote device. remote device.
choices: type: str
- rest choices: [ cli, rest ]
- cli
default: rest default: rest
notes: notes:
- For more information on using Ansible to manage F5 Networks devices see U(https://www.ansible.com/integrations/networks/f5). - For more information on using Ansible to manage F5 Networks devices see U(https://www.ansible.com/integrations/networks/f5).

@ -1,67 +1,61 @@
# # -*- coding: utf-8 -*-
# (c) 2017, Benjamin Jolivot <bjolivot@gmail.com>
# # Copyright: (c) 2017, Benjamin Jolivot <bjolivot@gmail.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
file_mode: file_mode:
description: description:
- Don't connect to any device, only use I(config_file) as input and Output. - Don't connect to any device, only use I(config_file) as input and Output.
default: false
type: bool type: bool
default: no
version_added: "2.4" version_added: "2.4"
config_file: config_file:
description: description:
- Path to configuration file. Required when I(file_mode) is True. - Path to configuration file. Required when I(file_mode) is True.
type: path
version_added: "2.4" version_added: "2.4"
host: host:
description: description:
- Specifies the DNS hostname or IP address for connecting to the remote fortios device. Required when I(file_mode) is False. - Specifies the DNS hostname or IP address for connecting to the remote fortios device. Required when I(file_mode) is False.
type: str
username: username:
description: description:
- Configures the username used to authenticate to the remote device. Required when I(file_mode) is True. - Configures the username used to authenticate to the remote device. Required when I(file_mode) is True.
type: str
password: password:
description: description:
- Specifies the password used to authenticate to the remote device. Required when I(file_mode) is True. - Specifies the password used to authenticate to the remote device. Required when I(file_mode) is True.
type: str
timeout: timeout:
description: description:
- Timeout in seconds for connecting to the remote device. - Timeout in seconds for connecting to the remote device.
type: int
default: 60 default: 60
vdom: vdom:
description: description:
- Specifies on which vdom to apply configuration - Specifies on which vdom to apply configuration
type: str
backup: backup:
description: description:
- This argument will cause the module to create a backup of - This argument will cause the module to create a backup of
the current C(running-config) from the remote device before any the current C(running-config) from the remote device before any
changes are made. The backup file is written to the i(backup) changes are made. The backup file is written to the i(backup)
folder. folder.
default: no
type: bool type: bool
default: no
backup_path: backup_path:
description: description:
- Specifies where to store backup files. Required if I(backup=yes). - Specifies where to store backup files. Required if I(backup=yes).
type: path
backup_filename: backup_filename:
description: description:
- Specifies the backup filename. If omitted filename will be - Specifies the backup filename. If omitted filename will be
formatted like HOST_config.YYYY-MM-DD@HH:MM:SS formatted like HOST_config.YYYY-MM-DD@HH:MM:SS
""" type: str
'''

@ -1,23 +1,11 @@
# Copyright (c) 2018, Ingate Systems AB # -*- coding: utf-8 -*-
#
# This file is part of Ansible # Copyright: (c) 2018, Ingate Systems AB
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
client: client:
description: description:
@ -26,39 +14,43 @@ options:
version: version:
description: description:
- REST API version. - REST API version.
choices: [v1] type: str
choices: [ v1 ]
default: v1 default: v1
required: true
scheme: scheme:
description: description:
- Which HTTP protocol to use. - Which HTTP protocol to use.
choices: [http, https] type: str
required: true required: true
choices: [ http, https ]
address: address:
description: description:
- The hostname or IP address to the unit. - The hostname or IP address to the unit.
type: str
required: true required: true
username: username:
description: description:
- The username of the REST API user. - The username of the REST API user.
type: str
required: true required: true
password: password:
description: description:
- The password for the REST API user. - The password for the REST API user.
type: str
required: true required: true
port: port:
description: description:
- Which HTTP(S) port to connect to. - Which HTTP(S) port to connect to.
required: false type: int
timeout: timeout:
description: description:
- The timeout (in seconds) for REST API requests. - The timeout (in seconds) for REST API requests.
required: false type: int
verify_ssl: verify_ssl:
description: description:
- Verify the unit's HTTPS certificate. - Verify the unit's HTTPS certificate.
default: true type: bool
required: false default: yes
notes: notes:
- This module requires that the Ingate Python SDK is installed on the - This module requires that the Ingate Python SDK is installed on the
host. To install the SDK use the pip command from your shell host. To install the SDK use the pip command from your shell

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
authorize: authorize:
description: description:
@ -34,7 +21,7 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- B(Deprecated) - B(Deprecated)
@ -45,6 +32,7 @@ options:
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
provider: provider:
description: description:
- B(Deprecated) - B(Deprecated)
@ -52,16 +40,19 @@ options:
- For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html). - For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html).
- HORIZONTALLINE - HORIZONTALLINE
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote device. - Specifies the port to use when building the connection to the remote device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -69,17 +60,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -88,6 +82,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
authorize: authorize:
description: description:
- Instructs the module to enter privileged mode on the remote device - Instructs the module to enter privileged mode on the remote device
@ -96,14 +91,15 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
notes: notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
""" '''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -29,16 +16,19 @@ options:
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
- HORIZONTALLINE - HORIZONTALLINE
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote device. - Specifies the port to use when building the connection to the remote device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -46,17 +36,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -65,10 +58,11 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
requirements: requirements:
- "ncclient >= 0.5.3 when using netconf" - ncclient >= 0.5.3 when using netconf
- "lxml >= 4.1.1 when using netconf" - lxml >= 4.1.1 when using netconf
notes: notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
""" '''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2017, Paul Baker <@paulquack>
# # Copyright: (c) 2017, Paul Baker <@paulquack>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
authorize: authorize:
description: description:
@ -34,7 +21,7 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
provider: provider:
description: description:
- B(Deprecated) - B(Deprecated)
@ -42,16 +29,19 @@ options:
- For more information please see the L(IronWare Platform Options guide, ../network/user_guide/platform_ironware.html). - For more information please see the L(IronWare Platform Options guide, ../network/user_guide/platform_ironware.html).
- HORIZONTALLINE - HORIZONTALLINE
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -59,12 +49,14 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
ssh_keyfile: ssh_keyfile:
description: description:
- Specifies the SSH key to use to authenticate the connection to - Specifies the SSH key to use to authenticate the connection to
@ -72,6 +64,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
authorize: authorize:
description: description:
- Instructs the module to enter privileged mode on the remote device - Instructs the module to enter privileged mode on the remote device
@ -80,19 +73,21 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies idle timeout in seconds for the connection, in seconds. Useful - Specifies idle timeout in seconds for the connection, in seconds. Useful
if the console freezes before continuing. For example when saving if the console freezes before continuing. For example when saving
configurations. configurations.
type: int
default: 10 default: 10
notes: notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
""" '''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -29,12 +16,14 @@ options:
- For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html). - For more information please see the L(Junos OS Platform Options guide, ../network/user_guide/platform_junos.html).
- HORIZONTALLINE - HORIZONTALLINE
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
@ -42,6 +31,7 @@ options:
device. The port value will default to the well known SSH port device. The port value will default to the well known SSH port
of 22 (for C(transport=cli)) or port 830 (for C(transport=netconf)) of 22 (for C(transport=cli)) or port 830 (for C(transport=netconf))
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -49,17 +39,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -68,8 +61,9 @@ options:
used to authenticate the SSH session. If the value is not specified in used to authenticate the SSH session. If the value is not specified in
the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
notes: notes:
- For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide <junos_platform_options>` - For information on using CLI and netconf see the :ref:`Junos OS Platform Options guide <junos_platform_options>`
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Juniper network devices see U(https://www.ansible.com/ansible-juniper). - For more information on using Ansible to manage Juniper network devices see U(https://www.ansible.com/ansible-juniper).
""" '''

@ -30,12 +30,12 @@ options:
- If C(no), it will use HTTP. Otherwise it will use HTTPS. - If C(no), it will use HTTP. Otherwise it will use HTTPS.
- Only useful for internal Meraki developers. - Only useful for internal Meraki developers.
type: bool type: bool
default: 'yes' default: yes
output_level: output_level:
description: description:
- Set amount of debug output during module execution - Set amount of debug output during module execution
type: str type: str
choices: [ normal, debug ] choices: [ debug, normal ]
default: normal default: normal
timeout: timeout:
description: description:
@ -46,7 +46,7 @@ options:
description: description:
- Whether to validate HTTP certificates. - Whether to validate HTTP certificates.
type: bool type: bool
default: 'yes' default: yes
org_name: org_name:
description: description:
- Name of organization. - Name of organization.

@ -6,7 +6,7 @@
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
host: host:
description: description:

@ -1,31 +1,19 @@
# # -*- coding: utf-8 -*-
#
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
@ -39,12 +27,14 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
@ -62,16 +52,16 @@ options:
type: path type: path
hostkey_verify: hostkey_verify:
description: description:
- If set to true, the ssh host key of the device must match a ssh key present on - If set to C(yes), the ssh host key of the device must match a ssh key present on
the host if false, the ssh host key of the device is not checked. the host if set to C(no), the ssh host key of the device is not checked.
type: bool type: bool
default: True default: yes
look_for_keys: look_for_keys:
description: description:
- Enables looking in the usual locations for the ssh keys (e.g. :file:`~/.ssh/id_*`) - Enables looking in the usual locations for the ssh keys (e.g. :file:`~/.ssh/id_*`)
type: bool type: bool
default: True default: yes
notes: notes:
- For information on using netconf see the :ref:`Platform Options guide using Netconf<netconf_enabled_platform_options>` - For information on using netconf see the :ref:`Platform Options guide using Netconf<netconf_enabled_platform_options>`
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
""" '''

@ -1,55 +1,65 @@
# -*- coding: utf-8 -*-
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
nsip: nsip:
description: description:
- The ip address of the netscaler appliance where the nitro API calls will be made. - The ip address of the netscaler appliance where the nitro API calls will be made.
- "The port can be specified with the colon (:). E.g. 192.168.1.1:555." - "The port can be specified with the colon (:). E.g. 192.168.1.1:555."
type: str
required: True required: True
nitro_user: nitro_user:
description: description:
- The username with which to authenticate to the netscaler node. - The username with which to authenticate to the netscaler node.
type: str
required: True required: True
nitro_pass: nitro_pass:
description: description:
- The password with which to authenticate to the netscaler node. - The password with which to authenticate to the netscaler node.
type: str
required: True required: True
nitro_protocol: nitro_protocol:
choices: [ 'http', 'https' ]
default: http
description: description:
- Which protocol to use when accessing the nitro API objects. - Which protocol to use when accessing the nitro API objects.
type: str
choices: [ http, https ]
default: http
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
type: bool type: bool
default: yes
nitro_timeout: nitro_timeout:
description: description:
- Time in seconds until a timeout error is thrown when establishing a new session with Netscaler - Time in seconds until a timeout error is thrown when establishing a new session with Netscaler
type: int
default: 310 default: 310
state: state:
choices: ['present', 'absent']
default: 'present'
description: description:
- The state of the resource being configured by the module on the netscaler node. - The state of the resource being configured by the module on the netscaler node.
- When present the resource will be created if needed and configured according to the module's parameters. - When present the resource will be created if needed and configured according to the module's parameters.
- When absent the resource will be deleted from the netscaler node. - When absent the resource will be deleted from the netscaler node.
type: str
choices: [ absent, present ]
default: present
save_config: save_config:
description: description:
- If true the module will save the configuration on the netscaler node if it makes any changes. - If C(yes) the module will save the configuration on the netscaler node if it makes any changes.
- The module will not save the configuration on the netscaler node if it made no changes. - The module will not save the configuration on the netscaler node if it made no changes.
type: bool type: bool
default: true default: yes
notes: notes:
- For more information on using Ansible to manage Citrix NetScaler Network devices see U(https://www.ansible.com/ansible-netscaler). - For more information on using Ansible to manage Citrix NetScaler Network devices see U(https://www.ansible.com/ansible-netscaler).
''' '''

@ -1,25 +1,13 @@
# Copyright (c) 2019 Ansible, Inc # -*- coding: utf-8 -*-
#
# This file is part of Ansible # Copyright: (c) 2019 Ansible, Inc
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: {} options: {}
notes: notes:
- This module is supported on C(ansible_network_os) network platforms. See - This module is supported on C(ansible_network_os) network platforms. See

@ -1,30 +1,18 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
@ -32,6 +20,7 @@ options:
instance of NIOS WAPI over REST instance of NIOS WAPI over REST
- Value can also be specified using C(INFOBLOX_HOST) environment - Value can also be specified using C(INFOBLOX_HOST) environment
variable. variable.
type: str
required: true required: true
username: username:
description: description:
@ -39,24 +28,27 @@ options:
the remote instance of NIOS. the remote instance of NIOS.
- Value can also be specified using C(INFOBLOX_USERNAME) environment - Value can also be specified using C(INFOBLOX_USERNAME) environment
variable. variable.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote instance of NIOS. the remote instance of NIOS.
- Value can also be specified using C(INFOBLOX_PASSWORD) environment - Value can also be specified using C(INFOBLOX_PASSWORD) environment
variable. variable.
type: str
ssl_verify: ssl_verify:
description: description:
- Boolean value to enable or disable verifying SSL certificates - Boolean value to enable or disable verifying SSL certificates
- Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment
variable. variable.
type: bool type: bool
default: 'no' default: no
http_request_timeout: http_request_timeout:
description: description:
- The amount of time before to wait before receiving a response - The amount of time before to wait before receiving a response
- Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
variable. variable.
type: int
default: 10 default: 10
max_retries: max_retries:
description: description:
@ -64,6 +56,7 @@ options:
is declared usable is declared usable
- Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment
variable. variable.
type: int
default: 3 default: 3
wapi_version: wapi_version:
description: description:
@ -71,7 +64,8 @@ options:
- Value can also be specified using C(INFOBLOX_WAP_VERSION) environment - Value can also be specified using C(INFOBLOX_WAP_VERSION) environment
variable. variable.
- Until ansible 2.8 the default WAPI was 1.4 - Until ansible 2.8 the default WAPI was 1.4
default: 2.1 type: str
default: '2.1'
max_results: max_results:
description: description:
- Specifies the maximum number of objects to be returned, - Specifies the maximum number of objects to be returned,
@ -79,9 +73,10 @@ options:
number of returned objects would exceed the setting. number of returned objects would exceed the setting.
- Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment - Value can also be specified using C(INFOBLOX_MAX_RESULTS) environment
variable. variable.
type: int
default: 1000 default: 1000
notes: notes:
- "This module must be run locally, which can be achieved by specifying C(connection: local)." - "This module must be run locally, which can be achieved by specifying C(connection: local)."
- Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible. - Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.
""" '''

@ -1,39 +1,28 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Copyright (c) 2017 Cisco and/or its affiliates. # Copyright: (c) 2017, Cisco and/or its affiliates.
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
class ModuleDocFragment(object): class ModuleDocFragment(object):
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
url: url:
description: NSO JSON-RPC URL, http://localhost:8080/jsonrpc description: NSO JSON-RPC URL, http://localhost:8080/jsonrpc
type: str
required: true required: true
username: username:
description: NSO username description: NSO username
type: str
required: true required: true
password: password:
description: NSO password description: NSO password
type: str
required: true required: true
timeout: timeout:
description: JSON-RPC request timeout in seconds description: JSON-RPC request timeout in seconds
type: int
default: 300 default: 300
version_added: "2.6" version_added: "2.6"
''' '''

@ -7,7 +7,7 @@
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -93,7 +93,7 @@ options:
default: cli default: cli
use_ssl: use_ssl:
description: description:
- Configures the I(transport) to use SSL if set to true only when the - Configures the I(transport) to use SSL if set to C(yes) only when the
C(transport=nxapi), otherwise this value is ignored. C(transport=nxapi), otherwise this value is ignored.
type: bool type: bool
default: no default: no
@ -115,4 +115,4 @@ notes:
- For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>` - For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_. - For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
""" '''

@ -1,38 +1,29 @@
# # -*- coding: utf-8 -*-
# This file is part of Ansible
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote device. - Specifies the port to use when building the connection to the remote device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -40,17 +31,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -59,6 +53,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
authorize: authorize:
description: description:
- Instructs the module to enter privileged mode on the remote device - Instructs the module to enter privileged mode on the remote device
@ -67,11 +62,12 @@ options:
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
C(ANSIBLE_NET_AUTHORIZE) will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool type: bool
default: 'no' default: no
auth_pass: auth_pass:
description: description:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
""" type: str
'''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
host: host:
description: description:
@ -28,7 +15,7 @@ options:
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. Note this argument the destination address for the transport. Note this argument
does not affect the SSH argument. does not affect the SSH argument.
required: true type: str
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote
@ -36,6 +23,7 @@ options:
value will default to the appropriate transport common port if value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443). Note none is provided in the task. (cli=22, http=80, https=443). Note
this argument does not affect the SSH transport. this argument does not affect the SSH transport.
type: int
default: 0 (use common port) default: 0 (use common port)
username: username:
description: description:
@ -45,6 +33,7 @@ options:
transport is used. Note this argument does not affect the SSH transport is used. Note this argument does not affect the SSH
transport. If the value is not specified in the task, the value of transport. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_USERNAME) will be used instead. environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
@ -52,11 +41,13 @@ options:
or I(rest) transports. Note this argument does not affect the SSH or I(rest) transports. Note this argument does not affect the SSH
transport. If the value is not specified in the task, the value of transport. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -64,25 +55,27 @@ options:
the remote device. This argument is only used for the I(cli) the remote device. This argument is only used for the I(cli)
transports. If the value is not specified in the task, the value of transports. If the value is not specified in the task, the value of
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
type: path
transport: transport:
description: description:
- Configures the transport connection to use when connecting to the - Configures the transport connection to use when connecting to the
remote device. The transport argument supports connectivity to the remote device. The transport argument supports connectivity to the
device over ssh, cli or REST. device over ssh, cli or REST.
required: true required: true
type: str
choices: [ cli, rest, ssh ]
default: ssh default: ssh
choices: ['ssh', 'cli', 'rest']
use_ssl: use_ssl:
description: description:
- Configures the I(transport) to use SSL if set to true only when the - Configures the I(transport) to use SSL if set to C(yes) only when the
I(transport) argument is configured as rest. If the transport I(transport) argument is configured as rest. If the transport
argument is not I(rest), this value is ignored. argument is not I(rest), this value is ignored.
type: bool type: bool
default: 'yes' default: yes
provider: provider:
description: description:
- Convenience method that allows all I(openswitch) arguments to be passed as - Convenience method that allows all I(openswitch) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
type: dict
""" '''

@ -2,24 +2,26 @@
# Copyright: (c) 2016, techbizdev <techbizdev@paloaltonetworks.com> # Copyright: (c) 2016, techbizdev <techbizdev@paloaltonetworks.com>
# Copyright: (c) 2018, Kevin Breit (@kbreit) # Copyright: (c) 2018, Kevin Breit (@kbreit)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = ''' DOCUMENTATION = r'''
options: options:
ip_address: ip_address:
description: description:
- IP address (or hostname) of PAN-OS device. - IP address (or hostname) of PAN-OS device.
type: str
required: true required: true
password: password:
description: description:
- Password for authentication. - Password for authentication.
type: str
required: true required: true
username: username:
description: description:
- Username for authentication. - Username for authentication.
default: "admin" type: str
default: admin
''' '''

@ -1,41 +1,31 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -43,17 +33,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -62,6 +55,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
notes: notes:
- For more information on using Ansible to manage Nokia SR OS Network devices see U(https://www.ansible.com/ansible-nokia). - For more information on using Ansible to manage Nokia SR OS Network devices see U(https://www.ansible.com/ansible-nokia).
""" '''

@ -1,26 +1,13 @@
# # -*- coding: utf-8 -*-
# (c) 2015, Peter Sprygada <psprygada@ansible.com>
# # Copyright: (c) 2015, Peter Sprygada <psprygada@ansible.com>
# This file is part of Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object): class ModuleDocFragment(object):
# Standard files documentation fragment # Standard files documentation fragment
DOCUMENTATION = """ DOCUMENTATION = r'''
options: options:
provider: provider:
description: description:
@ -29,17 +16,20 @@ options:
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
- HORIZONTALLINE - HORIZONTALLINE
- A dict object containing connection details. - A dict object containing connection details.
type: dict
suboptions: suboptions:
host: host:
description: description:
- Specifies the DNS host name or address for connecting to the remote - Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as device over the specified transport. The value of host is used as
the destination address for the transport. the destination address for the transport.
type: str
required: true required: true
port: port:
description: description:
- Specifies the port to use when building the connection to the remote - Specifies the port to use when building the connection to the remote
device. device.
type: int
default: 22 default: 22
username: username:
description: description:
@ -47,17 +37,20 @@ options:
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the remote device. This value is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
timeout: timeout:
description: description:
- Specifies the timeout in seconds for communicating with the network device - Specifies the timeout in seconds for communicating with the network device
for either connecting or sending commands. If the timeout is for either connecting or sending commands. If the timeout is
exceeded before the operation is completed, the module will error. exceeded before the operation is completed, the module will error.
type: int
default: 10 default: 10
ssh_keyfile: ssh_keyfile:
description: description:
@ -66,6 +59,7 @@ options:
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
type: path
notes: notes:
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>` - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
""" '''

Loading…
Cancel
Save