mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
bf089294b4
Add proxmox_node_info module (#7689)
* Add proxmox_node_info module - restarted PR due to erroneous update/push of my local fork.
* Used wrong user ID.
* Changes requested by felixfontein:
- Capitalization and punctuation in documentation section
- trailing comma on line 125
- Re-order BOTMETA so it is alphabetical
* Mis-copied older version of code, correcting actual call
* Add tests for proxmox_node_info module
(cherry picked from commit 1a3c93f80c)
Co-authored-by: John Berninger <john.berninger@gmail.com>
140 lines
3.7 KiB
Python
140 lines
3.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright John Berninger (@jberning) <john.berninger at gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: proxmox_node_info
|
|
short_description: Retrieve information about one or more Proxmox VE nodes
|
|
version_added: 8.2.0
|
|
description:
|
|
- Retrieve information about one or more Proxmox VE nodes.
|
|
author: John Berninger (@jwbernin)
|
|
extends_documentation_fragment:
|
|
- community.general.proxmox.documentation
|
|
- community.general.attributes
|
|
- community.general.attributes.info_module
|
|
'''
|
|
|
|
|
|
EXAMPLES = '''
|
|
- name: List existing nodes
|
|
community.general.proxmox_node_info:
|
|
api_host: proxmox1
|
|
api_user: root@pam
|
|
api_password: "{{ password | default(omit) }}"
|
|
api_token_id: "{{ token_id | default(omit) }}"
|
|
api_token_secret: "{{ token_secret | default(omit) }}"
|
|
register: proxmox_nodes
|
|
'''
|
|
|
|
|
|
RETURN = '''
|
|
proxmox_nodes:
|
|
description: List of Proxmox VE nodes.
|
|
returned: always, but can be empty
|
|
type: list
|
|
elements: dict
|
|
contains:
|
|
cpu:
|
|
description: Current CPU usage in fractional shares of this host's total available CPU.
|
|
returned: on success
|
|
type: float
|
|
disk:
|
|
description: Current local disk usage of this host.
|
|
returned: on success
|
|
type: int
|
|
id:
|
|
description: Identity of the node.
|
|
returned: on success
|
|
type: str
|
|
level:
|
|
description: Support level. Can be blank if not under a paid support contract.
|
|
returned: on success
|
|
type: str
|
|
maxcpu:
|
|
description: Total number of available CPUs on this host.
|
|
returned: on success
|
|
type: int
|
|
maxdisk:
|
|
description: Size of local disk in bytes.
|
|
returned: on success
|
|
type: int
|
|
maxmem:
|
|
description: Memory size in bytes.
|
|
returned: on success
|
|
type: int
|
|
mem:
|
|
description: Used memory in bytes.
|
|
returned: on success
|
|
type: int
|
|
node:
|
|
description: Short hostname of this node.
|
|
returned: on success
|
|
type: str
|
|
ssl_fingerprint:
|
|
description: SSL fingerprint of the node certificate.
|
|
returned: on success
|
|
type: str
|
|
status:
|
|
description: Node status.
|
|
returned: on success
|
|
type: str
|
|
type:
|
|
description: Object type being returned.
|
|
returned: on success
|
|
type: str
|
|
uptime:
|
|
description: Node uptime in seconds.
|
|
returned: on success
|
|
type: int
|
|
'''
|
|
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.general.plugins.module_utils.proxmox import (
|
|
proxmox_auth_argument_spec, ProxmoxAnsible)
|
|
|
|
|
|
class ProxmoxNodeInfoAnsible(ProxmoxAnsible):
|
|
def get_nodes(self):
|
|
nodes = self.proxmox_api.nodes.get()
|
|
return nodes
|
|
|
|
|
|
def proxmox_node_info_argument_spec():
|
|
return dict()
|
|
|
|
|
|
def main():
|
|
module_args = proxmox_auth_argument_spec()
|
|
node_info_args = proxmox_node_info_argument_spec()
|
|
module_args.update(node_info_args)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=module_args,
|
|
required_one_of=[('api_password', 'api_token_id')],
|
|
required_together=[('api_token_id', 'api_token_secret')],
|
|
supports_check_mode=True,
|
|
)
|
|
result = dict(
|
|
changed=False
|
|
)
|
|
|
|
proxmox = ProxmoxNodeInfoAnsible(module)
|
|
|
|
nodes = proxmox.get_nodes()
|
|
result['proxmox_nodes'] = nodes
|
|
|
|
module.exit_json(**result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|