mirror of
				https://github.com/ansible-collections/community.general.git
				synced 2025-10-25 05:23:58 -07:00 
			
		
		
		
	normalize docs in become plugins (#9452)
* normalize docs in become plugins Normalize doc blocks for plugins * adjustments
This commit is contained in:
		
					parent
					
						
							
								0bbc3eccd9
							
						
					
				
			
			
				commit
				
					
						29e3226718
					
				
			
		
					 10 changed files with 706 additions and 706 deletions
				
			
		|  | @ -5,84 +5,84 @@ | |||
| from __future__ import (absolute_import, division, print_function) | ||||
| __metaclass__ = type | ||||
| 
 | ||||
| DOCUMENTATION = ''' | ||||
|     name: pbrun | ||||
|     short_description: PowerBroker run | ||||
|     description: | ||||
|         - This become plugins allows your remote/login user to execute commands as another user via the pbrun utility. | ||||
|     author: Ansible Core Team | ||||
|     options: | ||||
|         become_user: | ||||
|             description: User you 'become' to execute the task. | ||||
|             type: string | ||||
|             default: '' | ||||
|             ini: | ||||
|               - section: privilege_escalation | ||||
|                 key: become_user | ||||
|               - section: pbrun_become_plugin | ||||
|                 key: user | ||||
|             vars: | ||||
|               - name: ansible_become_user | ||||
|               - name: ansible_pbrun_user | ||||
|             env: | ||||
|               - name: ANSIBLE_BECOME_USER | ||||
|               - name: ANSIBLE_PBRUN_USER | ||||
|         become_exe: | ||||
|             description: Sudo executable. | ||||
|             type: string | ||||
|             default: pbrun | ||||
|             ini: | ||||
|               - section: privilege_escalation | ||||
|                 key: become_exe | ||||
|               - section: pbrun_become_plugin | ||||
|                 key: executable | ||||
|             vars: | ||||
|               - name: ansible_become_exe | ||||
|               - name: ansible_pbrun_exe | ||||
|             env: | ||||
|               - name: ANSIBLE_BECOME_EXE | ||||
|               - name: ANSIBLE_PBRUN_EXE | ||||
|         become_flags: | ||||
|             description: Options to pass to pbrun. | ||||
|             type: string | ||||
|             default: '' | ||||
|             ini: | ||||
|               - section: privilege_escalation | ||||
|                 key: become_flags | ||||
|               - section: pbrun_become_plugin | ||||
|                 key: flags | ||||
|             vars: | ||||
|               - name: ansible_become_flags | ||||
|               - name: ansible_pbrun_flags | ||||
|             env: | ||||
|               - name: ANSIBLE_BECOME_FLAGS | ||||
|               - name: ANSIBLE_PBRUN_FLAGS | ||||
|         become_pass: | ||||
|             description: Password for pbrun. | ||||
|             type: string | ||||
|             required: false | ||||
|             vars: | ||||
|               - name: ansible_become_password | ||||
|               - name: ansible_become_pass | ||||
|               - name: ansible_pbrun_pass | ||||
|             env: | ||||
|               - name: ANSIBLE_BECOME_PASS | ||||
|               - name: ANSIBLE_PBRUN_PASS | ||||
|             ini: | ||||
|               - section: pbrun_become_plugin | ||||
|                 key: password | ||||
|         wrap_exe: | ||||
|             description: Toggle to wrap the command pbrun calls in C(shell -c) or not. | ||||
|             default: false | ||||
|             type: bool | ||||
|             ini: | ||||
|               - section: pbrun_become_plugin | ||||
|                 key: wrap_execution | ||||
|             vars: | ||||
|               - name: ansible_pbrun_wrap_execution | ||||
|             env: | ||||
|               - name: ANSIBLE_PBRUN_WRAP_EXECUTION | ||||
| ''' | ||||
| DOCUMENTATION = r""" | ||||
| name: pbrun | ||||
| short_description: PowerBroker run | ||||
| description: | ||||
|   - This become plugins allows your remote/login user to execute commands as another user using the C(pbrun) utility. | ||||
| author: Ansible Core Team | ||||
| options: | ||||
|   become_user: | ||||
|     description: User you 'become' to execute the task. | ||||
|     type: string | ||||
|     default: '' | ||||
|     ini: | ||||
|       - section: privilege_escalation | ||||
|         key: become_user | ||||
|       - section: pbrun_become_plugin | ||||
|         key: user | ||||
|     vars: | ||||
|       - name: ansible_become_user | ||||
|       - name: ansible_pbrun_user | ||||
|     env: | ||||
|       - name: ANSIBLE_BECOME_USER | ||||
|       - name: ANSIBLE_PBRUN_USER | ||||
|   become_exe: | ||||
|     description: C(pbrun) executable. | ||||
|     type: string | ||||
|     default: pbrun | ||||
|     ini: | ||||
|       - section: privilege_escalation | ||||
|         key: become_exe | ||||
|       - section: pbrun_become_plugin | ||||
|         key: executable | ||||
|     vars: | ||||
|       - name: ansible_become_exe | ||||
|       - name: ansible_pbrun_exe | ||||
|     env: | ||||
|       - name: ANSIBLE_BECOME_EXE | ||||
|       - name: ANSIBLE_PBRUN_EXE | ||||
|   become_flags: | ||||
|     description: Options to pass to C(pbrun). | ||||
|     type: string | ||||
|     default: '' | ||||
|     ini: | ||||
|       - section: privilege_escalation | ||||
|         key: become_flags | ||||
|       - section: pbrun_become_plugin | ||||
|         key: flags | ||||
|     vars: | ||||
|       - name: ansible_become_flags | ||||
|       - name: ansible_pbrun_flags | ||||
|     env: | ||||
|       - name: ANSIBLE_BECOME_FLAGS | ||||
|       - name: ANSIBLE_PBRUN_FLAGS | ||||
|   become_pass: | ||||
|     description: Password for C(pbrun). | ||||
|     type: string | ||||
|     required: false | ||||
|     vars: | ||||
|       - name: ansible_become_password | ||||
|       - name: ansible_become_pass | ||||
|       - name: ansible_pbrun_pass | ||||
|     env: | ||||
|       - name: ANSIBLE_BECOME_PASS | ||||
|       - name: ANSIBLE_PBRUN_PASS | ||||
|     ini: | ||||
|       - section: pbrun_become_plugin | ||||
|         key: password | ||||
|   wrap_exe: | ||||
|     description: Toggle to wrap the command C(pbrun) calls in C(shell -c) or not. | ||||
|     default: false | ||||
|     type: bool | ||||
|     ini: | ||||
|       - section: pbrun_become_plugin | ||||
|         key: wrap_execution | ||||
|     vars: | ||||
|       - name: ansible_pbrun_wrap_execution | ||||
|     env: | ||||
|       - name: ANSIBLE_PBRUN_WRAP_EXECUTION | ||||
| """ | ||||
| 
 | ||||
| from ansible.plugins.become import BecomeBase | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue