#xml-rpc #rpc-client #cli-client #case-sensitive #xapi #xen-api

bin+lib xapirpc

Minimal RPC client for communication with xapi

8 releases (5 breaking)

Uses old Rust 2015

0.9.0 Mar 1, 2018
0.8.2 Mar 1, 2018
0.8.1 Feb 25, 2018
0.5.0 Feb 19, 2018
0.2.0 Feb 15, 2018

#10 in #xml-rpc

27 downloads per month

Custom license

18KB
375 lines

xapirpc   Build Status Doc Badge Latest Version

Minimal library and CLI client for xapi rpc calls.


The crate provides a small CLI utility to make RPC calls to xapi, and exports a library that exposes some common helpers to create xapi clients (see the documentation on docs.rs). The CLI executable provides an example of use.

The output of the CLI tool is in json, so it can be piped to jq or other json tools for further filtering. For example you can get the uuid and name_label of all VMs with:

xapirpc VM get_all_records | jq '.[]|select(.is_a_template==false)|{uuid, name_label}'

There CLI help should clarify all the supported customisations.

$ xapirpc --help
Minimal xapi xmlrpc CLI client
USAGE:
    xapirpc [FLAGS] [OPTIONS] <class> <method> [args]...
FLAGS:
        --compact    Output the result as non-prettified json
        --help       Prints help information
    -V, --version    Prints version information
OPTIONS:
    -h, --host <host>    XenServer host. Can be passed with the XAPI_HOST env variable.
    -p, --pass <pass>    XenServer host user password. Can be passed with the XAPI_PASSWORD env variable.
    -u, --user <user>    XenServer host user name. Can be passed with the XAPI_USER env variable.
ARGS:
    <class>      Case sensitive value for the xapi class
    <method>     Case sensitive value for the xapi method
    <args>...    Ordered list of arguments for the call (if any). Do not pass a session.

The host, user, and pass value can be manually configured by creating

$HOME/.config/xapirpc/config.prefs.json

and adding them in a json object. E.g.

$ cat $HOME/.config/xapirpc/config.prefs.json
{"user":"my_user_name","pass":"my_pass"}

To try it, clone this repository and build with cargo build --release or install it using cargo install xapirpc --force.

Acknowledgements

Thanks:

  • @gaborigloi for porting the library to quicli
  • @Pistahh for fixing the jq example and comments on the code

Dependencies

~23–35MB
~600K SLoC