Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New module: xmlrpc_client #28297

Closed
wants to merge 3 commits into from
Closed

Conversation

stemid
Copy link
Contributor

@stemid stemid commented Aug 16, 2017

SUMMARY

It's the most basic xmlrpc API client that forwards any call to the API along with positional arguments and keyword arguments. This way the ansible user can decide how to use the xmlrpc api along with the relevant API docs.

ISSUE TYPE
  • New Module Pull Request
COMPONENT NAME

lib/ansible/modules/commands/xmlrpc_client

ANSIBLE VERSION
ansible 2.4.0 (xmlrpc_client-module 5224579d9e) last updated 2017/08/11 16:08:55 (GMT +200)
  config file = None
  configured module search path = ['/home/stemid/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/stemid/Utveckling/ansible/lib/ansible
  executable location = /home/stemid/Utveckling/ansible/bin/ansible
  python version = 3.6.2 (default, Jul 19 2017, 13:09:21) [GCC 7.1.1 20170622 (Red Hat 7.1.1-3)]

ADDITIONAL INFORMATION

I have an API internally where this module helps a lot because it lets me use ansible for the entire deployment process.

Looking at other ansible modules for xmlrpc APIs I can see that a basic xmlrpc client module would be able to perform their tasks as well but with less abstractions between the user and the API.

I wasn't sure which category to put the module in. I'm sure people will have issue with placing it under commands, in that case just know that I have no problem with moving it to another category if a more suitable one can be found.

I have run sanity checks and there is only one unresolved issue.

ERROR: lib/ansible/modules/commands/xmlrpc_client.py:0:0: E316 ANSIBLE_METADATA.metadata_version: not a valid value for dictionary value @ data['metadata_version']. Got '1.0'

The docs say to use 1.0 so I can't resolve that.

This module will become more useful once #23943 is resolved. Until then this use will not send integer to the backend API.

my_var: 2

- name: xmlrpc api call
  xmlrpc_client:
    args:
      - "{{my_var | int}}"

@MeganLiu
Copy link
Contributor

ANSIBLE_METADATA should be "1.1" (not 1.0 anymore)

@ansibot ansibot added affects_2.4 This issue/PR affects Ansible v2.4 community_review In order to be merged, this PR must follow the community review workflow. module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. new_module This PR includes a new module. new_plugin This PR includes a new plugin. support:community This issue/PR relates to code supported by the Ansible community. labels Aug 16, 2017
@jborean93 jborean93 removed the needs_triage Needs a first human triage before being processed. label Aug 17, 2017
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Aug 25, 2017
@resmo resmo self-requested a review November 5, 2017 11:36
@ansibot ansibot added the commands Commands category label Mar 5, 2019
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. support:core This issue/PR relates to code supported by the Ansible Engineering Team. and removed community_review In order to be merged, this PR must follow the community review workflow. support:community This issue/PR relates to code supported by the Ansible community. labels Apr 29, 2020
@Akasurde
Copy link
Member

Please submit a new module request to https://github.com/ansible-collections/community.general. Thanks for your contribution.

@Akasurde Akasurde closed this Aug 19, 2020
@ansible ansible locked and limited conversation to collaborators Sep 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.4 This issue/PR affects Ansible v2.4 commands Commands category core_review In order to be merged, this PR must follow the core review workflow. module This issue/PR relates to a module. new_module This PR includes a new module. new_plugin This PR includes a new plugin. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants