archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

NetApp Bulk Doc changes (#45856) (#45866)

Browse Source 
* Doc changes
* fix ansibot issue & spacing
(cherry picked from commit e3ec9e5345)
pull/45999/head
John R Barker 6 years ago committed by Alicia Cozine
parent 2474a4c9bd
commit 3d88063c40
39 changed files with 79 additions and 79 deletions
Show Stats Download Patch File Download Diff File

2
lib/ansible/modules/storage/netapp/na_elementsw_drive.py
Unescape Escape View File

@ -19,7 +19,7 @@ DOCUMENTATION = '''
module: na_elementsw_drive
short_description: NetApp Element Software ManageNetApp Element Software Node Drives
short_description: NetApp Element Software Manage Node Drives
extends_documentation_fragment:
- netapp.solidfire
version_added: '2.7'

2
lib/ansible/modules/storage/netapp/na_ontap_aggregate.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_aggregate
short_description: Manage NetApp ONTAP aggregates.
short_description: NetApp ONTAP manage aggregates.
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_autosupport.py
Unescape Escape View File

@ -50,7 +50,7 @@ options:
description:
- Specifies whether AutoSupport notification to technical support is enabled.
type: bool
short_description: "Manage NetApp Autosupport"
short_description: "NetApp ONTAP manage Autosupport"
version_added: "2.7"
"""

2
lib/ansible/modules/storage/netapp/na_ontap_broadcast_domain.py
Unescape Escape View File

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_broadcast_domain
short_description: Manage NetApp ONTAP broadcast domains.
short_description: NetApp ONTAP manage broadcast domains..
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_broadcast_domain_ports.py
Unescape Escape View File

@ -12,7 +12,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_broadcast_domain_ports
short_description: Manage NetApp ONTAP broadcast domain ports
short_description: NetApp ONTAP manage broadcast domain ports
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_cg_snapshot.py
Unescape Escape View File

@ -11,7 +11,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
'supported_by': 'community'}
DOCUMENTATION = '''
short_description: Create consistency group snapshot
short_description: NetApp ONTAP manage consistency group snapshot
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Create consistency group snapshot for ONTAP volumes.

2
lib/ansible/modules/storage/netapp/na_ontap_cifs.py
Unescape Escape View File

@ -40,7 +40,7 @@ options:
- "Whether the specified CIFS share should exist or not."
required: false
default: present
short_description: "Manage NetApp cifs-share"
short_description: "NetApp ONTAP manage cifs-share"
version_added: "2.6"
'''

2
lib/ansible/modules/storage/netapp/na_ontap_cifs_acl.py
Unescape Escape View File

@ -40,7 +40,7 @@ options:
description:
- "The user or group name for which the permissions are listed."
required: true
short_description: "Manage NetApp cifs-share-access-control"
short_description: "NetApp ONTAP manage cifs-share-access-control"
version_added: "2.6"
'''

4
lib/ansible/modules/storage/netapp/na_ontap_cifs_server.py
Unescape Escape View File

@ -17,14 +17,14 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: na_ontap_cifs_server
short_description: cifs server configuration
short_description: NetApp ONTAP CIFS server configuration
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Creating / deleting and modifying the CIF server .
- Creating / deleting and modifying the CIFS server.
options:

2
lib/ansible/modules/storage/netapp/na_ontap_cluster.py
Unescape Escape View File

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_cluster
short_description: Create/Join ONTAP cluster. Apply license to cluster
short_description: NetApp ONTAP cluster - create, join, add license
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_cluster_ha.py
Unescape Escape View File

@ -24,7 +24,7 @@ options:
description:
- "Whether HA on cluster should be enabled or disabled."
default: present
short_description: "Manage HA status for cluster"
short_description: NetApp ONTAP Manage HA status for cluster
version_added: "2.6"
'''

2
lib/ansible/modules/storage/netapp/na_ontap_cluster_peer.py
Unescape Escape View File

@ -52,7 +52,7 @@ options:
description:
- Destination password.
- Optional if this is same as source password.
short_description: "NetApp ONTAP Manage Cluster peering"
short_description: NetApp ONTAP Manage Cluster peering
version_added: "2.7"
'''

2
lib/ansible/modules/storage/netapp/na_ontap_export_policy.py
Unescape Escape View File

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_export_policy
short_description: Manage NetApp ONTAP export-policy
short_description: NetApp ONTAP manage export-policy
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_export_policy_rule.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_export_policy_rule
short_description: Manage ONTAP Export rules
short_description: NetApp ONTAP manage export policy rules
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_igroup.py
Unescape Escape View File

@ -17,7 +17,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
module: na_ontap_igroup
short_description: ONTAP iSCSI igroup configuration
short_description: NetApp ONTAP iSCSI igroup configuration
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_interface.py
Unescape Escape View File

@ -18,7 +18,7 @@ DOCUMENTATION = '''
---
module: na_ontap_interface
short_description: ONTAP LIF configuration
short_description: NetApp ONTAP LIF configuration
extends_documentation_fragment:
- netapp.na_ontap

4
lib/ansible/modules/storage/netapp/na_ontap_iscsi.py
Unescape Escape View File

@ -17,14 +17,14 @@ DOCUMENTATION = '''
module: na_ontap_iscsi
short_description: Manage NetApp ONTAP iscsi service
short_description: NetApp ONTAP manage iSCSI service
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- create, delete, start, stop iscsi service on svm.
- create, delete, start, stop iSCSI service on SVM.
options:

2
lib/ansible/modules/storage/netapp/na_ontap_job_schedule.py
Unescape Escape View File

@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_job_schedule
short_description: Manage NetApp ONTAP Job Schedule
short_description: NetApp ONTAP Job Schedule
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_license.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_license
short_description: Manage NetApp ONTAP protocol and feature licenses
short_description: NetApp ONTAP protocol and feature licenses
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

14
lib/ansible/modules/storage/netapp/na_ontap_lun.py
Unescape Escape View File

@ -16,36 +16,36 @@ DOCUMENTATION = '''
module: na_ontap_lun
short_description: Manage NetApp ONTAP luns
short_description: NetApp ONTAP manage LUNs
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Create, destroy, resize luns on NetApp ONTAP.
- Create, destroy, resize LUNs on NetApp ONTAP.
options:
state:
description:
- Whether the specified lun should exist or not.
- Whether the specified LUN should exist or not.
choices: ['present', 'absent']
default: present
name:
description:
- The name of the lun to manage.
- The name of the LUN to manage.
required: true
flexvol_name:
description:
- The name of the FlexVol the lun should exist on.
- The name of the FlexVol the LUN should exist on.
required: true
size:
description:
- The size of the lun in C(size_unit).
- The size of the LUN in C(size_unit).
- Required when C(state=present).
size_unit:
@ -117,7 +117,7 @@ EXAMPLES = """
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Resize Lun
- name: Resize LUN
na_ontap_lun:
state: present
name: ansibleLUN

12
lib/ansible/modules/storage/netapp/na_ontap_lun_map.py
Unescape Escape View File

@ -19,20 +19,20 @@ DOCUMENTATION = """
module: na_ontap_lun_map
short_description: Manage NetApp ONTAP lun maps
short_description: NetApp ONTAP LUN maps
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Map and unmap luns on NetApp ONTAP.
- Map and unmap LUNs on NetApp ONTAP.
options:
state:
description:
- Whether the specified lun should exist or not.
- Whether the specified LUN should exist or not.
choices: ['present', 'absent']
default: present
@ -59,7 +59,7 @@ options:
"""
EXAMPLES = """
- name: Create lun mapping
- name: Create LUN mapping
na_ontap_lun_map:
state: present
initiator_group_name: ansibleIgroup3234
@ -69,7 +69,7 @@ EXAMPLES = """
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Unmap Lun
- name: Unmap LUN
na_ontap_lun_map:
state: absent
initiator_group_name: ansibleIgroup3234
@ -102,7 +102,7 @@ lun_naa_id:
type: string
sample: 600a0980383045372f5d4c5a70315474
lun_state:
description: Online or offline tatus of the LUN.
description: Online or offline status of the LUN.
returned: success
type: string
sample: online

2
lib/ansible/modules/storage/netapp/na_ontap_net_ifgrp.py
Unescape Escape View File

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
module: na_ontap_net_ifgrp
short_description: Create, modify, destroy the network interface group
short_description: NetApp Ontap modify network interface group
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

4
lib/ansible/modules/storage/netapp/na_ontap_net_port.py
Unescape Escape View File

@ -13,13 +13,13 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
module: na_ontap_net_port
short_description: Manage NetApp ONTAP network ports.
short_description: NetApp ONTAP network ports.
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Modify a Ontap network port.
- Modify a ONTAP network port.
options:
state:
description:

2
lib/ansible/modules/storage/netapp/na_ontap_net_routes.py
Unescape Escape View File

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_net_routes
short_description: Manage NetApp ONTAP network routes
short_description: NetApp ONTAP network routes
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

14
lib/ansible/modules/storage/netapp/na_ontap_net_vlan.py
Unescape Escape View File

@ -12,37 +12,37 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_net_vlan
short_description: Manage NetApp ONTAP network vlan
short_description: NetApp ONTAP network VLAN
extends_documentation_fragment:
- netapp.ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Create or Delete a network vlan
- Create or Delete a network VLAN
options:
state:
description:
- Whether the specified network vlan should exist or not
- Whether the specified network VLAN should exist or not
choices: ['present', 'absent']
default: present
parent_interface:
description:
- The interface that hosts the vlan interface.
- The interface that hosts the VLAN interface.
required: true
vlanid:
description:
- The vlan id. Ranges from 1 to 4094.
- The VLAN id. Ranges from 1 to 4094.
required: true
node:
description:
- Node name of vlan interface.
- Node name of VLAN interface.
required: true
notes:
- The C(interface_name) option has been removed and should be deleted from playbooks
'''
EXAMPLES = """
- name: create vlan
- name: create VLAN
na_ontap_net_vlan:
state=present
vlanid=13

16
lib/ansible/modules/storage/netapp/na_ontap_nfs.py
Unescape Escape View File

@ -14,22 +14,22 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
module: na_ontap_nfs
short_description: Manage ONTAP NFS status
short_description: NetApp ONTAP NFS status
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Enable or disable nfs on ONTAP
- Enable or disable NFS on ONTAP
options:
state:
description:
- Whether nfs should exist or not.
- Whether NFS should exist or not.
choices: ['present', 'absent']
default: present
service_state:
description:
- Whether the specified nfs should be enabled or disabled. Creates nfs service if doesnt exist.
- Whether the specified NFS should be enabled or disabled. Creates NFS service if doesnt exist.
choices: ['started', 'stopped']
vserver:
description:
@ -37,7 +37,7 @@ options:
required: true
nfsv3:
description:
- status of nfsv3.
- status of NFSv3.
choices: ['enabled', 'disabled']
nfsv3_fsid_change:
description:
@ -46,11 +46,11 @@ options:
version_added: '2.7'
nfsv4:
description:
- status of nfsv4.
- status of NFSv4.
choices: ['enabled', 'disabled']
nfsv41:
description:
- status of nfsv41.
- status of NFSv41.
aliases: ['nfsv4.1']
choices: ['enabled', 'disabled']
vstorage_state:
@ -100,7 +100,7 @@ options:
choices: ['enabled', 'disabled']
showmount:
description:
- status for if SVM allows showmount
- Whether SVM allows showmount
choices: ['enabled', 'disabled']
version_added: '2.7'

10
lib/ansible/modules/storage/netapp/na_ontap_ntp.py
Unescape Escape View File

@ -14,26 +14,26 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
module: na_ontap_ntp
short_description: Create/Delete/modify_version ONTAP NTP server
short_description: NetApp ONTAP NTP server
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Create or delete or modify ntp server in ONTAP
- Create or delete or modify NTP server in ONTAP
options:
state:
description:
- Whether the specified ntp server should exist or not.
- Whether the specified NTP server should exist or not.
choices: ['present', 'absent']
default: 'present'
server_name:
description:
- The name of the ntp server to manage.
- The name of the NTP server to manage.
required: True
version:
description:
- give version for ntp server
- give version for NTP server
choices: ['auto', '3', '4']
default: 'auto'
"""

10
lib/ansible/modules/storage/netapp/na_ontap_qtree.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_qtree
short_description: Manage qtrees
short_description: NetApp ONTAP manage qtrees
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
@ -29,23 +29,23 @@ options:
state:
description:
- Whether the specified Qtree should exist or not.
- Whether the specified qtree should exist or not.
choices: ['present', 'absent']
default: 'present'
name:
description:
- The name of the Qtree to manage.
- The name of the qtree to manage.
required: true
from_name:
description:
- Name of the Qtree to be renamed.
- Name of the qtree to be renamed.
version_added: '2.7'
flexvol_name:
description:
- The name of the FlexVol the Qtree should exist on. Required when C(state=present).
- The name of the FlexVol the qtree should exist on. Required when C(state=present).
vserver:
description:

2
lib/ansible/modules/storage/netapp/na_ontap_service_processor_network.py
Unescape Escape View File

@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_service_processor_network
short_description: Manage NetApp ONTAP service processor network
short_description: NetApp ONTAP service processor network
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_snapshot.py
Unescape Escape View File

@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_snapshot
short_description: Manage NetApp Sanpshots
short_description: NetApp ONTAP manage Snapshots
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_snmp.py
Unescape Escape View File

@ -35,7 +35,7 @@ options:
description:
- "Whether the specified SNMP community should exist or not."
default: 'present'
short_description: "Manage NetApp SNMP community"
short_description: NetApp ONTAP SNMP community
version_added: "2.6"
'''

2
lib/ansible/modules/storage/netapp/na_ontap_software_update.py
Unescape Escape View File

@ -39,7 +39,7 @@ options:
- Allows the update to continue if warnings are encountered during the validation phase.
default: False
type: bool
short_description: "NetApp ONTAP Update software"
short_description: NetApp ONTAP Update Software
version_added: "2.7"
'''

12
lib/ansible/modules/storage/netapp/na_ontap_svm_options.py
Unescape Escape View File

@ -11,11 +11,11 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
'supported_by': 'community'}
DOCUMENTATION = '''
short_description: NetApp ONTAP Modify Options
short_description: NetApp ONTAP Modify SVM Options
author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
description:
- Modify ONTAP Options
- Only Options that appear on "vserver options show" are setable
- Modify ONTAP SVM Options
- Only Options that appear on "vserver options show" can be set
extends_documentation_fragment:
- netapp.na_ontap
module: na_ontap_svm_options
@ -23,10 +23,10 @@ version_added: "2.7"
options:
name:
description:
- Name of the option. This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.
- Name of the option.
value:
description:
- Value of the option. This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.
- Value of the option.
- Value must be in quote
vserver:
description:
@ -35,7 +35,7 @@ options:
'''
EXAMPLES = """
- name: Set Options
- name: Set SVM Options
na_ontap_svm_options:
vserver: "{{ netapp_vserver_name }}"
hostname: "{{ netapp_hostname }}"

2
lib/ansible/modules/storage/netapp/na_ontap_ucadapter.py
Unescape Escape View File

@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: na_ontap_ucadapter
short_description: ONTAP UC adapter configuration
short_description: NetApp ONTAP UC adapter configuration
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_user.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_user
short_description: useradmin configuration and management
short_description: NetApp ONTAP user configuration and management
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_user_role.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_user_role
short_description: useradmin configuration and management
short_description: NetApp ONTAP user role configuration and management
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_volume.py
Unescape Escape View File

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: na_ontap_volume
short_description: Manage NetApp ONTAP volumes.
short_description: NetApp ONTAP manage volumes.
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_volume_clone.py
Unescape Escape View File

@ -12,7 +12,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
module: na_ontap_volume_clone
short_description: Manage NetApp ONTAP volume clones.
short_description: NetApp ONTAP manage volume clones.
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'

2
lib/ansible/modules/storage/netapp/na_ontap_vserver_peer.py
Unescape Escape View File

@ -49,7 +49,7 @@ options:
description:
- Destination password.
- Optional if this is same as source password.
short_description: "Manage NetApp Vserver peering"
short_description: NetApp ONTAP Vserver peering
version_added: "2.7"
'''

Write Preview
Loading…
Cancel
Save