From 88691af0231e6ada6097324c4a0ce60b91053015 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Mon, 30 Jan 2023 22:51:36 +0100 Subject: [PATCH] fix ansible-test sanity errors --- plugins/inventory/proxmox.py | 132 +++++++++++++++++------------------ 1 file changed, 66 insertions(+), 66 deletions(-) diff --git a/plugins/inventory/proxmox.py b/plugins/inventory/proxmox.py index a7068fc..fcd2b71 100644 --- a/plugins/inventory/proxmox.py +++ b/plugins/inventory/proxmox.py @@ -9,73 +9,73 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = """ - name: proxmox - plugin_type: inventory - short_description: Proxmox VE inventory source - version_added: 1.1.0 +--- +name: proxmox +short_description: Proxmox VE inventory source +version_added: 1.1.0 +description: + - Get inventory hosts from the proxmox service. + - "Uses a configuration file as an inventory source, it must end in C(.proxmox.yml) or C(.proxmox.yaml) and has a C(plugin: xoxys.general.proxmox) entry." +extends_documentation_fragment: + - inventory_cache +options: + plugin: + description: The name of this plugin, it should always be set to C(xoxys.general.proxmox) for this plugin to recognize it as it's own. + required: yes + choices: ["xoxys.general.proxmox"] + api_host: description: - - Get inventory hosts from the proxmox service. - - "Uses a configuration file as an inventory source, it must end in C(.proxmox.yml) or C(.proxmox.yaml) and has a C(plugin: xoxys.general.proxmox) entry." - extends_documentation_fragment: - - inventory_cache - options: - plugin: - description: The name of this plugin, it should always be set to C(xoxys.general.proxmox) for this plugin to recognize it as it's own. - required: yes - choices: ["xoxys.general.proxmox"] - api_host: - description: - - Specify the target host of the Proxmox VE cluster. - type: str - required: true - api_user: - description: - - Specify the user to authenticate with. - type: str - required: true - api_password: - description: - - Specify the password to authenticate with. - - You can use C(PROXMOX_PASSWORD) environment variable. - type: str - api_token_id: - description: - - Specify the token ID. - type: str - api_token_secret: - description: - - Specify the token secret. - type: str - verify_ssl: - description: - - If C(false), SSL certificates will not be validated. - - This should only be used on personally controlled sites using self-signed certificates. - type: bool - default: True - auth_timeout: - description: Proxmox VE authentication timeout. - type: int - default: 5 - exclude_vmid: - description: VMID's to exclude from inventory. - type: list - default: [] - elements: str - exclude_state: - description: VM states to exclude from inventory. - type: list - default: [] - elements: str - group: - description: Group to place all hosts into. - type: string - default: proxmox - want_facts: - description: Toggle, if C(true) the plugin will retrieve host facts from the server - type: boolean - default: True - requirements: - - "proxmoxer" + - Specify the target host of the Proxmox VE cluster. + type: str + required: true + api_user: + description: + - Specify the user to authenticate with. + type: str + required: true + api_password: + description: + - Specify the password to authenticate with. + - You can use C(PROXMOX_PASSWORD) environment variable. + type: str + api_token_id: + description: + - Specify the token ID. + type: str + api_token_secret: + description: + - Specify the token secret. + type: str + verify_ssl: + description: + - If C(false), SSL certificates will not be validated. + - This should only be used on personally controlled sites using self-signed certificates. + type: bool + default: True + auth_timeout: + description: Proxmox VE authentication timeout. + type: int + default: 5 + exclude_vmid: + description: VMID's to exclude from inventory. + type: list + default: [] + elements: str + exclude_state: + description: VM states to exclude from inventory. + type: list + default: [] + elements: str + group: + description: Group to place all hosts into. + type: string + default: proxmox + want_facts: + description: Toggle, if C(true) the plugin will retrieve host facts from the server + type: boolean + default: True +requirements: + - "proxmoxer" """ # noqa EXAMPLES = """