add description and hookscript parameters to proxmox LXC container

[Links2004]

SUMMARY

adding missing options for the Proxmox LXC container.

• hookscript
• description

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

proxmox

ADDITIONAL INFORMATION

no big change only added 2 new parameters.
example:

- proxmox:
    vmid: 100
    node: uk-mc02
    api_user: root@pam
    api_password: 1q2w3e
    api_host: node1
    password: 123456
    hostname: example.org
    ostemplate: 'local:vztmpl/debian-10.0-standard_10.0-1_amd64.tar.gz'
    hookscript: 'local:snippets/vm_hook.sh'
    description: created with ansible

[ansibullbot]

cc @UnderGreen @joshainglis @karmab
click here for bot help

[ansibullbot]

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

plugins/modules/cloud/misc/proxmox.py:540:29: E128: continuation line under-indented for visual indent
plugins/modules/cloud/misc/proxmox.py:541:29: E128: continuation line under-indented for visual indent

click here for bot help

[Andersson007]

Please add a changelog fragment https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to

[Andersson007]

also would be good to have examples of using these parameters in the EXAMPLES block

[Andersson007]

i've changed the format of current examples #248 to correspond to best practices

[Links2004]

master merged
changelog fragment and example added

[ansibullbot]

@Links2004 this PR contains the following merge commits:

• ed22232

Please rebase your branch to remove these commits.

click here for bot help

[ansibullbot]

The test ansible-test sanity --test ansible-doc [explain] failed with the error:

Command "ansible-doc -t module community.general.proxmox" returned exit status 1.
>>> Standard Error
ERROR! module community.general.proxmox missing documentation (or could not parse documentation): mapping keys are not allowed in this context
  in "<unicode string>", line 133, column 11

The test ansible-test sanity --test validate-modules [explain] failed with 12 errors:

plugins/modules/cloud/misc/proxmox.py:0:0: doc-choices-do-not-match-spec: Argument 'state' in argument_spec defines choices as (['present', 'absent', 'stopped', 'started', 'restarted']) but documentation defines choices as ([])
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'cores' in argument_spec defines default as (1) but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'cpus' in argument_spec defines default as (1) but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'cpuunits' in argument_spec defines default as (1000) but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'disk' in argument_spec defines default as ('3') but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'memory' in argument_spec defines default as (512) but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'storage' in argument_spec defines default as ('local') but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-default-does-not-match-spec: Argument 'timeout' in argument_spec defines default as (30) but documentation defines default as (None)
plugins/modules/cloud/misc/proxmox.py:0:0: doc-required-mismatch: Argument 'api_host' in argument_spec is required, but is not documented as being required
plugins/modules/cloud/misc/proxmox.py:0:0: doc-required-mismatch: Argument 'api_user' in argument_spec is required, but is not documented as being required
plugins/modules/cloud/misc/proxmox.py:145:11: documentation-syntax-error: DOCUMENTATION is not valid YAML

The test ansible-test sanity --test yamllint [explain] failed with 2 errors:

plugins/modules/cloud/misc/proxmox.py:132:11: unparsable-with-libyaml: None - mapping keys are not allowed in this context
plugins/modules/cloud/misc/proxmox.py:145:11: error: DOCUMENTATION: syntax error: mapping keys are not allowed here (syntax)

click here for bot help

[Andersson007]

LGTM

[Andersson007]

I'm not a user of the module, @UnderGreen could you look at the changes please?

[Links2004]

Any updates or change to get this merged?

[felixfontein]

@UnderGreen @joshainglis @karmab could you please take a look?

[Andersson007]

@Links2004 thanks for the contribution!
@felixfontein thanks for reviewing!

[Andersson007]

merged #245 into master