3ea83693fe
Adds CLI and python host deletion functionality as well as testing. Change-Id: I0cadd6f3681a5a09b58553aeb7ee8315e77e081f Implements: blueprint craton-client-access-inventory (partial) Closes-Bug: #1607851
227 lines
8.6 KiB
Python
227 lines
8.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# 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 cratonclient.common import cliutils
|
|
from cratonclient import exceptions as exc
|
|
from cratonclient.v1.hosts import HOST_FIELDS as h_fields
|
|
|
|
|
|
@cliutils.arg('region',
|
|
metavar='<region>',
|
|
type=int,
|
|
help='ID of the region that the host belongs to.')
|
|
@cliutils.arg('id',
|
|
metavar='<host>',
|
|
type=int,
|
|
help='ID of the host.')
|
|
def do_host_show(cc, args):
|
|
"""Show detailed information about a host."""
|
|
host = cc.inventory(args.region).hosts.get(args.id)
|
|
data = {f: getattr(host, f, '') for f in h_fields}
|
|
cliutils.print_dict(data, wrap=72)
|
|
|
|
|
|
@cliutils.arg('-r', '--region',
|
|
metavar='<region>',
|
|
type=int,
|
|
required=True,
|
|
help='ID of the region that the host belongs to.')
|
|
@cliutils.arg('-c', '--cell',
|
|
metavar='<cell>',
|
|
type=int,
|
|
help='Integer ID of the cell that contains '
|
|
'the desired list of hosts.')
|
|
@cliutils.arg('--detail',
|
|
action='store_true',
|
|
default=False,
|
|
help='Show detailed information about the hosts.')
|
|
@cliutils.arg('--limit',
|
|
metavar='<limit>',
|
|
type=int,
|
|
help='Maximum number of hosts to return.')
|
|
@cliutils.arg('--sort-key',
|
|
metavar='<field>',
|
|
help='Host field that will be used for sorting.')
|
|
@cliutils.arg('--sort-dir',
|
|
metavar='<direction>',
|
|
default='asc',
|
|
help='Sort direction: "asc" (default) or "desc".')
|
|
@cliutils.arg('--fields',
|
|
nargs='+',
|
|
metavar='<fields>',
|
|
default=[],
|
|
help='Comma-separated list of fields to display. '
|
|
'Only these fields will be fetched from the server. '
|
|
'Can not be used when "--detail" is specified')
|
|
def do_host_list(cc, args):
|
|
"""Print list of hosts which are registered with the Craton service."""
|
|
params = {}
|
|
default_fields = ['id', 'name', 'device_type', 'active', 'cell_id']
|
|
if args.cell is not None:
|
|
params['cell_id'] = args.cell
|
|
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.detail:
|
|
fields = h_fields
|
|
params['detail'] = args.detail
|
|
elif args.fields:
|
|
fields = {x: h_fields[x] for x in args.fields}
|
|
else:
|
|
fields = {x: h_fields[x] for x in default_fields}
|
|
if args.sort_key is not None:
|
|
fields_map = dict(zip(fields.keys(), fields.keys()))
|
|
# TODO(cmspence): Do we want to allow sorting by field heading value?
|
|
try:
|
|
sort_key = fields_map[args.sort_key]
|
|
except KeyError:
|
|
raise exc.CommandError(
|
|
'{0} is an invalid key for sorting, valid values for '
|
|
'--sort-key are: {1}'.format(args.sort_key, h_fields.keys())
|
|
)
|
|
params['sort_key'] = sort_key
|
|
if args.sort_dir is not None:
|
|
if args.sort_dir not in ('asc', 'desc'):
|
|
raise exc.CommandError('Invalid sort direction specified. The '
|
|
'expected valid values for --sort-dir '
|
|
'are: "asc", "desc".')
|
|
params['sort_dir'] = args.sort_dir
|
|
|
|
hosts = cc.inventory(args.region).hosts.list(**params)
|
|
cliutils.print_list(hosts, list(fields))
|
|
|
|
|
|
@cliutils.arg('-n', '--name',
|
|
metavar='<name>',
|
|
required=True,
|
|
help='Name of the host.')
|
|
@cliutils.arg('-i', '--ip_address',
|
|
metavar='<ipaddress>',
|
|
required=True,
|
|
help='IP Address of the host.')
|
|
@cliutils.arg('-p', '--project',
|
|
dest='project_id',
|
|
metavar='<project>',
|
|
type=int,
|
|
required=True,
|
|
help='ID of the project that the host belongs to.')
|
|
@cliutils.arg('-r', '--region',
|
|
dest='region_id',
|
|
metavar='<region>',
|
|
type=int,
|
|
required=True,
|
|
help='ID of the region that the host belongs to.')
|
|
@cliutils.arg('-c', '--cell',
|
|
dest='cell_id',
|
|
metavar='<cell>',
|
|
type=int,
|
|
help='ID of the cell that the host belongs to.')
|
|
@cliutils.arg('-t', '--type',
|
|
dest='device_type',
|
|
metavar='<type>',
|
|
required=True,
|
|
help='Type of the host.')
|
|
@cliutils.arg('-a', '--active',
|
|
default=True,
|
|
help='Status of the host. Active or inactive.')
|
|
@cliutils.arg('--note',
|
|
help='Note about the host.')
|
|
@cliutils.arg('--access_secret',
|
|
type=int,
|
|
dest='access_secret_id',
|
|
metavar='<access_secret>',
|
|
help='ID of the access secret of the host.')
|
|
@cliutils.arg('-l', '--labels',
|
|
default=[],
|
|
help='List of labels for the host.')
|
|
def do_host_create(cc, args):
|
|
"""Register a new host with the Craton service."""
|
|
fields = {k: v for (k, v) in vars(args).items()
|
|
if k in h_fields and not (v is None)}
|
|
host = cc.inventory(args.region_id).hosts.create(**fields)
|
|
data = {f: getattr(host, f, '') for f in h_fields}
|
|
cliutils.print_dict(data, wrap=72)
|
|
|
|
|
|
@cliutils.arg('region',
|
|
metavar='<region>',
|
|
type=int,
|
|
help='Current ID of the region that the host belongs to.')
|
|
@cliutils.arg('id',
|
|
metavar='<host>',
|
|
type=int,
|
|
help='ID of the host.')
|
|
@cliutils.arg('-n', '--name',
|
|
metavar='<name>',
|
|
help='Name of the host.')
|
|
@cliutils.arg('-i', '--ip_address',
|
|
metavar='<ipaddress>',
|
|
help='IP Address of the host.')
|
|
@cliutils.arg('-p', '--project',
|
|
dest='project_id',
|
|
metavar='<project>',
|
|
type=int,
|
|
help='Desired ID of the project that the host should change to.')
|
|
@cliutils.arg('-r', '--region',
|
|
dest='region_id',
|
|
metavar='<region>',
|
|
type=int,
|
|
help='Desired ID of the region that the host should change to.')
|
|
@cliutils.arg('-c', '--cell',
|
|
dest='cell_id',
|
|
metavar='<cell>',
|
|
type=int,
|
|
help='ID of the cell that the host belongs to.')
|
|
@cliutils.arg('-a', '--active',
|
|
default=True,
|
|
help='Status of the host. Active or inactive.')
|
|
@cliutils.arg('-t', '--type',
|
|
help='Type of the host.')
|
|
@cliutils.arg('--note',
|
|
help='Note about the host.')
|
|
@cliutils.arg('--access_secret',
|
|
dest='access_secret_id',
|
|
metavar='<access_secret>',
|
|
type=int,
|
|
help='ID of the access secret of the host.')
|
|
@cliutils.arg('-l', '--labels',
|
|
default=[],
|
|
help='List of labels for the host.')
|
|
def do_host_update(cc, args):
|
|
"""Update a host that is registered with the Craton service."""
|
|
fields = {k: v for (k, v) in vars(args).items()
|
|
if k in h_fields and not (v is None)}
|
|
host = cc.inventory(args.region).hosts.update(**fields)
|
|
print("Host {0} has been successfully update.".format(host.id))
|
|
data = {f: getattr(host, f, '') for f in h_fields}
|
|
cliutils.print_dict(data, wrap=72)
|
|
|
|
|
|
@cliutils.arg('region',
|
|
metavar='<region>',
|
|
type=int,
|
|
help='ID of the region that the host belongs to.')
|
|
@cliutils.arg('id',
|
|
metavar='<host>',
|
|
type=int,
|
|
help='ID of the host.')
|
|
def do_host_delete(cc, args):
|
|
"""Delete a host that is registered with the Craton service."""
|
|
response = cc.inventory(args.region).hosts.delete(args.id)
|
|
print("Host {0} was {1}successfully deleted.".
|
|
format(args.id, '' if response else 'un'))
|