mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-08 01:14:03 -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,63 +1,56 @@
|
|||
#
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Created on December 12, 2016
|
||||
# @author: Gaurav Rastogi (grastogi@avinetworks.com)
|
||||
# Avi Version: 16.3.4
|
||||
#
|
||||
#
|
||||
# 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/>.
|
||||
#
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
# Avi common documentation fragment
|
||||
DOCUMENTATION = """
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
controller:
|
||||
description:
|
||||
- IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER).
|
||||
type: str
|
||||
default: ''
|
||||
username:
|
||||
description:
|
||||
- Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME).
|
||||
type: str
|
||||
default: ''
|
||||
password:
|
||||
description:
|
||||
- Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD).
|
||||
type: str
|
||||
default: ''
|
||||
tenant:
|
||||
description:
|
||||
- Name of tenant used for all Avi API calls and context of object.
|
||||
type: str
|
||||
default: admin
|
||||
tenant_uuid:
|
||||
description:
|
||||
- UUID of tenant used for all Avi API calls and context of object.
|
||||
type: str
|
||||
default: ''
|
||||
api_version:
|
||||
description:
|
||||
- Avi API version of to use for Avi API and objects.
|
||||
default: "16.4.4"
|
||||
type: str
|
||||
default: 16.4.4
|
||||
avi_credentials:
|
||||
description:
|
||||
- Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
||||
type: str
|
||||
version_added: "2.5"
|
||||
api_context:
|
||||
description:
|
||||
- Avi API context that includes current session ID and CSRF Token.
|
||||
- This allows user to perform single login and re-use the session.
|
||||
type: str
|
||||
version_added: "2.5"
|
||||
notes:
|
||||
- For more information on using Ansible to manage Avi Network devices see U(https://www.ansible.com/ansible-avi-networks).
|
||||
"""
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue