Module vmware_vcenter_settings bug and functionality

[nicholasrodriguez]

SUMMARY

This module still dosen't function correctly if runtime_settings isn't specified but has potential for misconfiguration in general.

For runtime_settings there is no default dict defined in argument_spec.update(...) in main() so if the runtime_settings key isn't defined then the module fails with the error in ACTUAL RESULTS section.

In the documentation these keys aren't specified as required.

In general the functionality of this module should be that only a subset or all of the available options should be configured if declared.

It appears that if you don't specify options then the defaults built into the module for each of the options are used and will overwrite anything currently configured on the target vCenter. This is potentially dangerous and could cause issues.

ISSUE TYPE

• Bug Report

COMPONENT NAME

vmware_vcenter_settings

ANSIBLE VERSION

The latest devel version of vmware_vcenter_settings has been used

ansible 2.8.0
  config file = None
  configured module search path = [u'/root/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.5 (default, Jun 11 2019, 14:33:56) [GCC 4.8.5 20150623 (Red Hat 4.8.5-39)]

CONFIGURATION

DEFAULT_MANAGED_STR(/<PATH>/vmware-ansible/ansible.cfg) = This file is managed by Ansible
HOST_KEY_CHECKING(/<PATH>/vmware-ansible/ansible.cfg) = False
RETRY_FILES_ENABLED(/<PATH>/vmware-ansible/ansible.cfg) = False

OS / ENVIRONMENT

Ansible controller CentOS 7.5, RedHat 7.6
vSphere all 6.7

STEPS TO REPRODUCE

- name: 'Configure the vCenter settings'
  connection: 'local'
  vmware_vcenter_settings:
    hostname: '{{ ansible_host }}'
    username: '{{ ansible_vcenter_username }}'
    password: '{{ ansible_vcenter_password }}'
    snmp_receivers:
      snmp_receiver_1_url: "{{ snmp_destination }}"
      snmp_receiver_1_enabled: true
      snmp_receiver_1_port: 162
      snmp_receiver_1_community: "{{ snmp_string }}"
    logging_options: info
    validate_certs: '{{ validate_certs }}'

EXPECTED RESULTS

Only the options specified are configured

ACTUAL RESULTS

The full traceback is:
Traceback (most recent call last):
  File "/root/.ansible/tmp/ansible-tmp-1579533439.33-60520445339576/AnsiballZ_vmware_vcenter_settings.py", line 114, in <module>
    _ansiballz_main()
  File "/root/.ansible/tmp/ansible-tmp-1579533439.33-60520445339576/AnsiballZ_vmware_vcenter_settings.py", line 106, in _ansiballz_main
    invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)
  File "/root/.ansible/tmp/ansible-tmp-1579533439.33-60520445339576/AnsiballZ_vmware_vcenter_settings.py", line 49, in invoke_module
    imp.load_module('__main__', mod, module, MOD_DESC)
  File "/tmp/ansible_vmware_vcenter_settings_payload_GqX7zC/__main__.py", line 696, in <module>
  File "/tmp/ansible_vmware_vcenter_settings_payload_GqX7zC/__main__.py", line 692, in main
  File "/tmp/ansible_vmware_vcenter_settings_payload_GqX7zC/__main__.py", line 240, in ensure
AttributeError: 'NoneType' object has no attribute 'get'

fatal: [<VCENTER FQDN>]: FAILED! => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "module_stderr": "Traceback (most recent call last):\n  File \"/root/.ansible/tmp/ansible-tmp-1579533439.33-60520445339576/AnsiballZ_vmware_vcenter_settings.py\", line 114, in <module>\n    _ansiballz_main()\n  File \"/root/.ansible/tmp/ansible-tmp-1579533439.33-60520445339576/AnsiballZ_vmware_vcenter_settings.py\", line 106, in _ansiballz_main\n    invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)\n  File \"/root/.ansible/tmp/ansible-tmp-1579533439.33-60520445339576/AnsiballZ_vmware_vcenter_settings.py\", line 49, in invoke_module\n    imp.load_module('__main__', mod, module, MOD_DESC)\n  File \"/tmp/ansible_vmware_vcenter_settings_payload_GqX7zC/__main__.py\", line 696, in <module>\n  File \"/tmp/ansible_vmware_vcenter_settings_payload_GqX7zC/__main__.py\", line 692, in main\n  File \"/tmp/ansible_vmware_vcenter_settings_payload_GqX7zC/__main__.py\", line 240, in ensure\nAttributeError: 'NoneType' object has no attribute 'get'\n",
    "module_stdout": "",
    "msg": "MODULE FAILURE\nSee stdout/stderr for the exact error",
    "rc": 1

[ansibot]

Files identified in the description:

• lib/ansible/modules/cloud/vmware/vmware_vcenter_settings.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @Akasurde @Tomorrow9 @goneri @lparkes @pgbidkar @warthog9
click here for bot help

[ansibot]

@nicholasrodriguez, just so you are aware we have a dedicated Working Group for vmware.
You can find other people interested in this in #ansible-vmware on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

[sky-joker]

Hi @nicholasrodriguez
Could you try if this #67670 can solve this issue, please?

refer: https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html#adding-a-module-locally

[nicholasrodriguez]

Thanks @sky-joker and @goneri
I've installed the module locally and if I run the following

ansible-doc -t module vmware_vcenter_settings

I get the following error

ERROR! module vmware_vcenter_settings has a documentation error formatting or is missing documentation.

[nicholasrodriguez]

I've run with the module version in bdcaf4a using the following config

- name: 'Configure the vCenter settings'
  connection: 'local'
  vmware_vcenter_settings:
    hostname: '{{ ansible_host }}'
    username: '{{ ansible_vcenter_username }}'
    password: '{{ ansible_vcenter_password }}'
    snmp_receivers:
      snmp_receiver_1_url: "{{ snmp_destination }}"
      snmp_receiver_1_enabled: true
      snmp_receiver_1_port: 162
      snmp_receiver_1_community: "{{ snmp_string }}"
    logging_options: info
    validate_certs: '{{ validate_certs }}'

I get the following traceback

The full traceback is:
Traceback (most recent call last):
  File "/root/.ansible/tmp/ansible-tmp-1583426855.9080684-79788441564163/AnsiballZ_vmware_vcenter_settings.py", line 114, in <module>
    _ansiballz_main()
  File "/root/.ansible/tmp/ansible-tmp-1583426855.9080684-79788441564163/AnsiballZ_vmware_vcenter_settings.py", line 106, in _ansiballz_main
    invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)
  File "/root/.ansible/tmp/ansible-tmp-1583426855.9080684-79788441564163/AnsiballZ_vmware_vcenter_settings.py", line 49, in invoke_module
    imp.load_module('__main__', mod, module, MOD_DESC)
  File "/tmp/ansible_vmware_vcenter_settings_payload_cZWeEf/__main__.py", line 688, in <module>
  File "/tmp/ansible_vmware_vcenter_settings_payload_cZWeEf/__main__.py", line 684, in main
  File "/tmp/ansible_vmware_vcenter_settings_payload_cZWeEf/__main__.py", line 236, in ensure
AttributeError: 'NoneType' object has no attribute 'get'

fatal: [<VCENTER FQDN>]: FAILED! => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python"
    },
    "changed": false,
    "module_stderr": "Traceback (most recent call last):\n  File \"/root/.ansible/tmp/ansible-tmp-1583426855.9080684-79788441564163/AnsiballZ_vmware_vcenter_settings.py\", line 114, in <module>\n    _ansiballz_main()\n  File \"/root/.ansible/tmp/ansible-tmp-1583426855.9080684-79788441564163/AnsiballZ_vmware_vcenter_settings.py\", line 106, in _ansiballz_main\n    invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)\n  File \"/root/.ansible/tmp/ansible-tmp-1583426855.9080684-79788441564163/AnsiballZ_vmware_vcenter_settings.py\", line 49, in invoke_module\n    imp.load_module('__main__', mod, module, MOD_DESC)\n  File \"/tmp/ansible_vmware_vcenter_settings_payload_cZWeEf/__main__.py\", line 688, in <module>\n  File \"/tmp/ansible_vmware_vcenter_settings_payload_cZWeEf/__main__.py\", line 684, in main\n  File \"/tmp/ansible_vmware_vcenter_settings_payload_cZWeEf/__main__.py\", line 236, in ensure\nAttributeError: 'NoneType' object has no attribute 'get'\n",
    "module_stdout": "",
    "msg": "MODULE FAILURE\nSee stdout/stderr for the exact error",
    "rc": 1
}