forked from ansible/ansible
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add enable become plugin patterned after runas (ansible#52496)
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# -*- coding: utf-8 -*- | ||
# Copyright: (c) 2018, Ansible Project | ||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) | ||
from __future__ import (absolute_import, division, print_function) | ||
__metaclass__ = type | ||
|
||
DOCUMENTATION = """ | ||
become: enable | ||
short_description: Switch to elevated permissions on a network device | ||
description: | ||
- This become plugins allows elevated permissions on a remote network device. | ||
author: ansible (@core) | ||
version_added: "2.8" | ||
options: | ||
become_pass: | ||
description: password | ||
ini: | ||
- section: enable_become_plugin | ||
key: password | ||
vars: | ||
- name: ansible_become_password | ||
- name: ansible_become_pass | ||
- name: ansible_enable_pass | ||
env: | ||
- name: ANSIBLE_BECOME_PASS | ||
- name: ANSIBLE_ENABLE_PASS | ||
notes: | ||
- enable is really implemented in the network connection handler and as such can only be used with network connections. | ||
- This plugin ignores the 'become_exe' and 'become_user' settings as it uses an API and not an executable. | ||
""" | ||
|
||
from ansible.plugins.become import BecomeBase | ||
|
||
|
||
class BecomeModule(BecomeBase): | ||
|
||
name = 'enable' | ||
|
||
def build_become_command(self, cmd, shell): | ||
# enable is implemented inside the network connection plugins | ||
return cmd |