mirror of https://github.com/ansible/ansible.git
Example incorrect: server_url is required argument (#63670)
##### SUMMARY
The example "Delete GitLab Group" does not work.
- name: "Delete GitLab Group"
gitlab_group:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
name: my_first_group
state: absent
It errors with:
fatal: [myhost.mydomain.com -> localhost]: FAILED! => {"changed": false, "msg": "missing required arguments: server_url"}
If you provide server_url and api_url, it complains that they are mutually exclusive:
fatal: [myhost.mydomain.com -> localhost]: FAILED! => {"changed": false, "msg": "parameters are mutually exclusive: api_url|server_url"}
This means there is no logical path in the use of the module where api_url can be specified without resulting in at least one of these fatal errors. I suggest adjusting the examples in the meantime, then changing the module to move away from the soon-to-be deprecated server_url parameter, removing it as a required argument.
This likely applies to all Examples, so this change proposes at least putting in the required parameter in the examples.
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
pull/63679/head
parent
2ef4ac1404
commit
b02467961a
Loading…
Reference in New Issue