openstack/python-novaclient
Code Issues Proposed changes

Merge "Improve help strings"

Browse Source
This commit is contained in:
Jenkins 2015-09-22 16:30:03 +00:00 committed by Gerrit Code Review
commit f2780df3f2
2 changed files with 109 additions and 107 deletions
novaclient
shell.py
v2
shell.py

16
novaclient/shell.py

@ -283,7 +283,7 @@ class OpenStackComputeShell(object):
'--debug', '--debug',
default=False, default=False,
action='store_true', action='store_true',
help=_("Print debugging output")) help=_("Print debugging output."))
parser.add_argument( parser.add_argument(
'--os-cache', '--os-cache',
@ -297,12 +297,12 @@ class OpenStackComputeShell(object):
'--timings', '--timings',
default=False, default=False,
action='store_true', action='store_true',
help=_("Print call timing info")) help=_("Print call timing info."))
parser.add_argument( parser.add_argument(
'--os-auth-token', '--os-auth-token',
default=cliutils.env('OS_AUTH_TOKEN'), default=cliutils.env('OS_AUTH_TOKEN'),
help='Defaults to env[OS_AUTH_TOKEN]') help='Defaults to env[OS_AUTH_TOKEN].')
parser.add_argument( parser.add_argument(
'--os_username', '--os_username',
@ -352,7 +352,7 @@ class OpenStackComputeShell(object):
parser.add_argument( parser.add_argument(
'--service-type', '--service-type',
metavar='<service-type>', metavar='<service-type>',
help=_('Defaults to compute for most actions')) help=_('Defaults to compute for most actions.'))
parser.add_argument( parser.add_argument(
'--service_type', '--service_type',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@ -361,7 +361,7 @@ class OpenStackComputeShell(object):
'--service-name', '--service-name',
metavar='<service-name>', metavar='<service-name>',
default=cliutils.env('NOVA_SERVICE_NAME'), default=cliutils.env('NOVA_SERVICE_NAME'),
help=_('Defaults to env[NOVA_SERVICE_NAME]')) help=_('Defaults to env[NOVA_SERVICE_NAME].'))
parser.add_argument( parser.add_argument(
'--service_name', '--service_name',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@ -370,7 +370,7 @@ class OpenStackComputeShell(object):
'--volume-service-name', '--volume-service-name',
metavar='<volume-service-name>', metavar='<volume-service-name>',
default=cliutils.env('NOVA_VOLUME_SERVICE_NAME'), default=cliutils.env('NOVA_VOLUME_SERVICE_NAME'),
help=_('Defaults to env[NOVA_VOLUME_SERVICE_NAME]')) help=_('Defaults to env[NOVA_VOLUME_SERVICE_NAME].'))
parser.add_argument( parser.add_argument(
'--volume_service_name', '--volume_service_name',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@ -415,7 +415,7 @@ class OpenStackComputeShell(object):
dest='bypass_url', dest='bypass_url',
default=cliutils.env('NOVACLIENT_BYPASS_URL'), default=cliutils.env('NOVACLIENT_BYPASS_URL'),
help="Use this API endpoint instead of the Service Catalog. " help="Use this API endpoint instead of the Service Catalog. "
"Defaults to env[NOVACLIENT_BYPASS_URL]") "Defaults to env[NOVACLIENT_BYPASS_URL].")
parser.add_argument('--bypass_url', parser.add_argument('--bypass_url',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@ -869,7 +869,7 @@ class OpenStackComputeShell(object):
'command', 'command',
metavar='<subcommand>', metavar='<subcommand>',
nargs='?', nargs='?',
help='Display help for <subcommand>') help='Display help for <subcommand>.')
def do_help(self, args): def do_help(self, args):
""" """
Display help about this program or one of its subcommands. Display help about this program or one of its subcommands.

200
novaclient/v2/shell.py

@ -391,11 +391,11 @@ def _boot(cs, args):
default=os.environ.get('NOVACLIENT_DEFAULT_KEY_NAME'), default=os.environ.get('NOVACLIENT_DEFAULT_KEY_NAME'),
metavar='<key-name>', metavar='<key-name>',
help=_("Key name of keypair that should be created earlier with \ help=_("Key name of keypair that should be created earlier with \
the command keypair-add")) the command keypair-add."))
@cliutils.arg( @cliutils.arg(
'--key_name', '--key_name',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@cliutils.arg('name', metavar='<name>', help=_('Name for the new server')) @cliutils.arg('name', metavar='<name>', help=_('Name for the new server.'))
@cliutils.arg( @cliutils.arg(
'--user-data', '--user-data',
default=None, default=None,
@ -497,7 +497,7 @@ def _boot(cs, args):
metavar="<value>", metavar="<value>",
dest='config_drive', dest='config_drive',
default=False, default=False,
help=_("Enable config drive")) help=_("Enable config drive."))
@cliutils.arg( @cliutils.arg(
'--poll', '--poll',
dest='poll', dest='poll',
@ -509,7 +509,7 @@ def _boot(cs, args):
dest='admin_pass', dest='admin_pass',
metavar='<value>', metavar='<value>',
default=None, default=None,
help=_('Admin password for the instance')) help=_('Admin password for the instance.'))
def do_boot(cs, args): def do_boot(cs, args):
"""Boot a new server.""" """Boot a new server."""
boot_args, boot_kwargs = _boot(cs, args) boot_args, boot_kwargs = _boot(cs, args)
@ -686,7 +686,7 @@ def do_flavor_list(cs, args):
@cliutils.arg( @cliutils.arg(
'flavor', 'flavor',
metavar='<flavor>', metavar='<flavor>',
help=_("Name or ID of the flavor to delete")) help=_("Name or ID of the flavor to delete."))
def do_flavor_delete(cs, args): def do_flavor_delete(cs, args):
"""Delete a specific flavor""" """Delete a specific flavor"""
flavorid = _find_flavor(cs, args.flavor) flavorid = _find_flavor(cs, args.flavor)
@ -697,7 +697,7 @@ def do_flavor_delete(cs, args):
@cliutils.arg( @cliutils.arg(
'flavor', 'flavor',
metavar='<flavor>', metavar='<flavor>',
help=_("Name or ID of flavor")) help=_("Name or ID of flavor."))
def do_flavor_show(cs, args): def do_flavor_show(cs, args):
"""Show details about the given flavor.""" """Show details about the given flavor."""
flavor = _find_flavor(cs, args.flavor) flavor = _find_flavor(cs, args.flavor)
@ -707,24 +707,24 @@ def do_flavor_show(cs, args):
@cliutils.arg( @cliutils.arg(
'name', 'name',
metavar='<name>', metavar='<name>',
help=_("Name of the new flavor")) help=_("Name of the new flavor."))
@cliutils.arg( @cliutils.arg(
'id', 'id',
metavar='<id>', metavar='<id>',
help=_("Unique ID (integer or UUID) for the new flavor." help=_("Unique ID (integer or UUID) for the new flavor."
" If specifying 'auto', a UUID will be generated as id")) " If specifying 'auto', a UUID will be generated as ID."))
@cliutils.arg( @cliutils.arg(
'ram', 'ram',
metavar='<ram>', metavar='<ram>',
help=_("Memory size in MB")) help=_("Memory size in MB."))
@cliutils.arg( @cliutils.arg(
'disk', 'disk',
metavar='<disk>', metavar='<disk>',
help=_("Disk size in GB")) help=_("Disk size in GB."))
@cliutils.arg( @cliutils.arg(
'--ephemeral', '--ephemeral',
metavar='<ephemeral>', metavar='<ephemeral>',
help=_("Ephemeral space size in GB (default 0)"), help=_("Ephemeral space size in GB (default 0)."),
default=0) default=0)
@cliutils.arg( @cliutils.arg(
'vcpus', 'vcpus',
@ -733,21 +733,21 @@ def do_flavor_show(cs, args):
@cliutils.arg( @cliutils.arg(
'--swap', '--swap',
metavar='<swap>', metavar='<swap>',
help=_("Swap space size in MB (default 0)"), help=_("Swap space size in MB (default 0)."),
default=0) default=0)
@cliutils.arg( @cliutils.arg(
'--rxtx-factor', '--rxtx-factor',
metavar='<factor>', metavar='<factor>',
help=_("RX/TX factor (default 1)"), help=_("RX/TX factor (default 1)."),
default=1.0) default=1.0)
@cliutils.arg( @cliutils.arg(
'--is-public', '--is-public',
metavar='<is-public>', metavar='<is-public>',
help=_("Make flavor accessible to the public (default true)"), help=_("Make flavor accessible to the public (default true)."),
type=lambda v: strutils.bool_from_string(v, True), type=lambda v: strutils.bool_from_string(v, True),
default=True) default=True)
def do_flavor_create(cs, args): def do_flavor_create(cs, args):
"""Create a new flavor""" """Create a new flavor."""
f = cs.flavors.create(args.name, args.ram, args.vcpus, args.disk, args.id, f = cs.flavors.create(args.name, args.ram, args.vcpus, args.disk, args.id,
args.ephemeral, args.swap, args.rxtx_factor, args.ephemeral, args.swap, args.rxtx_factor,
args.is_public) args.is_public)
@ -757,19 +757,19 @@ def do_flavor_create(cs, args):
@cliutils.arg( @cliutils.arg(
'flavor', 'flavor',
metavar='<flavor>', metavar='<flavor>',
help=_("Name or ID of flavor")) help=_("Name or ID of flavor."))
@cliutils.arg( @cliutils.arg(
'action', 'action',
metavar='<action>', metavar='<action>',
choices=['set', 'unset'], choices=['set', 'unset'],
help=_("Actions: 'set' or 'unset'")) help=_("Actions: 'set' or 'unset'."))
@cliutils.arg( @cliutils.arg(
'metadata', 'metadata',
metavar='<key=value>', metavar='<key=value>',
nargs='+', nargs='+',
action='append', action='append',
default=[], default=[],
help=_('Extra_specs to set/unset (only key is necessary on unset)')) help=_('Extra_specs to set/unset (only key is necessary on unset).'))
def do_flavor_key(cs, args): def do_flavor_key(cs, args):
"""Set or unset extra_spec for a flavor.""" """Set or unset extra_spec for a flavor."""
flavor = _find_flavor(cs, args.flavor) flavor = _find_flavor(cs, args.flavor)
@ -888,7 +888,7 @@ def do_network_list(cs, args):
@cliutils.arg( @cliutils.arg(
'network', 'network',
metavar='<network>', metavar='<network>',
help=_("uuid or label of network")) help=_("UUID or label of network."))
def do_network_show(cs, args): def do_network_show(cs, args):
"""Show details about the given network.""" """Show details about the given network."""
network = utils.find_resource(cs.networks, args.network) network = utils.find_resource(cs.networks, args.network)
@ -898,7 +898,7 @@ def do_network_show(cs, args):
@cliutils.arg( @cliutils.arg(
'network', 'network',
metavar='<network>', metavar='<network>',
help=_("uuid or label of network")) help=_("UUID or label of network."))
def do_network_delete(cs, args): def do_network_delete(cs, args):
"""Delete network by label or id.""" """Delete network by label or id."""
network = utils.find_resource(cs.networks, args.network) network = utils.find_resource(cs.networks, args.network)
@ -924,7 +924,7 @@ def do_network_delete(cs, args):
@cliutils.arg( @cliutils.arg(
'network', 'network',
metavar='<network>', metavar='<network>',
help=_("uuid of network")) help=_("UUID of network."))
def do_network_disassociate(cs, args): def do_network_disassociate(cs, args):
"""Disassociate host and/or project from the given network.""" """Disassociate host and/or project from the given network."""
if args.host_only: if args.host_only:
@ -938,7 +938,7 @@ def do_network_disassociate(cs, args):
@cliutils.arg( @cliutils.arg(
'network', 'network',
metavar='<network>', metavar='<network>',
help=_("uuid of network")) help=_("UUID of network."))
@cliutils.arg( @cliutils.arg(
'host', 'host',
metavar='<host>', metavar='<host>',
@ -951,7 +951,7 @@ def do_network_associate_host(cs, args):
@cliutils.arg( @cliutils.arg(
'network', 'network',
metavar='<network>', metavar='<network>',
help=_("uuid of network")) help=_("UUID of network."))
def do_network_associate_project(cs, args): def do_network_associate_project(cs, args):
"""Associate project with network.""" """Associate project with network."""
cs.networks.associate_project(args.network) cs.networks.associate_project(args.network)
@ -1029,46 +1029,46 @@ def _filter_network_create_options(args):
@cliutils.arg( @cliutils.arg(
'--dns1', '--dns1',
dest="dns1", dest="dns1",
metavar="<DNS Address>", help=_('First DNS')) metavar="<DNS Address>", help=_('First DNS.'))
@cliutils.arg( @cliutils.arg(
'--dns2', '--dns2',
dest="dns2", dest="dns2",
metavar="<DNS Address>", metavar="<DNS Address>",
help=_('Second DNS')) help=_('Second DNS.'))
@cliutils.arg( @cliutils.arg(
'--uuid', '--uuid',
dest="uuid", dest="uuid",
metavar="<network uuid>", metavar="<network uuid>",
help=_('Network UUID')) help=_('Network UUID.'))
@cliutils.arg( @cliutils.arg(
'--fixed-cidr', '--fixed-cidr',
dest="fixed_cidr", dest="fixed_cidr",
metavar='<x.x.x.x/yy>', metavar='<x.x.x.x/yy>',
help=_('IPv4 subnet for fixed IPs (ex: 10.20.0.0/16)')) help=_('IPv4 subnet for fixed IPs (ex: 10.20.0.0/16).'))
@cliutils.arg( @cliutils.arg(
'--project-id', '--project-id',
dest="project_id", dest="project_id",
metavar="<project id>", metavar="<project id>",
help=_('Project ID')) help=_('Project ID.'))
@cliutils.arg( @cliutils.arg(
'--priority', '--priority',
dest="priority", dest="priority",
metavar="<number>", metavar="<number>",
help=_('Network interface priority')) help=_('Network interface priority.'))
@cliutils.arg( @cliutils.arg(
'--mtu', '--mtu',
dest="mtu", dest="mtu",
type=int, type=int,
help=_('MTU for network')) help=_('MTU for network.'))
@cliutils.arg( @cliutils.arg(
'--enable-dhcp', '--enable-dhcp',
dest="enable_dhcp", dest="enable_dhcp",
metavar="<'T'|'F'>", metavar="<'T'|'F'>",
help=_('Enable dhcp')) help=_('Enable DHCP.'))
@cliutils.arg( @cliutils.arg(
'--dhcp-server', '--dhcp-server',
dest="dhcp_server", dest="dhcp_server",
help=_('Dhcp-server (defaults to gateway address)')) help=_('DHCP-server address (defaults to gateway address)'))
@cliutils.arg( @cliutils.arg(
'--share-address', '--share-address',
dest="share_address", dest="share_address",
@ -1077,11 +1077,11 @@ def _filter_network_create_options(args):
@cliutils.arg( @cliutils.arg(
'--allowed-start', '--allowed-start',
dest="allowed_start", dest="allowed_start",
help=_('Start of allowed addresses for instances')) help=_('Start of allowed addresses for instances.'))
@cliutils.arg( @cliutils.arg(
'--allowed-end', '--allowed-end',
dest="allowed_end", dest="allowed_end",
help=_('End of allowed addresses for instances')) help=_('End of allowed addresses for instances.'))
def do_network_create(cs, args): def do_network_create(cs, args):
"""Create a network.""" """Create a network."""
@ -1128,12 +1128,12 @@ def do_image_list(cs, _args):
@cliutils.arg( @cliutils.arg(
'image', 'image',
metavar='<image>', metavar='<image>',
help=_("Name or ID of image")) help=_("Name or ID of image."))
@cliutils.arg( @cliutils.arg(
'action', 'action',
metavar='<action>', metavar='<action>',
choices=['set', 'delete'], choices=['set', 'delete'],
help=_("Actions: 'set' or 'delete'")) help=_("Actions: 'set' or 'delete'."))
@cliutils.arg( @cliutils.arg(
'metadata', 'metadata',
metavar='<key=value>', metavar='<key=value>',
@ -1141,7 +1141,7 @@ def do_image_list(cs, _args):
action='append', action='append',
default=[], default=[],
help=_('Metadata to add/update or delete (only key is necessary on ' help=_('Metadata to add/update or delete (only key is necessary on '
'delete)')) 'delete).'))
def do_image_meta(cs, args): def do_image_meta(cs, args):
"""Set or Delete metadata on an image.""" """Set or Delete metadata on an image."""
image = _find_image(cs, args.image) image = _find_image(cs, args.image)
@ -1204,7 +1204,7 @@ def _print_flavor(flavor):
@cliutils.arg( @cliutils.arg(
'image', 'image',
metavar='<image>', metavar='<image>',
help=_("Name or ID of image")) help=_("Name or ID of image."))
def do_image_show(cs, args): def do_image_show(cs, args):
"""Show details about the given image.""" """Show details about the given image."""
image = _find_image(cs, args.image) image = _find_image(cs, args.image)
@ -1250,7 +1250,7 @@ def do_image_delete(cs, args):
dest='name', dest='name',
metavar='<name-regexp>', metavar='<name-regexp>',
default=None, default=None,
help=_('Search with regular expression match by name')) help=_('Search with regular expression match by name.'))
@cliutils.arg( @cliutils.arg(
'--instance-name', '--instance-name',
dest='instance_name', dest='instance_name',
@ -1265,19 +1265,19 @@ def do_image_delete(cs, args):
dest='status', dest='status',
metavar='<status>', metavar='<status>',
default=None, default=None,
help=_('Search by server status')) help=_('Search by server status.'))
@cliutils.arg( @cliutils.arg(
'--flavor', '--flavor',
dest='flavor', dest='flavor',
metavar='<flavor>', metavar='<flavor>',
default=None, default=None,
help=_('Search by flavor name or ID')) help=_('Search by flavor name or ID.'))
@cliutils.arg( @cliutils.arg(
'--image', '--image',
dest='image', dest='image',
metavar='<image>', metavar='<image>',
default=None, default=None,
help=_('Search by image name or ID')) help=_('Search by image name or ID.'))
@cliutils.arg( @cliutils.arg(
'--host', '--host',
dest='host', dest='host',
@ -1331,7 +1331,7 @@ def do_image_delete(cs, args):
dest='minimal', dest='minimal',
action="store_true", action="store_true",
default=False, default=False,
help=_('Get only uuid and name.')) help=_('Get only UUID and name.'))
@cliutils.arg( @cliutils.arg(
'--sort', '--sort',
dest='sort', dest='sort',
@ -1344,7 +1344,7 @@ def do_image_delete(cs, args):
dest='marker', dest='marker',
metavar='<marker>', metavar='<marker>',
default=None, default=None,
help=('The last server uuid of the previous page; displays list of servers' help=('The last server UUID of the previous page; displays list of servers'
' after "marker".')) ' after "marker".'))
@cliutils.arg( @cliutils.arg(
'--limit', '--limit',
@ -1508,7 +1508,7 @@ def do_reboot(cs, args):
dest='minimal', dest='minimal',
action="store_true", action="store_true",
default=False, default=False,
help=_('Skips flavor/image lookups when showing servers')) help=_('Skips flavor/image lookups when showing servers.'))
@cliutils.arg( @cliutils.arg(
'--preserve-ephemeral', '--preserve-ephemeral',
action="store_true", action="store_true",
@ -1518,7 +1518,7 @@ def do_reboot(cs, args):
'--name', '--name',
metavar='<name>', metavar='<name>',
default=None, default=None,
help=_('Name for the new server')) help=_('Name for the new server.'))
@cliutils.arg( @cliutils.arg(
'--meta', '--meta',
metavar="<key=value>", metavar="<key=value>",
@ -1843,19 +1843,19 @@ def do_backup(cs, args):
@cliutils.arg( @cliutils.arg(
'server', 'server',
metavar='<server>', metavar='<server>',
help=_("Name or ID of server")) help=_("Name or ID of server."))
@cliutils.arg( @cliutils.arg(
'action', 'action',
metavar='<action>', metavar='<action>',
choices=['set', 'delete'], choices=['set', 'delete'],
help=_("Actions: 'set' or 'delete'")) help=_("Actions: 'set' or 'delete'."))
@cliutils.arg( @cliutils.arg(
'metadata', 'metadata',
metavar='<key=value>', metavar='<key=value>',
nargs='+', nargs='+',
action='append', action='append',
default=[], default=[],
help=_('Metadata to set or delete (only key is necessary on delete)')) help=_('Metadata to set or delete (only key is necessary on delete).'))
def do_meta(cs, args): def do_meta(cs, args):
"""Set or Delete metadata on a server.""" """Set or Delete metadata on a server."""
server = _find_server(cs, args.server) server = _find_server(cs, args.server)
@ -1926,7 +1926,7 @@ def _print_server(cs, args, server=None):
dest='minimal', dest='minimal',
action="store_true", action="store_true",
default=False, default=False,
help=_('Skips flavor/image lookups when showing servers')) help=_('Skips flavor/image lookups when showing servers.'))
@cliutils.arg('server', metavar='<server>', help=_('Name or ID of server.')) @cliutils.arg('server', metavar='<server>', help=_('Name or ID of server.'))
def do_show(cs, args): def do_show(cs, args):
"""Show details about the given server.""" """Show details about the given server."""
@ -2288,7 +2288,7 @@ def do_volume_type_create(cs, args):
@cliutils.arg( @cliutils.arg(
'id', 'id',
metavar='<id>', metavar='<id>',
help=_("Unique ID of the volume type to delete")) help=_("Unique ID of the volume type to delete."))
def do_volume_type_delete(cs, args): def do_volume_type_delete(cs, args):
"""DEPRECATED: Delete a specific volume type.""" """DEPRECATED: Delete a specific volume type."""
emit_volume_deprecation_warning('volume-type-delete') emit_volume_deprecation_warning('volume-type-delete')
@ -2528,7 +2528,7 @@ def do_floating_ip_pool_list(cs, _args):
@cliutils.arg( @cliutils.arg(
'--host', dest='host', metavar='<host>', default=None, '--host', dest='host', metavar='<host>', default=None,
help=_('Filter by host')) help=_('Filter by host.'))
def do_floating_ip_bulk_list(cs, args): def do_floating_ip_bulk_list(cs, args):
"""List all floating IPs (nova-network only).""" """List all floating IPs (nova-network only)."""
utils.print_list(cs.floating_ips_bulk.list(args.host), ['project_id', utils.print_list(cs.floating_ips_bulk.list(args.host), ['project_id',
@ -2538,19 +2538,21 @@ def do_floating_ip_bulk_list(cs, args):
'interface']) 'interface'])
@cliutils.arg('ip_range', metavar='<range>', help=_('Address range to create')) @cliutils.arg('ip_range', metavar='<range>',
help=_('Address range to create.'))
@cliutils.arg( @cliutils.arg(
'--pool', dest='pool', metavar='<pool>', default=None, '--pool', dest='pool', metavar='<pool>', default=None,
help=_('Pool for new Floating IPs')) help=_('Pool for new Floating IPs.'))
@cliutils.arg( @cliutils.arg(
'--interface', metavar='<interface>', default=None, '--interface', metavar='<interface>', default=None,
help=_('Interface for new Floating IPs')) help=_('Interface for new Floating IPs.'))
def do_floating_ip_bulk_create(cs, args): def do_floating_ip_bulk_create(cs, args):
"""Bulk create floating IPs by range (nova-network only).""" """Bulk create floating IPs by range (nova-network only)."""
cs.floating_ips_bulk.create(args.ip_range, args.pool, args.interface) cs.floating_ips_bulk.create(args.ip_range, args.pool, args.interface)
@cliutils.arg('ip_range', metavar='<range>', help=_('Address range to delete')) @cliutils.arg('ip_range', metavar='<range>',
help=_('Address range to delete.'))
def do_floating_ip_bulk_delete(cs, args): def do_floating_ip_bulk_delete(cs, args):
"""Bulk delete floating IPs by range (nova-network only).""" """Bulk delete floating IPs by range (nova-network only)."""
cs.floating_ips_bulk.delete(args.ip_range) cs.floating_ips_bulk.delete(args.ip_range)
@ -2571,9 +2573,9 @@ def do_dns_domains(cs, args):
_print_domain_list(domains) _print_domain_list(domains)
@cliutils.arg('domain', metavar='<domain>', help=_('DNS domain')) @cliutils.arg('domain', metavar='<domain>', help=_('DNS domain.'))
@cliutils.arg('--ip', metavar='<ip>', help=_('IP address'), default=None) @cliutils.arg('--ip', metavar='<ip>', help=_('IP address.'), default=None)
@cliutils.arg('--name', metavar='<name>', help=_('DNS name'), default=None) @cliutils.arg('--name', metavar='<name>', help=_('DNS name.'), default=None)
def do_dns_list(cs, args): def do_dns_list(cs, args):
"""List current DNS entries for domain and IP or domain and name.""" """List current DNS entries for domain and IP or domain and name."""
if not (args.ip or args.name): if not (args.ip or args.name):
@ -2588,33 +2590,33 @@ def do_dns_list(cs, args):
_print_dns_list(entries) _print_dns_list(entries)
@cliutils.arg('ip', metavar='<ip>', help=_('IP address')) @cliutils.arg('ip', metavar='<ip>', help=_('IP address.'))
@cliutils.arg('name', metavar='<name>', help=_('DNS name')) @cliutils.arg('name', metavar='<name>', help=_('DNS name.'))
@cliutils.arg('domain', metavar='<domain>', help=_('DNS domain')) @cliutils.arg('domain', metavar='<domain>', help=_('DNS domain.'))
@cliutils.arg( @cliutils.arg(
'--type', '--type',
metavar='<type>', metavar='<type>',
help=_('dns type (e.g. "A")'), help=_('DNS type (e.g. "A")'),
default='A') default='A')
def do_dns_create(cs, args): def do_dns_create(cs, args):
"""Create a DNS entry for domain, name and IP.""" """Create a DNS entry for domain, name, and IP."""
cs.dns_entries.create(args.domain, args.name, args.ip, args.type) cs.dns_entries.create(args.domain, args.name, args.ip, args.type)
@cliutils.arg('domain', metavar='<domain>', help=_('DNS domain')) @cliutils.arg('domain', metavar='<domain>', help=_('DNS domain.'))
@cliutils.arg('name', metavar='<name>', help=_('DNS name')) @cliutils.arg('name', metavar='<name>', help=_('DNS name.'))
def do_dns_delete(cs, args): def do_dns_delete(cs, args):
"""Delete the specified DNS entry.""" """Delete the specified DNS entry."""
cs.dns_entries.delete(args.domain, args.name) cs.dns_entries.delete(args.domain, args.name)
@cliutils.arg('domain', metavar='<domain>', help=_('DNS domain')) @cliutils.arg('domain', metavar='<domain>', help=_('DNS domain.'))
def do_dns_delete_domain(cs, args): def do_dns_delete_domain(cs, args):
"""Delete the specified DNS domain.""" """Delete the specified DNS domain."""
cs.dns_domains.delete(args.domain) cs.dns_domains.delete(args.domain)
@cliutils.arg('domain', metavar='<domain>', help=_('DNS domain')) @cliutils.arg('domain', metavar='<domain>', help=_('DNS domain.'))
@cliutils.arg( @cliutils.arg(
'--availability-zone', '--availability-zone',
metavar='<availability-zone>', metavar='<availability-zone>',
@ -2630,7 +2632,7 @@ def do_dns_create_private_domain(cs, args):
args.availability_zone) args.availability_zone)
@cliutils.arg('domain', metavar='<domain>', help=_('DNS domain')) @cliutils.arg('domain', metavar='<domain>', help=_('DNS domain.'))
@cliutils.arg( @cliutils.arg(
'--project', metavar='<project>', '--project', metavar='<project>',
help=_('Limit access to this domain to users ' help=_('Limit access to this domain to users '
@ -3125,12 +3127,12 @@ def do_limits(cs, args):
@cliutils.arg( @cliutils.arg(
'--start', '--start',
metavar='<start>', metavar='<start>',
help=_('Usage range start date ex 2012-01-20 (default: 4 weeks ago)'), help=_('Usage range start date ex 2012-01-20. (default: 4 weeks ago)'),
default=None) default=None)
@cliutils.arg( @cliutils.arg(
'--end', '--end',
metavar='<end>', metavar='<end>',
help=_('Usage range end date, ex 2012-01-20 (default: tomorrow)'), help=_('Usage range end date, ex 2012-01-20. (default: tomorrow)'),
default=None) default=None)
def do_usage_list(cs, args): def do_usage_list(cs, args):
"""List usage data for all tenants.""" """List usage data for all tenants."""
@ -3174,11 +3176,11 @@ def do_usage_list(cs, args):
@cliutils.arg( @cliutils.arg(
'--start', '--start',
metavar='<start>', metavar='<start>',
help=_('Usage range start date ex 2012-01-20 (default: 4 weeks ago)'), help=_('Usage range start date ex 2012-01-20. (default: 4 weeks ago)'),
default=None) default=None)
@cliutils.arg( @cliutils.arg(
'--end', metavar='<end>', '--end', metavar='<end>',
help=_('Usage range end date, ex 2012-01-20 (default: tomorrow)'), help=_('Usage range end date, ex 2012-01-20. (default: tomorrow)'),
default=None) default=None)
@cliutils.arg( @cliutils.arg(
'--tenant', '--tenant',
@ -3236,13 +3238,13 @@ def do_usage(cs, args):
metavar='<private-key-filename>', metavar='<private-key-filename>',
nargs='?', nargs='?',
default='pk.pem', default='pk.pem',
help=_('Filename for the private key [Default: pk.pem]')) help=_('Filename for the private key. [Default: pk.pem]'))
@cliutils.arg( @cliutils.arg(
'cert_filename', 'cert_filename',
metavar='<x509-cert-filename>', metavar='<x509-cert-filename>',
nargs='?', nargs='?',
default='cert.pem', default='cert.pem',
help=_('Filename for the X.509 certificate [Default: cert.pem]')) help=_('Filename for the X.509 certificate. [Default: cert.pem]'))
def do_x509_create_cert(cs, args): def do_x509_create_cert(cs, args):
"""Create x509 cert for a user in tenant.""" """Create x509 cert for a user in tenant."""
@ -3290,7 +3292,7 @@ def do_x509_get_root_cert(cs, args):
'--hypervisor', '--hypervisor',
metavar='<hypervisor>', metavar='<hypervisor>',
default=None, default=None,
help=_('type of hypervisor.')) help=_('Type of hypervisor.'))
def do_agent_list(cs, args): def do_agent_list(cs, args):
"""List all builds.""" """List all builds."""
result = cs.agents.list(args.hypervisor) result = cs.agents.list(args.hypervisor)
@ -3299,19 +3301,19 @@ def do_agent_list(cs, args):
utils.print_list(result, columns) utils.print_list(result, columns)
@cliutils.arg('os', metavar='<os>', help=_('type of os.')) @cliutils.arg('os', metavar='<os>', help=_('Type of OS.'))
@cliutils.arg( @cliutils.arg(
'architecture', 'architecture',
metavar='<architecture>', metavar='<architecture>',
help=_('type of architecture')) help=_('Type of architecture.'))
@cliutils.arg('version', metavar='<version>', help=_('version')) @cliutils.arg('version', metavar='<version>', help=_('Version.'))
@cliutils.arg('url', metavar='<url>', help=_('url')) @cliutils.arg('url', metavar='<url>', help=_('URL.'))
@cliutils.arg('md5hash', metavar='<md5hash>', help=_('md5 hash')) @cliutils.arg('md5hash', metavar='<md5hash>', help=_('MD5 hash.'))
@cliutils.arg( @cliutils.arg(
'hypervisor', 'hypervisor',
metavar='<hypervisor>', metavar='<hypervisor>',
default='xen', default='xen',
help=_('type of hypervisor.')) help=_('Type of hypervisor.'))
def do_agent_create(cs, args): def do_agent_create(cs, args):
"""Create new agent build.""" """Create new agent build."""
result = cs.agents.create(args.os, args.architecture, result = cs.agents.create(args.os, args.architecture,
@ -3320,16 +3322,16 @@ def do_agent_create(cs, args):
utils.print_dict(result._info.copy()) utils.print_dict(result._info.copy())
@cliutils.arg('id', metavar='<id>', help=_('id of the agent-build')) @cliutils.arg('id', metavar='<id>', help=_('ID of the agent-build.'))
def do_agent_delete(cs, args): def do_agent_delete(cs, args):
"""Delete existing agent build.""" """Delete existing agent build."""
cs.agents.delete(args.id) cs.agents.delete(args.id)
@cliutils.arg('id', metavar='<id>', help=_('id of the agent-build')) @cliutils.arg('id', metavar='<id>', help=_('ID of the agent-build.'))
@cliutils.arg('version', metavar='<version>', help=_('version')) @cliutils.arg('version', metavar='<version>', help=_('Version.'))
@cliutils.arg('url', metavar='<url>', help=_('url')) @cliutils.arg('url', metavar='<url>', help=_('URL'))
@cliutils.arg('md5hash', metavar='<md5hash>', help=_('md5hash')) @cliutils.arg('md5hash', metavar='<md5hash>', help=_('MD5 hash.'))
def do_agent_modify(cs, args): def do_agent_modify(cs, args):
"""Modify existing agent build.""" """Modify existing agent build."""
result = cs.agents.update(args.id, args.version, result = cs.agents.update(args.id, args.version,
@ -3485,7 +3487,7 @@ def _print_aggregate_details(aggregate):
@cliutils.arg('server', metavar='<server>', help=_('Name or ID of server.')) @cliutils.arg('server', metavar='<server>', help=_('Name or ID of server.'))
@cliutils.arg( @cliutils.arg(
'host', metavar='<host>', default=None, nargs='?', 'host', metavar='<host>', default=None, nargs='?',
help=_('destination host name.')) help=_('Destination host name.'))
@cliutils.arg( @cliutils.arg(
'--block-migrate', '--block-migrate',
action='store_true', action='store_true',
@ -3501,7 +3503,7 @@ def _print_aggregate_details(aggregate):
action='store_true', action='store_true',
dest='disk_over_commit', dest='disk_over_commit',
default=False, default=False,
help=_('Allow overcommit.(Default=False)')) help=_('Allow overcommit. (Default=False)'))
@cliutils.arg( @cliutils.arg(
'--disk_over_commit', '--disk_over_commit',
action='store_true', action='store_true',
@ -3605,7 +3607,7 @@ def do_service_disable(cs, args):
@cliutils.arg( @cliutils.arg(
'--unset', '--unset',
dest='force_down', dest='force_down',
help=_("Unset the force state down of service"), help=_("Unset the force state down of service."),
action='store_false', action='store_false',
default=True) default=True)
def do_service_force_down(cs, args): def do_service_force_down(cs, args):
@ -3614,7 +3616,7 @@ def do_service_force_down(cs, args):
utils.print_list([result], ['Host', 'Binary', 'Forced down']) utils.print_list([result], ['Host', 'Binary', 'Forced down'])
@cliutils.arg('id', metavar='<id>', help=_('Id of service.')) @cliutils.arg('id', metavar='<id>', help=_('ID of service.'))
def do_service_delete(cs, args): def do_service_delete(cs, args):
"""Delete the service.""" """Delete the service."""
cs.services.delete(args.id) cs.services.delete(args.id)
@ -3849,7 +3851,7 @@ def _get_first_endpoint(endpoints, region):
@cliutils.arg( @cliutils.arg(
'--wrap', dest='wrap', metavar='<integer>', default=64, '--wrap', dest='wrap', metavar='<integer>', default=64,
help=_('wrap PKI tokens to a specified length, or 0 to disable')) help=_('Wrap PKI tokens to a specified length, or 0 to disable.'))
def do_credentials(cs, _args): def do_credentials(cs, _args):
"""Show user credentials returned from auth.""" """Show user credentials returned from auth."""
if isinstance(cs.client, client.SessionClient): if isinstance(cs.client, client.SessionClient):
@ -3911,7 +3913,7 @@ def do_credentials(cs, _args):
@cliutils.arg( @cliutils.arg(
'--extra-opts', '--extra-opts',
dest='extra', dest='extra',
help=_('Extra options to pass to ssh. see: man ssh'), help=_('Extra options to pass to ssh. see: man ssh.'),
default='') default='')
def do_ssh(cs, args): def do_ssh(cs, args):
"""SSH into a server.""" """SSH into a server."""
@ -4173,7 +4175,7 @@ def do_quota_defaults(cs, args):
action="store_true", action="store_true",
default=None, default=None,
help=_('Whether force update the quota even if the already used and ' help=_('Whether force update the quota even if the already used and '
'reserved exceeds the new quota')) 'reserved exceeds the new quota.'))
def do_quota_update(cs, args): def do_quota_update(cs, args):
"""Update the quotas for a tenant/user.""" """Update the quotas for a tenant/user."""
@ -4324,13 +4326,13 @@ def do_quota_class_update(cs, args):
dest='password', dest='password',
metavar='<password>', metavar='<password>',
help=_("Set the provided admin password on the evacuated server. Not" help=_("Set the provided admin password on the evacuated server. Not"
" applicable with on-shared-storage flag")) " applicable with on-shared-storage flag."))
@cliutils.arg( @cliutils.arg(
'--on-shared-storage', '--on-shared-storage',
dest='on_shared_storage', dest='on_shared_storage',
action="store_true", action="store_true",
default=False, default=False,
help=_('Specifies whether server files are located on shared storage')) help=_('Specifies whether server files are located on shared storage.'))
def do_evacuate(cs, args): def do_evacuate(cs, args):
"""Evacuate server from failed host.""" """Evacuate server from failed host."""
@ -4564,7 +4566,7 @@ def do_secgroup_delete_default_rule(cs, args):
metavar='<policy>', metavar='<policy>',
default=argparse.SUPPRESS, default=argparse.SUPPRESS,
nargs='*', nargs='*',
help=_('Policies for the server groups ("affinity" or "anti-affinity")')) help=_('Policies for the server groups. ("affinity" or "anti-affinity")'))
@cliutils.arg( @cliutils.arg(
'--policy', '--policy',
default=[], default=[],
@ -4585,7 +4587,7 @@ def do_server_group_create(cs, args):
'id', 'id',
metavar='<id>', metavar='<id>',
nargs='+', nargs='+',
help=_("Unique ID(s) of the server group to delete")) help=_("Unique ID(s) of the server group to delete."))
def do_server_group_delete(cs, args): def do_server_group_delete(cs, args):
"""Delete specific server group(s).""" """Delete specific server group(s)."""
failure_count = 0 failure_count = 0
@ -4606,7 +4608,7 @@ def do_server_group_delete(cs, args):
@cliutils.arg( @cliutils.arg(
'id', 'id',
metavar='<id>', metavar='<id>',
help=_("Unique ID of the server group to get")) help=_("Unique ID of the server group to get."))
def do_server_group_get(cs, args): def do_server_group_get(cs, args):
"""Get a specific server group.""" """Get a specific server group."""
server_group = cs.server_groups.get(args.id) server_group = cs.server_groups.get(args.id)