known_hosts module fails to set values with spurious error message

[greg-hellings]

SUMMARY

The known_hosts module, when run in its default mode of adding entries to a file, fails with the error message "Host parameter does not match hashed host field in supplied key". This is not due to a problem with the key itself but rather in the way that the module writes the test file.

ISSUE TYPE

• Bug Report

COMPONENT NAME

known_hosts

ANSIBLE VERSION

ansible 2.6.1
  config file = /home/ghelling/.ansible.cfg
  configured module search path = [u'/home/ghelling/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/ghelling/venv/tools/lib/python2.7/site-packages/ansible
  executable location = /home/ghelling/venv/tools/bin/ansible
  python version = 2.7.15 (default, May 16 2018, 17:50:09) [GCC 8.1.1 20180502 (Red Hat 8.1.1-1)]

CONFIGURATION

ANSIBLE_PIPELINING(/home/ghelling/.ansible.cfg) = True
ANSIBLE_SSH_ARGS(/home/ghelling/.ansible.cfg) = -o ControlMaster=auto -o ControlPersist=600s -o Identiti>
ANSIBLE_SSH_CONTROL_PATH(/home/ghelling/.ansible.cfg) = %(directory)s/%%h-%%r
ANSIBLE_SSH_CONTROL_PATH_DIR(/home/ghelling/.ansible.cfg) = /tmp
DEFAULT_CALLBACK_WHITELIST(/home/ghelling/.ansible.cfg) = ['timer', 'profile_tasks']
DEFAULT_FORKS(/home/ghelling/.ansible.cfg) = 10
DEFAULT_STDOUT_CALLBACK(/home/ghelling/.ansible.cfg) = yaml
HOST_KEY_CHECKING(/home/ghelling/.ansible.cfg) = False

OS / ENVIRONMENT

N/A

EXPECTED RESULTS

Module properly sets a valid SSH pubkey

ACTUAL RESULTS

failed: [test-passwordless_ssh2] (item=test-passwordless_ssh2) => {"changed": false, "item": "test-passwordless_ssh2", "msg": "Host parameter does not match hashed host field in supplied key"}

[ansibot]

Files identified in the description:

• lib/ansible/modules/system/known_hosts.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 @mcv21
click here for bot help

[greg-hellings]

This appears to have been an issue with documentation being unclear. I've updated the docs in a way that seems to reflect the module's intention better. I also left in the test to the code that I had written, since more code testing is rarely a bad thing.

[mcv21]

I'm happy with the documentation suggested in the linked PR.