x/python-cratonclient
Code Issues Proposed changes
python-cratonclient/doc/source/usage/devices.rst
Ian Cordasco 75c3531c43 Add user documentation for the Python API 
Most of the copy is duplicated except for the places where it matters.
This allows for any page of this documentation to be page one. If
someone only cares about using hosts first, they can go directly there
and start listing hosts, creating them, etc. without much other
prompting.

Change-Id: Id621947af5d4c3ca53af24904f5f16d3d88bc8b8
2017-03-17 12:57:17 -05:00

1.1 KiB
Raw Blame History

Using the Devices API

Here we will assume that we already have a ~cratonclient.client.Client instance configured with the appropriate authentication method (as demonstrated in usage-auth).

Note

The Devices API is quite unlike other API endpoints presently in craton. At the moment, it returns both hosts and network devices. It concatenates the two lists in an indeterminate manner. On one invocation, you may receive the hosts first and then the network devices, on another you may receive them in the alternate order. If more items are returned in these listings, then the number of different orderings will only increase factorially.

Listing Devices

The Devices API implements pagination. This means that by default, it does not return all devices known to Craton. To ignore page limits and offsets, we can allow cratonclient to do handle pagination for us:

for device in craton.devices.list():
    print_device_info(device)

By default ~cratonclient.v1.devices.DevicesManager.list will handle pagination for you.