diff options
Diffstat (limited to 'neutronclient/shell.py')
| -rw-r--r-- | neutronclient/shell.py | 575 |
1 files changed, 575 insertions, 0 deletions
diff --git a/neutronclient/shell.py b/neutronclient/shell.py new file mode 100644 index 0000000..8cc6441 --- /dev/null +++ b/neutronclient/shell.py @@ -0,0 +1,575 @@ +# Copyright 2012 OpenStack LLC. +# 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. +# +# vim: tabstop=4 shiftwidth=4 softtabstop=4 + +""" +Command-line interface to the Neutron APIs +""" + +import argparse +import logging +import os +import sys + +from cliff import app +from cliff import commandmanager + +from neutronclient.common import clientmanager +from neutronclient.common import exceptions as exc +from neutronclient.common import utils +from neutronclient.neutron.v2_0 import agent +from neutronclient.neutron.v2_0 import agentscheduler +from neutronclient.neutron.v2_0 import extension +from neutronclient.neutron.v2_0 import floatingip +from neutronclient.neutron.v2_0.lb import healthmonitor as lb_healthmonitor +from neutronclient.neutron.v2_0.lb import member as lb_member +from neutronclient.neutron.v2_0.lb import pool as lb_pool +from neutronclient.neutron.v2_0.lb import vip as lb_vip +from neutronclient.neutron.v2_0 import network +from neutronclient.neutron.v2_0 import nvp_qos_queue +from neutronclient.neutron.v2_0 import nvpnetworkgateway +from neutronclient.neutron.v2_0 import port +from neutronclient.neutron.v2_0 import quota +from neutronclient.neutron.v2_0 import router +from neutronclient.neutron.v2_0 import securitygroup +from neutronclient.neutron.v2_0 import subnet +from neutronclient.openstack.common import strutils +from neutronclient.version import __version__ + + +VERSION = '2.0' +NEUTRON_API_VERSION = '2.0' + + +def run_command(cmd, cmd_parser, sub_argv): + _argv = sub_argv + index = -1 + values_specs = [] + if '--' in sub_argv: + index = sub_argv.index('--') + _argv = sub_argv[:index] + values_specs = sub_argv[index:] + known_args, _values_specs = cmd_parser.parse_known_args(_argv) + cmd.values_specs = (index == -1 and _values_specs or values_specs) + return cmd.run(known_args) + + +def env(*_vars, **kwargs): + """Search for the first defined of possibly many env vars + + Returns the first environment variable defined in vars, or + returns the default defined in kwargs. + + """ + for v in _vars: + value = os.environ.get(v, None) + if value: + return value + return kwargs.get('default', '') + + +COMMAND_V2 = { + 'net-list': network.ListNetwork, + 'net-external-list': network.ListExternalNetwork, + 'net-show': network.ShowNetwork, + 'net-create': network.CreateNetwork, + 'net-delete': network.DeleteNetwork, + 'net-update': network.UpdateNetwork, + 'subnet-list': subnet.ListSubnet, + 'subnet-show': subnet.ShowSubnet, + 'subnet-create': subnet.CreateSubnet, + 'subnet-delete': subnet.DeleteSubnet, + 'subnet-update': subnet.UpdateSubnet, + 'port-list': port.ListPort, + 'port-show': port.ShowPort, + 'port-create': port.CreatePort, + 'port-delete': port.DeletePort, + 'port-update': port.UpdatePort, + 'quota-list': quota.ListQuota, + 'quota-show': quota.ShowQuota, + 'quota-delete': quota.DeleteQuota, + 'quota-update': quota.UpdateQuota, + 'ext-list': extension.ListExt, + 'ext-show': extension.ShowExt, + 'router-list': router.ListRouter, + 'router-port-list': port.ListRouterPort, + 'router-show': router.ShowRouter, + 'router-create': router.CreateRouter, + 'router-delete': router.DeleteRouter, + 'router-update': router.UpdateRouter, + 'router-interface-add': router.AddInterfaceRouter, + 'router-interface-delete': router.RemoveInterfaceRouter, + 'router-gateway-set': router.SetGatewayRouter, + 'router-gateway-clear': router.RemoveGatewayRouter, + 'floatingip-list': floatingip.ListFloatingIP, + 'floatingip-show': floatingip.ShowFloatingIP, + 'floatingip-create': floatingip.CreateFloatingIP, + 'floatingip-delete': floatingip.DeleteFloatingIP, + 'floatingip-associate': floatingip.AssociateFloatingIP, + 'floatingip-disassociate': floatingip.DisassociateFloatingIP, + 'security-group-list': securitygroup.ListSecurityGroup, + 'security-group-show': securitygroup.ShowSecurityGroup, + 'security-group-create': securitygroup.CreateSecurityGroup, + 'security-group-delete': securitygroup.DeleteSecurityGroup, + 'security-group-update': securitygroup.UpdateSecurityGroup, + 'security-group-rule-list': securitygroup.ListSecurityGroupRule, + 'security-group-rule-show': securitygroup.ShowSecurityGroupRule, + 'security-group-rule-create': securitygroup.CreateSecurityGroupRule, + 'security-group-rule-delete': securitygroup.DeleteSecurityGroupRule, + 'lb-vip-list': lb_vip.ListVip, + 'lb-vip-show': lb_vip.ShowVip, + 'lb-vip-create': lb_vip.CreateVip, + 'lb-vip-update': lb_vip.UpdateVip, + 'lb-vip-delete': lb_vip.DeleteVip, + 'lb-pool-list': lb_pool.ListPool, + 'lb-pool-show': lb_pool.ShowPool, + 'lb-pool-create': lb_pool.CreatePool, + 'lb-pool-update': lb_pool.UpdatePool, + 'lb-pool-delete': lb_pool.DeletePool, + 'lb-pool-stats': lb_pool.RetrievePoolStats, + 'lb-member-list': lb_member.ListMember, + 'lb-member-show': lb_member.ShowMember, + 'lb-member-create': lb_member.CreateMember, + 'lb-member-update': lb_member.UpdateMember, + 'lb-member-delete': lb_member.DeleteMember, + 'lb-healthmonitor-list': lb_healthmonitor.ListHealthMonitor, + 'lb-healthmonitor-show': lb_healthmonitor.ShowHealthMonitor, + 'lb-healthmonitor-create': lb_healthmonitor.CreateHealthMonitor, + 'lb-healthmonitor-update': lb_healthmonitor.UpdateHealthMonitor, + 'lb-healthmonitor-delete': lb_healthmonitor.DeleteHealthMonitor, + 'lb-healthmonitor-associate': lb_healthmonitor.AssociateHealthMonitor, + 'lb-healthmonitor-disassociate': ( + lb_healthmonitor.DisassociateHealthMonitor + ), + 'queue-create': nvp_qos_queue.CreateQoSQueue, + 'queue-delete': nvp_qos_queue.DeleteQoSQueue, + 'queue-show': nvp_qos_queue.ShowQoSQueue, + 'queue-list': nvp_qos_queue.ListQoSQueue, + 'agent-list': agent.ListAgent, + 'agent-show': agent.ShowAgent, + 'agent-delete': agent.DeleteAgent, + 'agent-update': agent.UpdateAgent, + 'net-gateway-create': nvpnetworkgateway.CreateNetworkGateway, + 'net-gateway-update': nvpnetworkgateway.UpdateNetworkGateway, + 'net-gateway-delete': nvpnetworkgateway.DeleteNetworkGateway, + 'net-gateway-show': nvpnetworkgateway.ShowNetworkGateway, + 'net-gateway-list': nvpnetworkgateway.ListNetworkGateway, + 'net-gateway-connect': nvpnetworkgateway.ConnectNetworkGateway, + 'net-gateway-disconnect': nvpnetworkgateway.DisconnectNetworkGateway, + 'dhcp-agent-network-add': agentscheduler.AddNetworkToDhcpAgent, + 'dhcp-agent-network-remove': agentscheduler.RemoveNetworkFromDhcpAgent, + 'net-list-on-dhcp-agent': agentscheduler.ListNetworksOnDhcpAgent, + 'dhcp-agent-list-hosting-net': agentscheduler.ListDhcpAgentsHostingNetwork, + 'l3-agent-router-add': agentscheduler.AddRouterToL3Agent, + 'l3-agent-router-remove': agentscheduler.RemoveRouterFromL3Agent, + 'router-list-on-l3-agent': agentscheduler.ListRoutersOnL3Agent, + 'l3-agent-list-hosting-router': agentscheduler.ListL3AgentsHostingRouter, +} + +COMMANDS = {'2.0': COMMAND_V2} + + +class HelpAction(argparse.Action): + """Provide a custom action so the -h and --help options + to the main app will print a list of the commands. + + The commands are determined by checking the CommandManager + instance, passed in as the "default" value for the action. + """ + def __call__(self, parser, namespace, values, option_string=None): + outputs = [] + max_len = 0 + app = self.default + parser.print_help(app.stdout) + app.stdout.write('\nCommands for API v%s:\n' % app.api_version) + command_manager = app.command_manager + for name, ep in sorted(command_manager): + factory = ep.load() + cmd = factory(self, None) + one_liner = cmd.get_description().split('\n')[0] + outputs.append((name, one_liner)) + max_len = max(len(name), max_len) + for (name, one_liner) in outputs: + app.stdout.write(' %s %s\n' % (name.ljust(max_len), one_liner)) + sys.exit(0) + + +class NeutronShell(app.App): + + CONSOLE_MESSAGE_FORMAT = '%(message)s' + DEBUG_MESSAGE_FORMAT = '%(levelname)s: %(name)s %(message)s' + log = logging.getLogger(__name__) + + def __init__(self, apiversion): + super(NeutronShell, self).__init__( + description=__doc__.strip(), + version=VERSION, + command_manager=commandmanager.CommandManager('neutron.cli'), ) + self.commands = COMMANDS + for k, v in self.commands[apiversion].items(): + self.command_manager.add_command(k, v) + + # This is instantiated in initialize_app() only when using + # password flow auth + self.auth_client = None + self.api_version = apiversion + + def build_option_parser(self, description, version): + """Return an argparse option parser for this application. + + Subclasses may override this method to extend + the parser with more global options. + + :param description: full description of the application + :paramtype description: str + :param version: version number for the application + :paramtype version: str + """ + parser = argparse.ArgumentParser( + description=description, + add_help=False, ) + parser.add_argument( + '--version', + action='version', + version=__version__, ) + parser.add_argument( + '-v', '--verbose', + action='count', + dest='verbose_level', + default=self.DEFAULT_VERBOSE_LEVEL, + help='Increase verbosity of output. Can be repeated.', ) + parser.add_argument( + '-q', '--quiet', + action='store_const', + dest='verbose_level', + const=0, + help='suppress output except warnings and errors', ) + parser.add_argument( + '-h', '--help', + action=HelpAction, + nargs=0, + default=self, # tricky + help="show this help message and exit", ) + parser.add_argument( + '--debug', + default=False, + action='store_true', + help='show tracebacks on errors', ) + # Global arguments + parser.add_argument( + '--os-auth-strategy', metavar='<auth-strategy>', + default=env('OS_AUTH_STRATEGY', default='keystone'), + help='Authentication strategy (Env: OS_AUTH_STRATEGY' + ', default keystone). For now, any other value will' + ' disable the authentication') + parser.add_argument( + '--os_auth_strategy', + help=argparse.SUPPRESS) + + parser.add_argument( + '--os-auth-url', metavar='<auth-url>', + default=env('OS_AUTH_URL'), + help='Authentication URL (Env: OS_AUTH_URL)') + parser.add_argument( + '--os_auth_url', + help=argparse.SUPPRESS) + + parser.add_argument( + '--os-tenant-name', metavar='<auth-tenant-name>', + default=env('OS_TENANT_NAME'), + help='Authentication tenant name (Env: OS_TENANT_NAME)') + parser.add_argument( + '--os_tenant_name', + help=argparse.SUPPRESS) + + parser.add_argument( + '--os-username', metavar='<auth-username>', + default=utils.env('OS_USERNAME'), + help='Authentication username (Env: OS_USERNAME)') + parser.add_argument( + '--os_username', + help=argparse.SUPPRESS) + + parser.add_argument( + '--os-password', metavar='<auth-password>', + default=utils.env('OS_PASSWORD'), + help='Authentication password (Env: OS_PASSWORD)') + parser.add_argument( + '--os_password', + help=argparse.SUPPRESS) + + parser.add_argument( + '--os-region-name', metavar='<auth-region-name>', + default=env('OS_REGION_NAME'), + help='Authentication region name (Env: OS_REGION_NAME)') + parser.add_argument( + '--os_region_name', + help=argparse.SUPPRESS) + + parser.add_argument( + '--os-token', metavar='<token>', + default=env('OS_TOKEN'), + help='Defaults to env[OS_TOKEN]') + parser.add_argument( + '--os_token', + help=argparse.SUPPRESS) + + parser.add_argument( + '--endpoint-type', metavar='<endpoint-type>', + default=env('OS_ENDPOINT_TYPE', default='publicURL'), + help='Defaults to env[OS_ENDPOINT_TYPE] or publicURL.') + + parser.add_argument( + '--os-url', metavar='<url>', + default=env('OS_URL'), + help='Defaults to env[OS_URL]') + parser.add_argument( + '--os_url', + help=argparse.SUPPRESS) + + parser.add_argument( + '--insecure', + action='store_true', + default=env('NEUTRONCLIENT_INSECURE', default=False), + help="Explicitly allow neutronclient to perform \"insecure\" " + "SSL (https) requests. The server's certificate will " + "not be verified against any certificate authorities. " + "This option should be used with caution.") + + return parser + + def _bash_completion(self): + """Prints all of the commands and options for bash-completion.""" + commands = set() + options = set() + for option, _action in self.parser._option_string_actions.items(): + options.add(option) + for command_name, command in self.command_manager: + commands.add(command_name) + cmd_factory = command.load() + cmd = cmd_factory(self, None) + cmd_parser = cmd.get_parser('') + for option, _action in cmd_parser._option_string_actions.items(): + options.add(option) + print ' '.join(commands | options) + + def run(self, argv): + """Equivalent to the main program for the application. + + :param argv: input arguments and options + :paramtype argv: list of str + """ + try: + index = 0 + command_pos = -1 + help_pos = -1 + help_command_pos = -1 + for arg in argv: + if arg == 'bash-completion': + self._bash_completion() + return 0 + if arg in self.commands[self.api_version]: + if command_pos == -1: + command_pos = index + elif arg in ('-h', '--help'): + if help_pos == -1: + help_pos = index + elif arg == 'help': + if help_command_pos == -1: + help_command_pos = index + index = index + 1 + if command_pos > -1 and help_pos > command_pos: + argv = ['help', argv[command_pos]] + if help_command_pos > -1 and command_pos == -1: + argv[help_command_pos] = '--help' + self.options, remainder = self.parser.parse_known_args(argv) + self.configure_logging() + self.interactive_mode = not remainder + self.initialize_app(remainder) + except Exception as err: + if self.options.debug: + self.log.exception(unicode(err)) + raise + else: + self.log.error(unicode(err)) + return 1 + result = 1 + if self.interactive_mode: + _argv = [sys.argv[0]] + sys.argv = _argv + result = self.interact() + else: + result = self.run_subcommand(remainder) + return result + + def run_subcommand(self, argv): + subcommand = self.command_manager.find_command(argv) + cmd_factory, cmd_name, sub_argv = subcommand + cmd = cmd_factory(self, self.options) + err = None + result = 1 + try: + self.prepare_to_run_command(cmd) + full_name = (cmd_name + if self.interactive_mode + else ' '.join([self.NAME, cmd_name]) + ) + cmd_parser = cmd.get_parser(full_name) + return run_command(cmd, cmd_parser, sub_argv) + except Exception as err: + if self.options.debug: + self.log.exception(unicode(err)) + else: + self.log.error(unicode(err)) + try: + self.clean_up(cmd, result, err) + except Exception as err2: + if self.options.debug: + self.log.exception(unicode(err2)) + else: + self.log.error('Could not clean up: %s', unicode(err2)) + if self.options.debug: + raise + else: + try: + self.clean_up(cmd, result, None) + except Exception as err3: + if self.options.debug: + self.log.exception(unicode(err3)) + else: + self.log.error('Could not clean up: %s', unicode(err3)) + return result + + def authenticate_user(self): + """Make sure the user has provided all of the authentication + info we need. + """ + if self.options.os_auth_strategy == 'keystone': + if self.options.os_token or self.options.os_url: + # Token flow auth takes priority + if not self.options.os_token: + raise exc.CommandError( + "You must provide a token via" + " either --os-token or env[OS_TOKEN]") + + if not self.options.os_url: + raise exc.CommandError( + "You must provide a service URL via" + " either --os-url or env[OS_URL]") + + else: + # Validate password flow auth + if not self.options.os_username: + raise exc.CommandError( + "You must provide a username via" + " either --os-username or env[OS_USERNAME]") + + if not self.options.os_password: + raise exc.CommandError( + "You must provide a password via" + " either --os-password or env[OS_PASSWORD]") + + if not (self.options.os_tenant_name): + raise exc.CommandError( + "You must provide a tenant_name via" + " either --os-tenant-name or via env[OS_TENANT_NAME]") + + if not self.options.os_auth_url: + raise exc.CommandError( + "You must provide an auth url via" + " either --os-auth-url or via env[OS_AUTH_URL]") + else: # not keystone + if not self.options.os_url: + raise exc.CommandError( + "You must provide a service URL via" + " either --os-url or env[OS_URL]") + + self.client_manager = clientmanager.ClientManager( + token=self.options.os_token, + url=self.options.os_url, + auth_url=self.options.os_auth_url, + tenant_name=self.options.os_tenant_name, + username=self.options.os_username, + password=self.options.os_password, + region_name=self.options.os_region_name, + api_version=self.api_version, + auth_strategy=self.options.os_auth_strategy, + endpoint_type=self.options.endpoint_type, + insecure=self.options.insecure, ) + return + + def initialize_app(self, argv): + """Global app init bits: + + * set up API versions + * validate authentication info + """ + + super(NeutronShell, self).initialize_app(argv) + + self.api_version = {'network': self.api_version} + + # If the user is not asking for help, make sure they + # have given us auth. + cmd_name = None + if argv: + cmd_info = self.command_manager.find_command(argv) + cmd_factory, cmd_name, sub_argv = cmd_info + if self.interactive_mode or cmd_name != 'help': + self.authenticate_user() + + def clean_up(self, cmd, result, err): + self.log.debug('clean_up %s', cmd.__class__.__name__) + if err: + self.log.debug('got an error: %s', unicode(err)) + + def configure_logging(self): + """Create logging handlers for any log output. + """ + root_logger = logging.getLogger('') + + # Set up logging to a file + root_logger.setLevel(logging.DEBUG) + + # Send higher-level messages to the console via stderr + console = logging.StreamHandler(self.stderr) + console_level = {0: logging.WARNING, + 1: logging.INFO, + 2: logging.DEBUG, + }.get(self.options.verbose_level, logging.DEBUG) + console.setLevel(console_level) + if logging.DEBUG == console_level: + formatter = logging.Formatter(self.DEBUG_MESSAGE_FORMAT) + else: + formatter = logging.Formatter(self.CONSOLE_MESSAGE_FORMAT) + console.setFormatter(formatter) + root_logger.addHandler(console) + return + + +def main(argv=sys.argv[1:]): + try: + return NeutronShell(NEUTRON_API_VERSION).run(map(strutils.safe_decode, + argv)) + except exc.NeutronClientException: + return 1 + except Exception as e: + print unicode(e) + return 1 + + +if __name__ == "__main__": + sys.exit(main(sys.argv[1:])) |