mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-05 07:54:00 -07:00
doc_fragments: Clean up parameter types (storage) (#52179)
* module_utils: Clean up parameter types (storage) This PR includes: - Parameter types added - Copyright format fixes - Short license statement - Description fixes (only for a few files, then I stopped :-)) * Fix quotes * Fix rST issue
This commit is contained in:
parent
6a82827ddd
commit
fbca8a4615
5 changed files with 66 additions and 94 deletions
|
@ -1,26 +1,13 @@
|
|||
#
|
||||
# (c) 2017, Simon Dodsley <simon@purestorage.com>
|
||||
#
|
||||
# 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/>.
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2017, Simon Dodsley <simon@purestorage.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard Pure Storage documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
- See separate platform section for more details
|
||||
requirements:
|
||||
|
@ -30,39 +17,43 @@ notes:
|
|||
'''
|
||||
|
||||
# Documentation fragment for FlashBlade
|
||||
FB = '''
|
||||
FB = r'''
|
||||
options:
|
||||
fb_url:
|
||||
description:
|
||||
- FlashBlade management IP address or Hostname.
|
||||
type: str
|
||||
api_token:
|
||||
description:
|
||||
- FlashBlade API token for admin privileged user.
|
||||
type: str
|
||||
notes:
|
||||
- This module requires the ``purity_fb`` Python library
|
||||
- This module requires the C(purity_fb) Python library
|
||||
- You must set C(PUREFB_URL) and C(PUREFB_API) environment variables
|
||||
if I(fb_url) and I(api_token) arguments are not passed to the module directly
|
||||
requirements:
|
||||
- "python >= 2.7"
|
||||
- "purity_fb >= 1.1"
|
||||
- python >= 2.7
|
||||
- purity_fb >= 1.1
|
||||
'''
|
||||
|
||||
# Documentation fragment for FlashArray
|
||||
FA = '''
|
||||
FA = r'''
|
||||
options:
|
||||
fa_url:
|
||||
description:
|
||||
- FlashArray management IPv4 address or Hostname.
|
||||
type: str
|
||||
required: true
|
||||
api_token:
|
||||
description:
|
||||
- FlashArray API token for admin privileged user.
|
||||
type: str
|
||||
required: true
|
||||
notes:
|
||||
- This module requires the ``purestorage`` Python library
|
||||
- This module requires the C(purestorage) Python library
|
||||
- You must set C(PUREFA_URL) and C(PUREFA_API) environment variables
|
||||
if I(fa_url) and I(api_token) arguments are not passed to the module directly
|
||||
requirements:
|
||||
- "python >= 2.7"
|
||||
- python >= 2.7
|
||||
- purestorage
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue