mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
[PR #9364/6b7ea344 backport][stable-10] [prox ... pyth]*: normalize docs (#9400)
[prox ... pyth]*: normalize docs (#9364)
* [prox ... pyth]*: normalize docs
* Apply suggestions from code review
Co-authored-by: IamLunchbox <56757745+IamLunchbox@users.noreply.github.com>
* Update plugins/modules/pushbullet.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/pushbullet.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: IamLunchbox <56757745+IamLunchbox@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 6b7ea3443d
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
4f9e7bd793
commit
7a44dbfe45
23 changed files with 633 additions and 729 deletions
|
@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: proxmox_node_info
|
||||
short_description: Retrieve information about one or more Proxmox VE nodes
|
||||
version_added: 8.2.0
|
||||
|
@ -25,10 +24,10 @@ extends_documentation_fragment:
|
|||
- community.general.proxmox.documentation
|
||||
- community.general.attributes
|
||||
- community.general.attributes.info_module
|
||||
'''
|
||||
"""
|
||||
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: List existing nodes
|
||||
community.general.proxmox_node_info:
|
||||
api_host: proxmox1
|
||||
|
@ -37,69 +36,69 @@ EXAMPLES = '''
|
|||
api_token_id: "{{ token_id | default(omit) }}"
|
||||
api_token_secret: "{{ token_secret | default(omit) }}"
|
||||
register: proxmox_nodes
|
||||
'''
|
||||
"""
|
||||
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
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
|
||||
'''
|
||||
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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue