Ruby Loo 1ce8722e04 Add driver-properties command
Add 'driver-properties <driver_name>' command. This returns a table
listing the properties of the specified driver, including name
and description.

Eg:
$ ironic driver-properties pxe_ipmitool
+--------------------+----------------------------------------------+
| Property           | Description                                  |
+--------------------+----------------------------------------------+
| ipmi_address       | IP address or hostname of the node. Required.|
| ipmi_password      | password. Optional.                          |
| ipmi_priv_level    | privilege level; default is ... Optional.    |
| ipmi_terminal_port | node's UDP port ... required for console...  |
| ipmi_username      | username; default is NULL user. Optional.    |
| pxe_deploy_kernel  | UUID (from Glance) of the deployment...      |
| pxe_deploy_ramdisk | UUID (from Glance) of the ramdisk...         |
+--------------------+----------------------------------------------+

If this feature is not available in Ironic, it returns
"Not Found (HTTP 404)".

If driver_name doesn't exist, it returns "The driver '<driver-name>' is
unknown. (HTTP 404)".

Change-Id: Id125fe4c1771dc5bb5b57d528940f2ba1c85866a
Blueprint: get-required-driver-info
2014-07-23 21:02:36 +00:00

86 lines
2.9 KiB
Python

# -*- coding: utf-8 -*-
#
# Copyright 2013 Red Hat, Inc.
# All Rights Reserved.
#
# 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.
from ironicclient.common import utils
from ironicclient.openstack.common import cliutils
def _print_driver_show(driver):
fields = ['name', 'hosts']
data = dict([(f, getattr(driver, f, '')) for f in fields])
cliutils.print_dict(data, wrap=72)
def do_driver_list(cc, args):
"""List drivers."""
drivers = cc.driver.list()
# NOTE(lucasagomes): Separate each host by a comma.
# It's easier to read.
for d in drivers:
d.hosts = ', '.join(d.hosts)
field_labels = ['Supported driver(s)', 'Active host(s)']
fields = ['name', 'hosts']
cliutils.print_list(drivers, fields, field_labels)
@cliutils.arg('driver_name', metavar='<driver_name>',
help='Name of the driver')
def do_driver_show(cc, args):
"""Show a driver."""
driver = cc.driver.get(args.driver_name)
_print_driver_show(driver)
@cliutils.arg('driver_name', metavar='<driver name>',
help="name of a driver")
def do_driver_properties(cc, args):
"""Get properties of the driver."""
properties = cc.driver.properties(args.driver_name)
obj_list = []
for key, value in properties.iteritems():
data = {'Property': key, 'Description': value}
obj_list.append(type('iface', (object,), data))
fields = ['Property', 'Description']
cliutils.print_list(obj_list, fields, mixed_case_fields=fields)
@cliutils.arg('driver_name',
metavar='<driver_name>',
help='Name of the driver')
@cliutils.arg('method',
metavar='<method>',
help="vendor-passthru method to be called")
@cliutils.arg('arguments',
metavar='<arg=value>',
nargs='*',
action='append',
default=[],
help="arguments to be passed to vendor-passthru method")
def do_driver_vendor_passthru(cc, args):
"""Call a vendor-passthru extension for a driver."""
fields = {}
fields['driver_name'] = args.driver_name
fields['method'] = args.method
fields['args'] = args.arguments[0]
fields = utils.args_array_to_dict(fields, 'args')
# If there were no arguments for the method, fields['args'] will still
# be an empty list. So make it an empty dict.
if not fields['args']:
fields['args'] = {}
cc.driver.vendor_passthru(**fields)