mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Initial commit
This commit is contained in:
commit
aebc1b03fd
4861 changed files with 812621 additions and 0 deletions
190
plugins/modules/remote_management/ipmi/ipmi_boot.py
Normal file
190
plugins/modules/remote_management/ipmi/ipmi_boot.py
Normal file
|
@ -0,0 +1,190 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: 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
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipmi_boot
|
||||
short_description: Management of order of boot devices
|
||||
description:
|
||||
- Use this module to manage order of boot devices
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Hostname or ip address of the BMC.
|
||||
required: true
|
||||
port:
|
||||
description:
|
||||
- Remote RMCP port.
|
||||
default: 623
|
||||
user:
|
||||
description:
|
||||
- Username to use to connect to the BMC.
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- Password to connect to the BMC.
|
||||
required: true
|
||||
bootdev:
|
||||
description:
|
||||
- Set boot device to use on next reboot
|
||||
required: true
|
||||
choices:
|
||||
- network -- Request network boot
|
||||
- floppy -- Boot from floppy
|
||||
- hd -- Boot from hard drive
|
||||
- safe -- Boot from hard drive, requesting 'safe mode'
|
||||
- optical -- boot from CD/DVD/BD drive
|
||||
- setup -- Boot into setup utility
|
||||
- default -- remove any IPMI directed boot device request
|
||||
state:
|
||||
description:
|
||||
- Whether to ensure that boot devices is desired.
|
||||
default: present
|
||||
choices:
|
||||
- present -- Request system turn on
|
||||
- absent -- Request system turn on
|
||||
persistent:
|
||||
description:
|
||||
- If set, ask that system firmware uses this device beyond next boot.
|
||||
Be aware many systems do not honor this.
|
||||
type: bool
|
||||
default: 'no'
|
||||
uefiboot:
|
||||
description:
|
||||
- If set, request UEFI boot explicitly.
|
||||
Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option.
|
||||
In practice, this flag not being set does not preclude UEFI boot on any system I've encountered.
|
||||
type: bool
|
||||
default: 'no'
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- pyghmi
|
||||
author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
bootdev:
|
||||
description: The boot device name which will be used beyond next boot.
|
||||
returned: success
|
||||
type: str
|
||||
sample: default
|
||||
persistent:
|
||||
description: If True, system firmware will use this device beyond next boot.
|
||||
returned: success
|
||||
type: bool
|
||||
sample: false
|
||||
uefimode:
|
||||
description: If True, system firmware will use UEFI boot explicitly beyond next boot.
|
||||
returned: success
|
||||
type: bool
|
||||
sample: false
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Ensure bootdevice is HD.
|
||||
- ipmi_boot:
|
||||
name: test.testdomain.com
|
||||
user: admin
|
||||
password: password
|
||||
bootdev: hd
|
||||
|
||||
# Ensure bootdevice is not Network
|
||||
- ipmi_boot:
|
||||
name: test.testdomain.com
|
||||
user: admin
|
||||
password: password
|
||||
bootdev: network
|
||||
state: absent
|
||||
'''
|
||||
|
||||
import traceback
|
||||
|
||||
PYGHMI_IMP_ERR = None
|
||||
try:
|
||||
from pyghmi.ipmi import command
|
||||
except ImportError:
|
||||
PYGHMI_IMP_ERR = traceback.format_exc()
|
||||
command = None
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
name=dict(required=True),
|
||||
port=dict(default=623, type='int'),
|
||||
user=dict(required=True, no_log=True),
|
||||
password=dict(required=True, no_log=True),
|
||||
state=dict(default='present', choices=['present', 'absent']),
|
||||
bootdev=dict(required=True, choices=['network', 'hd', 'floppy', 'safe', 'optical', 'setup', 'default']),
|
||||
persistent=dict(default=False, type='bool'),
|
||||
uefiboot=dict(default=False, type='bool')
|
||||
),
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
if command is None:
|
||||
module.fail_json(msg=missing_required_lib('pyghmi'), exception=PYGHMI_IMP_ERR)
|
||||
|
||||
name = module.params['name']
|
||||
port = module.params['port']
|
||||
user = module.params['user']
|
||||
password = module.params['password']
|
||||
state = module.params['state']
|
||||
bootdev = module.params['bootdev']
|
||||
persistent = module.params['persistent']
|
||||
uefiboot = module.params['uefiboot']
|
||||
request = dict()
|
||||
|
||||
if state == 'absent' and bootdev == 'default':
|
||||
module.fail_json(msg="The bootdev 'default' cannot be used with state 'absent'.")
|
||||
|
||||
# --- run command ---
|
||||
try:
|
||||
ipmi_cmd = command.Command(
|
||||
bmc=name, userid=user, password=password, port=port
|
||||
)
|
||||
module.debug('ipmi instantiated - name: "%s"' % name)
|
||||
current = ipmi_cmd.get_bootdev()
|
||||
# uefimode may not supported by BMC, so use desired value as default
|
||||
current.setdefault('uefimode', uefiboot)
|
||||
if state == 'present' and current != dict(bootdev=bootdev, persistent=persistent, uefimode=uefiboot):
|
||||
request = dict(bootdev=bootdev, uefiboot=uefiboot, persist=persistent)
|
||||
elif state == 'absent' and current['bootdev'] == bootdev:
|
||||
request = dict(bootdev='default')
|
||||
else:
|
||||
module.exit_json(changed=False, **current)
|
||||
|
||||
if module.check_mode:
|
||||
response = dict(bootdev=request['bootdev'])
|
||||
else:
|
||||
response = ipmi_cmd.set_bootdev(**request)
|
||||
|
||||
if 'error' in response:
|
||||
module.fail_json(msg=response['error'])
|
||||
|
||||
if 'persist' in request:
|
||||
response['persistent'] = request['persist']
|
||||
if 'uefiboot' in request:
|
||||
response['uefimode'] = request['uefiboot']
|
||||
|
||||
module.exit_json(changed=True, **response)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
135
plugins/modules/remote_management/ipmi/ipmi_power.py
Normal file
135
plugins/modules/remote_management/ipmi/ipmi_power.py
Normal file
|
@ -0,0 +1,135 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: 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
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipmi_power
|
||||
short_description: Power management for machine
|
||||
description:
|
||||
- Use this module for power management
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Hostname or ip address of the BMC.
|
||||
required: true
|
||||
port:
|
||||
description:
|
||||
- Remote RMCP port.
|
||||
default: 623
|
||||
user:
|
||||
description:
|
||||
- Username to use to connect to the BMC.
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- Password to connect to the BMC.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- Whether to ensure that the machine in desired state.
|
||||
required: true
|
||||
choices:
|
||||
- on -- Request system turn on
|
||||
- off -- Request system turn off without waiting for OS to shutdown
|
||||
- shutdown -- Have system request OS proper shutdown
|
||||
- reset -- Request system reset without waiting for OS
|
||||
- boot -- If system is off, then 'on', else 'reset'
|
||||
timeout:
|
||||
description:
|
||||
- Maximum number of seconds before interrupt request.
|
||||
default: 300
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- pyghmi
|
||||
author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
powerstate:
|
||||
description: The current power state of the machine.
|
||||
returned: success
|
||||
type: str
|
||||
sample: on
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Ensure machine is powered on.
|
||||
- ipmi_power:
|
||||
name: test.testdomain.com
|
||||
user: admin
|
||||
password: password
|
||||
state: on
|
||||
'''
|
||||
|
||||
import traceback
|
||||
|
||||
PYGHMI_IMP_ERR = None
|
||||
try:
|
||||
from pyghmi.ipmi import command
|
||||
except ImportError:
|
||||
PYGHMI_IMP_ERR = traceback.format_exc()
|
||||
command = None
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
name=dict(required=True),
|
||||
port=dict(default=623, type='int'),
|
||||
state=dict(required=True, choices=['on', 'off', 'shutdown', 'reset', 'boot']),
|
||||
user=dict(required=True, no_log=True),
|
||||
password=dict(required=True, no_log=True),
|
||||
timeout=dict(default=300, type='int'),
|
||||
),
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
if command is None:
|
||||
module.fail_json(msg=missing_required_lib('pyghmi'), exception=PYGHMI_IMP_ERR)
|
||||
|
||||
name = module.params['name']
|
||||
port = module.params['port']
|
||||
user = module.params['user']
|
||||
password = module.params['password']
|
||||
state = module.params['state']
|
||||
timeout = module.params['timeout']
|
||||
|
||||
# --- run command ---
|
||||
try:
|
||||
ipmi_cmd = command.Command(
|
||||
bmc=name, userid=user, password=password, port=port
|
||||
)
|
||||
module.debug('ipmi instantiated - name: "%s"' % name)
|
||||
|
||||
current = ipmi_cmd.get_power()
|
||||
if current['powerstate'] != state:
|
||||
response = {'powerstate': state} if module.check_mode else ipmi_cmd.set_power(state, wait=timeout)
|
||||
changed = True
|
||||
else:
|
||||
response = current
|
||||
changed = False
|
||||
|
||||
if 'error' in response:
|
||||
module.fail_json(msg=response['error'])
|
||||
|
||||
module.exit_json(changed=changed, **response)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Add table
Add a link
Reference in a new issue