239bfd30c6
This commit adds a new command, 'craton device-list', to support the
endpoint /v1/devices. Currently the endpoint only supports GET requests.
The command supports filtering by cloud, cell, region, parent and active
status. In addition, where a parent is specified, it is also possible to
request descendants.
The API response body is of the form:
{
"devices: {
"hosts": [
],
"network-devices": [
],
},
"links": [
],
}
This object differs, from the other response bodies that return
collections, in that devices is not an array but is instead an object
whose values are arrays. This difference has necessitated modifying the
list and pagination functionality to support nested data.
Change-Id: I7cdec9935a360dae3910802f210ab9341ef7a696
Closes-bug: 1668705
123 lines
4.6 KiB
Python
123 lines
4.6 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
# use this file except in compliance with the License. You may obtain a copy
|
|
# of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Hosts resource and resource shell wrapper."""
|
|
from __future__ import print_function
|
|
|
|
from cratonclient.common import cliutils
|
|
from cratonclient import exceptions as exc
|
|
from cratonclient.v1 import devices
|
|
|
|
|
|
@cliutils.arg('--fields',
|
|
nargs='+',
|
|
metavar='<fields>',
|
|
default=[],
|
|
help='Space-separated list of fields to display. '
|
|
'Only these fields will be fetched from the server.')
|
|
@cliutils.arg('--all',
|
|
action='store_true',
|
|
default=False,
|
|
help='Retrieve and show all devices. This will override '
|
|
'the provided value for --limit and automatically '
|
|
'retrieve each page of results.')
|
|
@cliutils.arg('--sort-key',
|
|
metavar='<field>',
|
|
help='Device field that will be used for sorting.')
|
|
@cliutils.arg('--sort-dir',
|
|
metavar='<direction>',
|
|
default='asc',
|
|
choices=('asc', 'desc'),
|
|
help='Sort direction: "asc" (default) or "desc".')
|
|
@cliutils.arg('--limit',
|
|
metavar='<limit>',
|
|
type=int,
|
|
help='Maximum number of devices to return.')
|
|
@cliutils.arg('--marker',
|
|
metavar='<marker>',
|
|
default=None,
|
|
help='ID of the device to use to resume listing devices.')
|
|
@cliutils.arg('--cloud',
|
|
metavar='<cloud>',
|
|
type=int,
|
|
help='ID of the cloud that the device belongs to.')
|
|
@cliutils.arg('-r', '--region',
|
|
metavar='<region>',
|
|
type=int,
|
|
help='ID of the region that the device belongs to.')
|
|
@cliutils.arg('-c', '--cell',
|
|
metavar='<cell>',
|
|
type=int,
|
|
help='Integer ID of the cell that contains '
|
|
'the desired list of devices.')
|
|
@cliutils.arg('--parent',
|
|
metavar='<parent>',
|
|
type=int,
|
|
help='Parent ID of required devices.')
|
|
@cliutils.arg('--descendants',
|
|
default=False,
|
|
action='store_true',
|
|
help='When parent is also specified, include all descendants.')
|
|
@cliutils.arg('--active',
|
|
metavar='<active>',
|
|
choices=("true", "false"),
|
|
help='Filter devices by their active state.')
|
|
def do_device_list(cc, args):
|
|
"""List all devices."""
|
|
params = {}
|
|
default_fields = [
|
|
'cloud_id', 'region_id', 'cell_id', 'parent_id', 'id', 'name',
|
|
'device_type', 'active',
|
|
]
|
|
if args.limit is not None:
|
|
if args.limit < 0:
|
|
raise exc.CommandError('Invalid limit specified. Expected '
|
|
'non-negative limit, got {0}'
|
|
.format(args.limit))
|
|
params['limit'] = args.limit
|
|
if args.all is True:
|
|
params['limit'] = 100
|
|
|
|
if args.fields:
|
|
try:
|
|
fields = {x: devices.DEVICE_FIELDS[x] for x in args.fields}
|
|
except KeyError as err:
|
|
raise exc.CommandError('Invalid field "{}"'.format(err.args[0]))
|
|
else:
|
|
fields = default_fields
|
|
sort_key = args.sort_key and args.sort_key.lower()
|
|
if sort_key is not None:
|
|
if sort_key not in devices.DEVICE_FIELDS:
|
|
raise exc.CommandError(
|
|
'{0} is an invalid key for sorting, valid values for '
|
|
'--sort-key are: {1}'.format(
|
|
args.sort_key, devices.DEVICE_FIELDS.keys()
|
|
)
|
|
)
|
|
params['sort_keys'] = sort_key
|
|
params['sort_dir'] = args.sort_dir
|
|
params['marker'] = args.marker
|
|
params['autopaginate'] = args.all
|
|
if args.parent:
|
|
params['parent_id'] = args.parent
|
|
params['descendants'] = args.descendants
|
|
if args.cloud:
|
|
params['cloud_id'] = args.cloud
|
|
if args.region:
|
|
params['region_id'] = args.region
|
|
if args.cell:
|
|
params['cell_id'] = args.cell
|
|
if args.active:
|
|
params['active'] = args.active
|
|
|
|
devices_list = cc.devices.list(**params)
|
|
args.formatter.configure(fields=list(fields)).handle(devices_list)
|