Client library for surveil API.
c479625dc2
This commit was bulk generated and pushed by the OpenDev sysadmins as a part of the Git hosting and code review systems migration detailed in these mailing list posts: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html Attempts have been made to correct repository namespaces and hostnames based on simple pattern matching, but it's possible some were updated incorrectly or missed entirely. Please reach out to us via the contact information listed at https://opendev.org/ with any questions you may have. |
||
|---|---|---|
| doc | ||
| surveilclient | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| .testr.conf | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
Python bindings to the Surveil API
This is a client library for Surveil built on the Surveil API.
Command-line API
Installing this package gets you a shell command,
surveil, that you can use to interact with the Surveil
API.
You'll need to provide the Surveil API URL. You can do this with the
--surveil-api-url parameter, but it's easier to just set it
as environment variable:
export SURVEIL_API_URL=http://localhost:5311/v2
export SURVEIL_AUTH_URL=http://localhost:5311/v2/authYou'll find complete documentation on the shell by running
surveil help.
Bash completion
Basic command tab completion can be enabled by sourcing the bash completion script:
source /usr/local/share/surveil.bash_completionPython API
To use the python API, simply create a client with the endpoint:
from surveilclient import client
c = client.Client('http://localhost:5311/v2',
auth_url='http://localhost:5311/v2/auth',
version='2_0')
hosts = c.config.hosts.list()How to use it
Config-host-update:
surveil config-host-update --host_name [host_name] --address [ADDRESS] --custom_fields '{"_field1": "value1", "_field2": "value2"}'