mirror of
				https://github.com/ansible-collections/community.general.git
				synced 2025-10-26 05:50:36 -07:00 
			
		
		
		
	* 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
		
			
				
	
	
		
			47 lines
		
	
	
	
		
			1.3 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			47 lines
		
	
	
	
		
			1.3 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
| # -*- coding: utf-8 -*-
 | |
| 
 | |
| # Copyright: (c) 2016, John Barker <jobarker@redhat.com>
 | |
| # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 | |
| 
 | |
| 
 | |
| class ModuleDocFragment(object):
 | |
| 
 | |
|     # Standard files documentation fragment
 | |
|     DOCUMENTATION = r'''
 | |
| options:
 | |
|   host:
 | |
|     description:
 | |
|       - Hostname or IP of the A10 Networks device.
 | |
|     type: str
 | |
|     required: true
 | |
|   username:
 | |
|     description:
 | |
|       - An account with administrator privileges.
 | |
|     type: str
 | |
|     required: true
 | |
|     aliases: [ admin, user ]
 | |
|   password:
 | |
|     description:
 | |
|       - Password for the C(username) account.
 | |
|     type: str
 | |
|     required: true
 | |
|     aliases: [ pass, pwd ]
 | |
|   write_config:
 | |
|     description:
 | |
|       - If C(yes), any changes will cause a write of the running configuration
 | |
|         to non-volatile memory. This will save I(all) configuration changes,
 | |
|         including those that may have been made manually or through other modules,
 | |
|         so care should be taken when specifying C(yes).
 | |
|     type: bool
 | |
|     default: no
 | |
|     version_added: '2.2'
 | |
|   validate_certs:
 | |
|     description:
 | |
|       - If C(no), SSL certificates will not be validated.
 | |
|       - This should only be used on personally controlled devices using self-signed certificates.
 | |
|     type: bool
 | |
|     default: yes
 | |
|     version_added: '2.2'
 | |
| notes:
 | |
|     - Requires A10 Networks aXAPI 2.1.
 | |
| '''
 |