plugins/inventory/proxmox.py

@@ -9,73 +9,73 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = """
-    name: proxmox
+---
-    plugin_type: inventory
+name: proxmox
-    short_description: Proxmox VE inventory source
+short_description: Proxmox VE inventory source
-    version_added: 1.1.0
+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.
+      - Specify the target host of the Proxmox VE cluster.
-      - "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."
+    type: str
-    extends_documentation_fragment:
+    required: true
-      - inventory_cache
+  api_user:
-    options:
+    description:
-      plugin:
+      - Specify the user to authenticate with.
-        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.
+    type: str
-        required: yes
+    required: true
-        choices: ["xoxys.general.proxmox"]
+  api_password:
-      api_host:
+    description:
-        description:
+      - Specify the password to authenticate with.
-          - Specify the target host of the Proxmox VE cluster.
+      - You can use C(PROXMOX_PASSWORD) environment variable.
-        type: str
+    type: str
-        required: true
+  api_token_id:
-      api_user:
+    description:
-        description:
+      - Specify the token ID.
-          - Specify the user to authenticate with.
+    type: str
-        type: str
+  api_token_secret:
-        required: true
+    description:
-      api_password:
+      - Specify the token secret.
-        description:
+    type: str
-          - Specify the password to authenticate with.
+  verify_ssl:
-          - You can use C(PROXMOX_PASSWORD) environment variable.
+    description:
-        type: str
+      - If C(false), SSL certificates will not be validated.
-      api_token_id:
+      - This should only be used on personally controlled sites using self-signed certificates.
-        description:
+    type: bool
-          - Specify the token ID.
+    default: True
-        type: str
+  auth_timeout:
-      api_token_secret:
+    description: Proxmox VE authentication timeout.
-        description:
+    type: int
-          - Specify the token secret.
+    default: 5
-        type: str
+  exclude_vmid:
-      verify_ssl:
+    description: VMID's to exclude from inventory.
-        description:
+    type: list
-          - If C(false), SSL certificates will not be validated.
+    default: []
-          - This should only be used on personally controlled sites using self-signed certificates.
+    elements: str
-        type: bool
+  exclude_state:
-        default: True
+    description: VM states to exclude from inventory.
-      auth_timeout:
+    type: list
-        description: Proxmox VE authentication timeout.
+    default: []
-        type: int
+    elements: str
-        default: 5
+  group:
-      exclude_vmid:
+    description: Group to place all hosts into.
-        description: VMID's to exclude from inventory.
+    type: string
-        type: list
+    default: proxmox
-        default: []
+  want_facts:
-        elements: str
+    description: Toggle, if C(true) the plugin will retrieve host facts from the server
-      exclude_state:
+    type: boolean
-        description: VM states to exclude from inventory.
+    default: True
-        type: list
+requirements:
-        default: []
+  - "proxmoxer"
-        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 = """