mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 12:21:26 -07:00
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
This commit is contained in:
parent
2f3960558d
commit
9c1033422b
31 changed files with 411 additions and 535 deletions
|
@ -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):
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
|
||||
options:
|
||||
nsip:
|
||||
description:
|
||||
- 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."
|
||||
type: str
|
||||
required: True
|
||||
|
||||
nitro_user:
|
||||
description:
|
||||
- The username with which to authenticate to the netscaler node.
|
||||
type: str
|
||||
required: True
|
||||
|
||||
nitro_pass:
|
||||
description:
|
||||
- The password with which to authenticate to the netscaler node.
|
||||
type: str
|
||||
required: True
|
||||
|
||||
nitro_protocol:
|
||||
choices: [ 'http', 'https' ]
|
||||
default: http
|
||||
description:
|
||||
- Which protocol to use when accessing the nitro API objects.
|
||||
type: str
|
||||
choices: [ http, https ]
|
||||
default: http
|
||||
|
||||
validate_certs:
|
||||
description:
|
||||
- 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
|
||||
default: yes
|
||||
|
||||
nitro_timeout:
|
||||
description:
|
||||
- Time in seconds until a timeout error is thrown when establishing a new session with Netscaler
|
||||
type: int
|
||||
default: 310
|
||||
|
||||
state:
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
description:
|
||||
- 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 absent the resource will be deleted from the netscaler node.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
|
||||
save_config:
|
||||
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.
|
||||
type: bool
|
||||
default: true
|
||||
default: yes
|
||||
notes:
|
||||
- For more information on using Ansible to manage Citrix NetScaler Network devices see U(https://www.ansible.com/ansible-netscaler).
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue