def boot_from_args(arg):
arg.username = arg.username or Image.guess_username(arg.image)
is_name_provided = arg.name is not None
arg.user = Default.user
for index in range(0, arg.count):
vm_details = dotdict({
"cloud": arg.cloud,
"name": Vm.get_vm_name(arg.name, index),
"image": arg.image,
"flavor": arg.flavor,
"key": arg.key,
"secgroup": arg.secgroup,
"group": arg.group,
"username": arg.username,
"user": arg.user
})
# correct the username
vm_details.username = Image.guess_username_from_category(
vm_details.cloud,
vm_details.image,
username=arg.username)
try:
if arg.dryrun:
print(Printer.attribute(vm_details, output=arg.format))
msg = "dryrun info. OK."
Console.ok(msg)
else:
vm_id = Vm.boot(**vm_details)
if vm_id is None:
msg = "info. failed."
Console.error(msg, traceflag=False)
return ""
# set name and counter in defaults
Default.set_vm(value=vm_details.name)
if is_name_provided is False:
Default.incr_counter("name")
# Add to group
if vm_id is not None:
Group.add(name=vm_details.group,
species="vm",
member=vm_details.name,
category=vm_details.cloud)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Console.error("Problem booting instance {name}".format(**vm_details), traceflag=False)
def boot_from_args(arg):
arg.username = arg.username or Image.guess_username(arg.image)
is_name_provided = arg.name is not None
arg.user = Default.user
for index in range(0, arg.count):
vm_details = dotdict({
"cloud": arg.cloud,
"name": Vm.generate_vm_name(arg.name, index),
"image": arg.image,
"flavor": arg.flavor,
"key": arg.key,
"secgroup": arg.secgroup,
"group": arg.group,
"username": arg.username,
"user": arg.user
})
# correct the username
vm_details.username = Image.guess_username_from_category(
vm_details.cloud, vm_details.image, username=arg.username)
try:
if arg.dryrun:
print(Printer.attribute(vm_details, output=arg.format))
msg = "dryrun info. OK."
Console.ok(msg)
else:
vm_id = Vm.boot(**vm_details)
if vm_id is None:
msg = "info. failed."
Console.error(msg, traceflag=False)
return ""
# set name and counter in defaults
Default.set_vm(value=vm_details.name)
if is_name_provided is False:
Default.incr_counter("name")
# Add to group
if vm_id is not None:
Group.add(name=vm_details.group,
species="vm",
member=vm_details.name,
category=vm_details.cloud)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Console.error(
"Problem booting instance {name}".format(**vm_details),
traceflag=False)
def do_vm(self, args, arguments):
"""
::
Usage:
vm default [--cloud=CLOUD][--format=FORMAT]
vm refresh [all][--cloud=CLOUD]
vm boot [--name=NAME]
[--cloud=CLOUD]
[--username=USERNAME]
[--image=IMAGE]
[--flavor=FLAVOR]
[--group=GROUP]
[--public]
[--secgroup=SECGROUP]
[--key=KEY]
[--dryrun]
vm boot [--n=COUNT]
[--cloud=CLOUD]
[--username=USERNAME]
[--image=IMAGE]
[--flavor=FLAVOR]
[--group=GROUP]
[--public]
[--secgroup=SECGROUP]
[--key=KEY]
[--dryrun]
vm ping [NAME] [N]
vm console [NAME]
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm start [NAMES]
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm stop [NAMES]
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm terminate [NAMES]
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm delete [NAMES]
[--group=GROUP]
[--cloud=CLOUD]
[--keep]
[--dryrun]
vm ip assign [NAMES]
[--cloud=CLOUD]
vm ip show [NAMES]
[--group=GROUP]
[--cloud=CLOUD]
[--format=FORMAT]
[--refresh]
vm ip inventory [NAMES]
[--header=HEADER]
[--file=FILE]
vm ssh [NAME] [--username=USER]
[--quiet]
[--ip=IP]
[--cloud=CLOUD]
[--key=KEY]
[--command=COMMAND]
vm rename [OLDNAMES] [NEWNAMES] [--force] [--dryrun]
vm list [NAMES]
[--cloud=CLOUDS|--active]
[--group=GROUP]
[--format=FORMAT]
[--refresh]
vm status [NAMES]
vm wait [--cloud=CLOUD] [--interval=SECONDS]
vm info [--cloud=CLOUD]
[--format=FORMAT]
vm check NAME
vm username USERNAME [NAMES] [--cloud=CLOUD]
Arguments:
COMMAND positional arguments, the commands you want to
execute on the server(e.g. ls -a) separated by ';',
you will get a return of executing result instead of login to
the server, note that type in -- is suggested before
you input the commands
NAME server name. By default it is set to the name of last vm from database.
NAMES server name. By default it is set to the name of last vm from database.
KEYPAIR_NAME Name of the openstack keypair to be used to create VM. Note this is
not a path to key.
NEWNAMES New names of the VM while renaming.
OLDNAMES Old names of the VM while renaming.
Options:
--username=USERNAME the username to login into the vm. If not specified it will be guessed
from the image name and the cloud
--ip=IP give the public ip of the server
--cloud=CLOUD give a cloud to work on, if not given, selected
or default cloud will be used
--count=COUNT give the number of servers to start
--detail for table print format, a brief version
is used as default, use this flag to print
detailed table
--flavor=FLAVOR give the name or id of the flavor
--group=GROUP give the group name of server
--secgroup=SECGROUP security group name for the server
--image=IMAGE give the name or id of the image
--key=KEY specify a key to use, input a string which
is the full path to the private key file
--keypair_name=KEYPAIR_NAME Name of the openstack keypair to be used to create VM.
Note this is not a path to key.
--user=USER give the user name of the server that you want
to use to login
--name=NAME give the name of the virtual machine
--force rename/ delete vms without user's confirmation
--command=COMMAND
specify the commands to be executed
Description:
commands used to boot, start or delete servers of a cloud
vm default [options...]
Displays default parameters that are set for vm boot either on the
default cloud or the specified cloud.
vm boot [options...]
Boots servers on a cloud, user may specify flavor, image .etc, otherwise default values
will be used, see how to set default values of a cloud: cloud help
vm start [options...]
Starts a suspended or stopped vm instance.
vm stop [options...]
Stops a vm instance .
vm delete [options...]
Delete servers of a cloud, user may delete a server by its name or id, delete servers
of a group or servers of a cloud, give prefix and/or range to find servers by their names.
Or user may specify more options to narrow the search
vm floating_ip_assign [options...]
assign a public ip to a VM of a cloud
vm ip show [options...]
show the ips of VMs
vm ssh [options...]
login to a server or execute commands on it
vm list [options...]
same as command "list vm", please refer to it
vm status [options...]
Retrieves status of last VM booted on cloud and displays it.
Tip:
give the VM name, but in a hostlist style, which is very
convenient when you need a range of VMs e.g. sample[1-3]
=> ['sample1', 'sample2', 'sample3']
sample[1-3,18] => ['sample1', 'sample2', 'sample3', 'sample18']
Quoting commands:
cm vm login gvonlasz-004 --command=\"uname -a\"
"""
"""
# terminate
# issues a termination to the cloud, keeps vm in database
# delete
# issues a terminate if not already done
# (remember you do not have to go to cloud if state is already terminated)
# deletes the vm from database
#
# bulk rename
rename abc[0-1] def[3-4] renames the abc0,abc1 -> def3,def4
if arguments["rename"]:
oldnames = Parameter.expand(arguments["OLDNAME"])
newnames = Parameter.expand(arguments["NEWNAME"])
# check if new names ar not already taken
# to be implemented
if len(oldnames) == len(newnames):
for i in range(0, len(oldnames)):
oldname = oldnames[i]
newname = newnames[i]
if newname is None or newname == '':
print("New node name cannot be empty")
else:
print(Cluster.rename_node(clusterid, oldname, newname))
"""
cm = CloudmeshDatabase()
def _print_dict(d, header=None, output='table'):
return Printer.write(d, order=["id", "name", "status"], output=output, sort_keys=True)
def _print_dict_ip(d, header=None, output='table'):
return Printer.write(d, order=["network", "version", "addr"], output=output, sort_keys=True)
def get_vm_name(name=None, offset=0, fill=3):
if name is None:
count = Default.get_counter(name='name') + offset
prefix = Default.user
if prefix is None or count is None:
Console.error("Prefix and Count could not be retrieved correctly.", traceflag=False)
return
name = prefix + "-" + str(count).zfill(fill)
return name
def _refresh_cloud(cloud):
try:
msg = "Refresh VMs for cloud {:}.".format(cloud)
if Vm.refresh(cloud=cloud):
Console.ok("{:} OK.".format(msg))
else:
Console.error("{:} failed".format(msg), traceflag=False)
except Exception as e:
Console.error("Problem running VM refresh", traceflag=False)
def _get_vm_names():
vm_list = cm.find(kind="vm")
vms = [vm["name"] for vm in vm_list]
names = pattern = arguments["NAMES"]
if pattern is not None:
if "*" in pattern:
names = search(vms, pattern)
else:
names = Parameter.expand(names)
if names == ['last'] or names is None:
names == [Default.vm]
return vm_list, names
cloud = arguments["--cloud"] or Default.cloud
config = ConfigDict("cloudmesh.yaml")
active_clouds = config["cloudmesh"]["active"]
def _refresh(cloud):
all = arguments["all"] or None
if all is None:
_refresh_cloud(cloud)
else:
for cloud in active_clouds:
_refresh_cloud(cloud)
arg = dotdict(arguments)
arg.cloud = arguments["--cloud"] or Default.cloud
arg.image = arguments["--image"] or Default.get(name="image", category=arg.cloud)
arg.flavor = arguments["--flavor"] or Default.get(name="flavor", category=arg.cloud)
arg.group = arguments["--group"] or Default.group
arg.secgroup = arguments["--secgroup"] or Default.secgroup
arg.key = arguments["--key"] or Default.key
arg.dryrun = arguments["--dryrun"]
arg.name = arguments["--name"]
arg.format = arguments["--format"] or 'table'
arg.refresh = Default.refresh or arguments["--refresh"]
arg.count = int(arguments["--n"] or 1)
arg.dryrun = arguments["--dryrun"]
arg.verbose = not arguments["--quiet"]
#
# in many cases use NAMES
# if arg.NAMES is not None:
# arg.names = Parameter.expand(arg.NAMES) # gvonlasz[001-002] gives ["gvonlasz-001", "gvonlasz-002"]
# else:
# arg.names = None
#
if arguments["boot"]:
arg.username = arguments["--username"] or Image.guess_username(arg.image)
is_name_provided = arg.name is not None
arg.user = Default.user
for index in range(0, arg.count):
vm_details = dotdict({
"cloud": arg.cloud,
"name": get_vm_name(arg.name, index),
"image": arg.image,
"flavor": arg.flavor,
"key": arg.key,
"secgroup": arg.secgroup,
"group": arg.group,
"username": arg.username,
"user": arg.user
})
# correct the username
vm_details.username = Image.guess_username_from_category(
vm_details.cloud,
vm_details.image,
username=arg.username)
try:
if arg.dryrun:
print(Printer.attribute(vm_details, output=arg.format))
msg = "dryrun info. OK."
Console.ok(msg)
else:
vm_id = Vm.boot(**vm_details)
if vm_id is None:
msg = "info. failed."
Console.error(msg, traceflag=False)
return ""
# set name and counter in defaults
Default.set_vm(value=vm_details.name)
if is_name_provided is False:
Default.incr_counter("name")
# Add to group
if vm_id is not None:
Group.add(name=vm_details.group,
species="vm",
member=vm_details.name,
category=vm_details.cloud)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Console.error("Problem booting instance {name}".format(**vm_details), traceflag=False)
elif arguments["username"]:
arg.username = arguments["--username"] or Image.guess_username(arg.image)
cloud = arg.cloud
username = arg.USERNAME
if arg.NAMES is None:
names = [Default.vm]
else:
names = Parameter.expand(arg.NAMES)
if len(names) == 0:
return
for name in names:
arg.name = name
Console.ok("Set username for {cloud}:{name} to {USERNAME}".format(**arg))
Vm.set_login_user(name=name, cloud=cloud, username=username)
elif arguments["default"]:
try:
count = Default.get_counter()
prefix = Username()
if prefix is None or count is None:
Console.error("Prefix and Count could not be retrieved correctly.", traceflag=False)
return
vm_name = prefix + "-" + str(count).zfill(3)
arg = {
"name": vm_name,
"cloud": arguments["--cloud"] or Default.cloud
}
for attribute in ["image", "flavor"]:
arg[attribute] = Default.get(name=attribute, category=cloud)
for attribute in ["key", "group", "secgroup"]:
arg[attribute] = Default.get(name=attribute, category='general')
output = arguments["--format"] or "table"
print(Printer.attribute(arg, output=output))
msg = "info. OK."
Console.ok(msg)
ValueError("default command not implemented properly. Upon "
"first install the defaults should be read from yaml.")
except Exception as e:
# Error.traceback(e)
Console.error("Problem listing defaults", traceflag=False)
elif arguments["ping"]:
try:
if arguments["NAME"] is None and arguments["N"] is None:
name = arguments["NAME"] or Default.vm
n = arguments["N"] or 1
elif arguments["NAME"].isdigit():
n = arguments["NAME"]
name = Default.vm
else:
name = arguments["NAME"] or Default.vm
n = arguments["N"] or 1
print("Ping:", name, str(n))
vm = dotdict(Vm.list(name=name, category=cloud, output="dict")["dict"])
ip = vm.floating_ip
result = Shell.ping(host=ip, count=n)
print(result)
except Exception as e:
Console.error(e.message, traceflag=False)
elif arguments["console"]:
try:
name = arguments["NAME"] or Default.vm
vm = dotdict(Vm.list(name=name, category=cloud, output="dict")["dict"])
cloud_provider = CloudProvider(cloud).provider
vm_list = cloud_provider.list_console(vm.uuid)
print(vm_list)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
# Error.traceback(e)
Console.error("Problem retrieving status of the VM", traceflag=False)
elif arguments["status"]:
try:
cloud_provider = CloudProvider(cloud).provider
vm_list = cloud_provider.list_vm(cloud)
vms = [vm_list[i]["name"] for i in vm_list ]
print ("V", vms)
pattern = arguments["NAMES"]
if pattern is not None:
if "*" in pattern:
print ("serach")
names = search(vms, pattern)
else:
names = Parameter.expand()
for i in vm_list:
if vm_list[i]["name"] in names:
print("{} {}".format(vm_list[i]["status"], vm_list[i]["name"]))
else:
print("{} {}".format(vm_list[0]["status"], vm_list[0]["name"]))
except Exception as e:
# Error.traceback(e)
Console.error("Problem retrieving status of the VM", traceflag=True)
elif arguments["wait"]:
interval = arguments["--interval"] or 5
try:
cloud_provider = CloudProvider(cloud).provider
for i in range(1,10):
vm_list = cloud_provider.list_vm(cloud)
time.sleep(float(1))
d = {}
for id in vm_list:
vm = vm_list[id]
d[vm["name"]] = vm["status"]
print (d)
print("{} {}".format(vm_list[0]["status"], vm_list[0]["name"]))
if vm_list[0]["status"] in ['ACTIVE']:
return
except Exception as e:
# Error.traceback(e)
Console.error("Problem retrieving status of the VM", traceflag=True)
elif arguments["info"]:
try:
cloud_provider = CloudProvider(cloud).provider
vms = cloud_provider.list_vm(cloud)
vm = vms[0]
output_format = arguments["--format"] or "table"
print(Printer.attribute(vm, output=output_format))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
# Error.traceback(e)
Console.error("Problem retrieving status of the VM", traceflag=False)
elif arguments["check"]:
test = {}
try:
names = Parameter.expand(arguments["NAME"])
id = 0
for name in names:
print("Not implemented: {}".format(name))
# TODO: check the status of the vms
status = "active"
# TODO: check if they have a floating ip
# TODO: get ip
floating_ip = "127.0.0.1"
ip = True
# ping
# TODO: ping the machine with the shell command
ping = True
# check if one can login and run a command
check = False
try:
r = Shell.execute("uname", "-a")
# do a real check
check = True
except:
check = False
test[name] = {
"id": id,
"name": name,
"status": status,
"ip": ip,
"ping": ping,
"login": check
}
id += 1
pprint(test)
print(Printer.write(test,
order=["id",
"name",
"status",
"ip",
"ping",
"login"],
output="table",
sort_keys=True))
msg = "not yet implemented. failed."
Console.error(msg, traceflag=False)
except Exception as e:
# Error.traceback(e)
Console.error("Problem retrieving status of the VM", traceflag=False)
elif arguments["start"]:
try:
servers = Parameter.expand(arguments["NAMES"])
# If names not provided, take the last vm from DB.
if len(servers) == 0:
last_vm = Default.vm
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.", traceflag=False)
return ""
name = last_vm["name"]
# print(name)
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.", traceflag=False)
return ""
Vm.start(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
# Error.traceback(e)
Console.error("Problem starting instances", traceflag=False)
elif arguments["stop"]:
try:
servers = Parameter.expand(arguments["NAMES"])
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Default.vm
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.", traceflag=False)
return ""
name = last_vm["name"]
# print(name)
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.", traceflag=False)
return ""
Vm.stop(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
# Error.traceback(e)
Console.error("Problem stopping instances", traceflag=False)
elif arguments["refresh"]:
_refresh(cloud)
elif arguments["delete"]:
dryrun = arguments["--dryrun"]
group = arguments["--group"]
force = not arguments["--keep"]
cloud = arguments["--cloud"]
vms, servers = _get_vm_names()
if servers in [None, []]:
Console.error("No vms found.", traceflag=False)
return ""
for server in servers:
if dryrun:
Console.ok("Dryrun: delete {}".format(server))
else:
Vm.delete(servers=[server], force=force)
return ""
elif arguments["ip"] and arguments["assign"]:
if arguments["NAMES"] is None:
names = [Default.vm]
else:
names = Parameter.expand(arguments["NAMES"])
for name in names:
# ip = Network.get_floatingip(....)
vm = dotdict(Vm.list(name=name, category=cloud, output="dict")["dict"])
if vm.floating_ip is None:
Console.ok("Assign IP to {}".format(name))
try:
floating_ip = Network.find_assign_floating_ip(cloudname=cloud,
instance_id=name)
Vm.refresh(cloud=cloud)
if floating_ip is not None:
print(
"Floating IP assigned to {:} is {:}".format(
name, floating_ip))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Console.error("Problem assigning floating ips.", traceflag=False)
else:
Console.error("VM {} already has a floating ip: {}".format(name, vm.floating_ip), traceflag=False)
elif arguments["ip"] and arguments["inventory"]:
vms, names = _get_vm_names()
if names in [None, []]:
if str(Default.vm) in ['None', None]:
Console.error("The default vm is not set.", traceflag=False)
return ""
else:
names = [Default.vm]
header = arguments["--header"] or "[servers]"
filename = arguments["--file"] or "inventory.txt"
try:
vm_ips = []
for vm in vms:
if vm["name"] in names:
print (vm["name"])
vm_ips.append(vm["floating_ip"])
result = header + "\n"
result += '\n'.join(vm_ips)
Console.ok("Creating inventory file: {}".format(filename))
Console.ok(result)
with open(filename, 'w') as f:
f.write(result)
except Exception as e:
Console.error("Problem getting ip addresses for instance", traceflag=True)
elif arguments["ip"] and arguments["show"]:
if arguments["NAMES"] is None:
if str(Default.vm) in ['None', None]:
Console.error("The default vm is not set.", traceflag=False)
return ""
else:
names = [Default.vm]
else:
names = Parameter.expand(arguments["NAMES"])
group = arguments["--group"]
output_format = arguments["--format"] or "table"
refresh = arguments["--refresh"]
try:
ips = Ip.list(cloud=arg.cloud, output=output_format, names=names)
print(ips)
except Exception as e:
Console.error("Problem getting ip addresses for instance", traceflag=False)
elif arguments["ssh"]:
def _print(msg):
if arg.verbose:
Console.msg(msg)
chameleon = "chameleon" in ConfigDict(filename="cloudmesh.yaml")["cloudmesh"]["clouds"][arg.cloud][
"cm_host"]
if chameleon:
arg.username = "******"
elif arg.cloud == "azure":
arg.username = ConfigDict(filename="cloudmesh.yaml")["cloudmesh"]["clouds"]["azure"]["default"]["username"]
else:
if arg.username is None:
Console.error("Could not guess the username of the vm", traceflag=False)
return
arg.username = arguments["--username"] or Image.guess_username(arg.image)
arg.command = arguments["--command"]
data = dotdict({
'name': arguments["NAME"] or Default.vm,
'username': arg.username,
'cloud': arg.cloud,
'command': arg.command
})
_print("login {cloud}:{username}@{name}".format(**data))
vm = Vm.get(data.name, category=data.cloud)
Vm.set_login_user(name=data.name, cloud=data.cloud, username=data.username)
data.floating_ip = vm.floating_ip
data.key = arguments["--key"] or Default.key
_print(Printer.attribute(data))
'''
if vm.username is None:
user_from_db = Vm.get_login_user(vm.name, vm.cloud)
user_suggest = user_from_db or Default.user
username = input("Username (Default: {}):".format(user_suggest)) or user_suggest
Vm.set_login_user(name=data.name, cloud=cloud, username=data.username)
'''
ip = arguments["--ip"]
commands = arguments["--command"]
ip_addresses = []
cloud_provider = CloudProvider(cloud).provider
ip_addr = cloud_provider.get_ips(vm.name)
ipaddr_dict = Vm.construct_ip_dict(ip_addr, cloud)
for entry in ipaddr_dict:
ip_addresses.append(ipaddr_dict[entry]["addr"])
if len(ip_addresses) > 0:
if ip is not None:
if ip not in ip_addresses:
Console.error("IP Address specified does not match with the host.", traceflag=False)
return ""
else:
_print("Determining IP Address to use with a ping test.")
# This part assumes that the ping is allowed to the machine.
for ipadd in ip_addresses:
_print("Checking {:}...".format(ipadd))
try:
# Evading ping test, as ping is not enabled for VMs on Azure cloud
# socket.gethostbyaddr(ipadd)
# ip will be set if above command is successful.
ip = ipadd
except socket.herror:
_print("Cannot reach {:}.".format(ipadd))
if ip is None:
_print("Unable to connect to the machine")
return ""
else:
_print("IP to be used is: {:}".format(ip))
#
# TODO: is this correctly implemented
#
if not cloud == 'azure':
SecGroup.enable_ssh(cloud=cloud)
if arg.verbose:
Console.info("Connecting to Instance at IP:" + format(ip))
# Constructing the ssh command to connect to the machine.
sshcommand = "ssh"
if arg.key is not None:
sshcommand += " -i {:}".format(arg.key)
sshcommand += " -o StrictHostKeyChecking=no"
sshcommand += " {:}@{:}".format(data.username, ip)
if commands is not None:
sshcommand += " \"{:}\"".format(commands)
# print(sshcommand)
os.system(sshcommand)
else:
Console.error("No Public IPs found for the instance", traceflag=False)
elif arguments["list"]:
# groups = Group.list(output="dict")
arg = dotdict(arguments)
arg.names = arguments["NAMES"]
arg.group = arguments["--group"]
if arg.group is None:
arg.group = []
else:
arg.group = Parameter.expand(arguments["--group"])
arg.refresh = arguments["--refresh"] or Default.refresh
if arg.NAMES is not None:
arg.names = Parameter.expand(arguments["NAMES"])
else:
arg.names = ["all"]
_format = arguments["--format"] or "table"
if arguments["--active"]:
clouds = active_clouds
else:
if arguments["--cloud"]:
clouds = Parameter.expand(arguments["--cloud"])
else:
clouds = [Default.cloud]
try:
d = ConfigDict("cloudmesh.yaml")
for cloud in clouds:
if arg.refresh:
_refresh(cloud)
Console.ok("Listing VMs on Cloud: {:}".format(cloud))
vms = Vm.list(category=cloud, output="raw")
# print ("XXX", type(vms), vms)
if vms is None:
break
result = []
if "all" in arg.names:
if result is None:
result = []
else:
result = vms
elif arg.group is not None and len(arg.group) > 0:
for vm in vms:
if vm["group"] in arg.group:
result.append(vm)
elif arg.names is not None and len(arg.names) > 0:
for vm in vms:
if vm["name"] in arg.names:
result.append(vm)
if len(result) > 0:
# print(result)
(order, header) = CloudProvider(cloud).get_attributes("vm")
print(Printer.write(result,
order=order,
output=_format)
)
else:
Console.error("No data found with requested parameters.", traceflag=False)
except Exception as e:
# Error.traceback(e)
Console.error("Problem listing all instances", traceflag=False)
elif arguments["rename"]:
try:
oldnames = Parameter.expand(arguments["OLDNAMES"])
newnames = Parameter.expand(arguments["NEWNAMES"])
force = arguments["--force"]
if oldnames is None or newnames is None:
Console.error("Wrong VMs specified for rename", traceflag=False)
elif len(oldnames) != len(newnames):
Console.error("The number of VMs to be renamed is wrong",
traceflat=False)
else:
for i in range(0, len(oldnames)):
oldname = oldnames[i]
newname = newnames[i]
if arguments["--dryrun"]:
Console.ok("Rename {} to {}".format(oldname, newname))
else:
Vm.rename(cloud=cloud,
oldname=oldname,
newname=newname,
force=force
)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
# Error.traceback(e)
Console.error("Problem deleting instances", traceflag=False)
return ""
def do_nova(self, args, arguments):
"""
::
Usage:
nova set CLOUD
nova info [CLOUD] [--password]
nova help
nova [--group=GROUP] ARGUMENTS...
A simple wrapper for the openstack nova command
Arguments:
GROUP The group to add vms to
ARGUMENTS The arguments passed to nova
help Prints the nova manual
set reads the information from the current cloud
and updates the environment variables if
the cloud is an openstack cloud
info the environment values for OS
Options:
--group=GROUP Add VM to GROUP group
--password Prints the password
-v verbose mode
"""
# pprint(arguments)
cloud = arguments['CLOUD'] or Default.cloud
if not cloud:
Console.error("Default cloud not set!")
return ""
group = arguments["--group"] or Default.group
if not group:
Console.error("Default group not set!")
return ""
if arguments["help"]:
os.system("nova help")
return ""
elif arguments["info"]:
set_os_environ(cloud)
d = {}
#
# TODO: this naturally does not work as clouds will have
# different parameters. ALos it does not unset previous
# parameters from other clouds. See register
#
for attribute in ['OS_USERNAME',
'OS_TENANT_NAME',
'OS_AUTH_URL',
'OS_CACERT',
'OS_PASSWORD',
'OS_REGION']:
try:
d[attribute] = os.environ[attribute]
except:
Console.warning("OS environment variable {:} not found"
.format(attribute))
d[attribute] = None
if not arguments["--password"]:
d['OS_PASSWORD'] = "******"
print(Printer.row_table(d, order=None, labels=["Variable", "Value"]))
msg = "info. OK."
Console.ok(msg)
return ""
elif arguments["set"]:
if cloud:
set_os_environ(cloud)
msg = "{0} is set".format(cloud)
Console.ok(msg)
else:
Console.error("CLOUD is required")
else: # nova ARGUMENTS...
print("Cloud = {0}".format(cloud))
try:
set_os_environ(cloud)
args = arguments["ARGUMENTS"]
# arguments may contain multiple optional arguments
if len(args) == 1:
args = args[0].split()
result = Shell.execute("nova", args)
print (result)
# print(Nova.remove_subjectAltName_warning(result))
"""
If request for nova boot,
add the vm to group specified,
or else add to default group
"""
if "boot" in args:
# Logic to find ID of VM in the result
fields = []
for field in result.split("|"):
fields.append(field.strip())
index = fields.index('id') + 1
vm_id = fields[index]
# Add to group
Group.add(name=group, species="vm", member=vm_id, category=cloud)
except Exception as ex:
Console.error("Error executing Nova command: {}".format(ex))
return ""
def do_group(self, args, arguments):
"""
::
Usage:
group add NAME [--type=TYPE] [--category=CLOUD] --id=IDs
group list [--category=CLOUD] [--format=FORMAT] [NAME]
group delete NAME [--category=CLOUD]
group remove [--category=CLOUD] --name=NAME --id=ID
group copy FROM TO
group merge GROUPA GROUPB MERGEDGROUP
manage the groups
Arguments:
NAME name of a group
FROM name of a group
TO name of a group
GROUPA name of a group
GROUPB name of a group
MERGEDGROUP name of a group
Options:
--category=CLOUD the name of the category
--format=FORMAT the output format
--type=TYPE the resource type
--name=NAME the name of the group
--id=IDS the ID(s) to add to the group
Description:
Todo: design parameters that are useful and match
description
Todo: discuss and propose command
cloudmesh can manage groups of resources and category related
objects. As it would be cumbersome to for example delete
many virtual machines or delete VMs that are in the same
group, but are running in different clouds.
Hence it is possible to add a virtual machine to a
specific group. The group name to be added to can be set
as a default. This way all subsequent commands use this
default group. It can also be set via a command parameter.
Another convenience function is that the group command can
use the last used virtual machine. If a vm is started it
will be automatically added to the default group if it is set.
The delete command has an optional category parameter so that
deletion of vms of a partial group by cloud can be
achieved.
If finer grained deletion is needed, it can be achieved
with the delete command that supports deletion by name
It is also possible to remove a VM from the group using the
remove command, by supplying the ID
Example:
default group mygroup
group add --type=vm --id=albert-[001-003]
adds the vms with teh given name using the Parameter
see base
group add --type=vm
adds the last vm to the group
group delete --name=mygroup
deletes all objects in the group
"""
# pprint(arguments)
category = arguments["--category"] or Default.get_cloud()
if arguments["list"]:
output = arguments["--format"] or Default.get("format",
category) or "table"
name = arguments["NAME"]
if name is None:
result = Group.list(format=output, category=category)
if result:
print(result)
else:
print("There are no groups in the cloudmesh database!")
else:
result = Group.get_info(name=name,
category=category,
output=output)
if result:
print(result)
else:
msg_a = ("No group found with name `{name}` found in the "
"category `{category}`.".format(**locals()))
# find alternate
result = Group.get(name=name)
msg_b = ""
if result is not None:
msg_b = " However we found such a variable in " \
"category `{category}`. Please consider " \
"using --category={category}".format(**result)
Console.error(msg_a + msg_b)
return
elif arguments["add"]:
type = arguments["--type"] or Default.get("type", category)
category_id = arguments["--id"] or Default.get("id", category)
data = {
"name": arguments["NAME"],
"type": type,
"category": category,
"id": category_id
}
Group.add(**data)
return
elif arguments["delete"]:
data = {
"name": arguments["NAME"],
"category": category,
}
result = Group.delete(**data)
if result:
Console.ok("Deletion completed. ok.")
else:
Console.error(
"No group with name `{name}` found".format(**data))
return
elif arguments["remove"]:
name = arguments["--name"]
category_id = arguments["--id"]
if not category:
Console.error("Default category not set!")
return
result = Group.remove(name, category_id, category)
if result:
Console.ok(result)
else:
Console.error(
"Failed to delete ID [{}] from group [{}] in the database!"
.format(category_id, name))
return
elif arguments["copy"]:
_from = arguments["FROM"]
_to = arguments["TO"]
Group.copy(_from, _to)
return
elif arguments["merge"]:
_groupA = arguments["GROUPA"]
_groupB = arguments["GROUPB"]
_mergedGroup = arguments["MERGEDGROUP"]
Group.merge(_groupA, _groupB, _mergedGroup)
return
def do_vm(self, args, arguments):
"""
::
Usage:
vm default [--cloud=CLOUD][--format=FORMAT]
vm refresh [--cloud=CLOUD]
vm boot [--name=NAME]
[--cloud=CLOUD]
[--image=IMAGE_OR_ID]
[--flavor=FLAVOR_OR_ID]
[--group=GROUP]
[--secgroup=SECGROUP]
[--key=KEY]
[--dryrun]
vm start [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm stop [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm delete [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm ip assign [NAME]...
[--cloud=CLOUD]
vm ip show [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--format=FORMAT]
[--refresh]
vm login [NAME] [--user=USER]
[--ip=IP]
[--cloud=CLOUD]
[--key=KEY]
[--command=COMMAND]
vm rename [NAME]...
[--new=NEWNAME]
[--cloud=CLOUD]
vm list [NAME_OR_ID]
[--cloud=CLOUD|--all]
[--group=GROUP]
[--format=FORMAT]
[--refresh]
vm status [--cloud=CLOUD]
vm info [--cloud=CLOUD]
[--format=FORMAT]
Arguments:
COMMAND positional arguments, the commands you want to
execute on the server(e.g. ls -a) separated by ';',
you will get a return of executing result instead of login to
the server, note that type in -- is suggested before
you input the commands
NAME server name. By default it is set to the name of last vm from database.
NAME_OR_ID server name or ID
KEYPAIR_NAME Name of the openstack keypair to be used to create VM. Note this is not a path to key.
NEWNAME New name of the VM while renaming.
Options:
--ip=IP give the public ip of the server
--cloud=CLOUD give a cloud to work on, if not given, selected
or default cloud will be used
--count=COUNT give the number of servers to start
--detail for table print format, a brief version
is used as default, use this flag to print
detailed table
--flavor=FLAVOR_OR_ID give the name or id of the flavor
--group=GROUP give the group name of server
--secgroup=SECGROUP security group name for the server
--image=IMAGE_OR_ID give the name or id of the image
--key=KEY specify a key to use, input a string which
is the full path to the private key file
--keypair_name=KEYPAIR_NAME Name of the openstack keypair to be used to create VM.
Note this is not a path to key.
--user=USER give the user name of the server that you want
to use to login
--name=NAME give the name of the virtual machine
--force delete vms without user's confirmation
--command=COMMAND
specify the commands to be executed
--new=NEWNAME Specify the new name for a VM while renaming.
By default, this will be set to <username>-<count> format.
Description:
commands used to boot, start or delete servers of a cloud
vm default [options...] Displays default parameters that are set for VM boot.
vm boot [options...] Boots servers on a cloud, user may specify
flavor, image .etc, otherwise default values
will be used, see how to set default values
of a cloud: cloud help
vm start [options...] Starts a suspended or stopped vm instance.
vm stop [options...] Stops a vm instance .
vm delete [options...] delete servers of a cloud, user may delete
a server by its name or id, delete servers
of a group or servers of a cloud, give prefix
and/or range to find servers by their names.
Or user may specify more options to narrow
the search
vm floating_ip_assign [options...] assign a public ip to a VM of a cloud
vm ip show [options...] show the ips of VMs
vm login [options...] login to a server or execute commands on it
vm list [options...] same as command "list vm", please refer to it
vm status [options...] Retrieves status of last VM booted on cloud and displays it.
Tip:
give the VM name, but in a hostlist style, which is very
convenient when you need a range of VMs e.g. sample[1-3]
=> ['sample1', 'sample2', 'sample3']
sample[1-3,18] => ['sample1', 'sample2', 'sample3', 'sample18']
"""
def _print_dict(d, header=None, format='table'):
if format == "json":
return json.dumps(d, indent=4)
elif format == "yaml":
return pyaml.dump(d)
elif format == "table":
return dict_printer(d,
order=["id",
"name",
"status"],
output="table",
sort_keys=True)
else:
return d
def _print_dict_ip(d, header=None, format='table'):
if format == "json":
return json.dumps(d, indent=4)
elif format == "yaml":
return pyaml.dump(d)
elif format == "table":
return dict_printer(d,
order=["network",
"version",
"addr"],
output="table",
sort_keys=True)
else:
return d
"""
def list_vms_on_cloud(cloud="kilo", group=None, format="table"):
Utility reusable function to list vms on the cloud.
:param cloud:
:param group:
:param format:
:return:
_cloud = cloud
_group = group
_format = format
cloud_provider = CloudProvider(_cloud).provider
servers = cloud_provider.list_vm(_cloud)
server_list = {}
index = 0
# TODO: Improve the implementation to display more fields if required.
for server in servers:
server_list[index] = {}
server_list[index]["name"] = server.name
server_list[index]["id"] = server.id
server_list[index]["status"] = server.status
index += 1
# TODO: Get this printed in a table
print("Print table")
dict_printer(servers, output=_format)
"""
# pprint(arguments)
def _refresh():
try:
msg = "Refresh VMs for cloud {:}.".format(cloud)
if Vm.refresh(cloud=cloud):
Console.ok("{:} OK.".format(msg))
else:
Console.error("{:} failed".format(msg))
except Exception as e:
Error.traceback(e)
Console.error("Problem running VM refresh")
cloud = arguments["--cloud"] or Default.get_cloud()
if arguments["boot"]:
name = None
try:
name = arguments["--name"]
is_name_provided = True
if name is None:
is_name_provided = False
count = Counter.get()
prefix = Username()
if prefix is None or count is None:
Console.error("Prefix and Count could not be retrieved correctly.")
return
# BUG THE Z FILL SHOULD BE detected from yaml file
name = prefix + "-" + str(count).zfill(3)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
image = arguments["--image"] or Default.get("image",
category=cloud)
# if default image not set, return error
if not image:
Console.error("Default image not set.")
return ""
flavor = arguments["--flavor"] or Default.get("flavor",
category=cloud)
# if default flavor not set, return error
if not flavor:
Console.error("Default flavor not set.")
return ""
group = arguments["--group"] or Default.get_group()
# if default group not set, return error
if not group:
group = "default"
Default.set_group(group)
secgroup = arguments["--secgroup"] or Default.get(
"secgroup", category=cloud)
# print("SecurityGrp : {:}".format(secgroup))
secgroup_list = ["default"]
if secgroup is not None:
secgroup_list.append(secgroup)
key_name = arguments["--key"] or Default.get_key()
# if default keypair not set, return error
if not key_name:
Console.error("Default key not set.")
return ""
if arguments["--dryrun"]:
data = {
"cloud": cloud,
"name": name,
"image": image,
"flavor": flavor,
"key_name": key_name,
"secgroup_list": secgroup_list,
"group": group
}
print (attribute_printer(data, output="table"))
msg = "dryrun info. OK."
Console.ok(msg)
else:
vm_id = Vm.boot(cloud=cloud,
name=name,
image=image,
flavor=flavor,
key_name=key_name,
secgroup_list=secgroup_list)
Default.set("last_vm_id", vm_id)
Default.set("last_vm_name", name)
# SHOULD WE NOT DO THIS BY DEFAULT EVEN IF WE SPECIFY THE NAME?
if is_name_provided is False:
# Incrementing count
Counter.incr()
# Add to group
if vm_id is not None:
Group.add(name=group, type="vm", id=name,
category=cloud)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem booting instance {:}".format(name))
elif arguments["default"]:
try:
count = Counter.get()
prefix = Username()
if prefix is None or count is None:
Console.error("Prefix and Count could not be retrieved correctly.")
return
vm_name = prefix + "-" + str(count).zfill(3)
data = {"name": vm_name,
"cloud": arguments["--cloud"] or Default.get_cloud()}
for attribute in ["image", "flavor", "key", "login_key", "group", "secgroup"]:
data[attribute] = Default.get(attribute, category=cloud)
output_format = arguments["--format"] or "table"
print (attribute_printer(data, output=output_format))
msg = "info. OK."
Console.ok(msg)
ValueError("default command not implemented properly. Upon "
"first install the defaults should be read from yaml.")
except Exception as e:
Error.traceback(e)
Console.error("Problem listing defaults")
elif arguments["status"]:
try:
cloud_provider = CloudProvider(cloud).provider
vm_list = cloud_provider.list_vm(cloud)
print("Status of VM {} is {}".format(vm_list[0]["name"], vm_list[0]["status"]))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem retrieving status of the VM")
elif arguments["info"]:
try:
cloud_provider = CloudProvider(cloud).provider
vms = cloud_provider.list_vm(cloud)
vm = vms[0]
output_format = arguments["--format"] or "table"
print (attribute_printer(vm, output=output_format))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem retrieving status of the VM")
elif arguments["start"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
# print(name)
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
Vm.start(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem starting instances")
elif arguments["stop"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
# print(name)
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
Vm.stop(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem stopping instances")
elif arguments["refresh"]:
_refresh()
elif arguments["delete"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
Vm.delete(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem deleting instances")
elif arguments["ip"] and arguments["assign"]:
vmids = arguments["NAME"]
# If names not provided, take the last vm from DB.
if vmids is None or len(vmids) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
vmids = list()
vmids.append(name)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
try:
cloud_provider = CloudProvider(cloud).provider
for sname in vmids:
floating_ip = cloud_provider.create_assign_floating_ip(
sname)
if floating_ip is not None:
print(
"Floating IP assigned to {:} successfully and it is: {:}".format(
sname, floating_ip))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem assigning floating ips.")
elif arguments["ip"] and arguments["show"]:
vmids = arguments["NAME"]
# If names not provided, take the last vm from DB.
if vmids is None or len(vmids) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
vmids = list()
vmids.append(name)
group = arguments["--group"]
output_format = arguments["--format"] or "table"
refresh = arguments["--refresh"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
try:
cloud_provider = CloudProvider(cloud).provider
for server in vmids:
ip_addr = cloud_provider.get_ips(server)
ipaddr_dict = Vm.construct_ip_dict(ip_addr, cloud)
print(
"IP Addresses of instance {:} are as follows:-".format(
server))
print(_print_dict_ip(ipaddr_dict, format=output_format))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error(
"Problem getting ip addresses for instance {:}".format(id))
elif arguments["login"]:
vm_names = arguments["NAME"]
# If names not provided, take the last vm from DB.
if vm_names is None or len(vm_names) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
else:
name = vm_names[0]
print("Logging in into {:} machine...".format(name))
user = arguments["--user"]
# Get user if user argument not specified.
if user is None:
user_from_db = Vm.get_vm_login_user(name, cloud)
user_suggest = user_from_db or getpass.getuser()
user = input("Enter the user to login (Default: {}):".format(user_suggest)) or user_suggest
Vm.set_vm_login_user(name, cloud, user)
ip = arguments["--ip"]
commands = arguments["--command"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
key = arguments["--key"] or Default.get("login_key",
category=cloud)
if not key:
Console.error("Default login_key not set.")
return ""
cloud_provider = CloudProvider(cloud).provider
# print("Name : {:}".format(name))
ip_addr = cloud_provider.get_ips(name)
ip_addresses = []
ipaddr_dict = Vm.construct_ip_dict(ip_addr, cloud)
for entry in ipaddr_dict:
ip_addresses.append(ipaddr_dict[entry]["addr"])
if ip is not None:
if ip not in ip_addresses:
print(
"ERROR: IP Address specified does not match with the host.")
return ""
else:
print("Determining IP Address to use with a ping test.")
# This part assumes that the ping is allowed to the machine.
for ipadd in ip_addresses:
print("Checking {:}...".format(ipadd))
try:
socket.gethostbyaddr(ipadd)
# ip will be set if above command is successful.
ip = ipadd
except socket.herror:
print("Cannot reach {:}.".format(ipadd))
if ip is None:
print("SORRY. Unable to connect to the machine")
return ""
else:
print("IP to be used is: {:}".format(ip))
SecGroup.enable_ssh(cloud=cloud)
# print("COMMANDS : {:}".format(commands))
# Constructing the ssh command to connect to the machine.
sshcommand = "ssh"
if key is not None:
sshcommand += " -i {:}".format(key)
sshcommand += " -o StrictHostKeyChecking=no"
sshcommand += " {:}@{:}".format(user, ip)
if commands is not None:
sshcommand += " \"{:}\"".format(commands)
# print(sshcommand)
os.system(sshcommand)
elif arguments["list"]:
if arguments["--all"]:
try:
_format = arguments["--format"] or "table"
d = ConfigDict("cloudmesh.yaml")
for cloud in d["cloudmesh"]["clouds"]:
if arguments["--refresh"] or Default.refresh():
_refresh()
print("Listing VMs on Cloud: {:}".format(cloud))
result = Vm.list(cloud=cloud, output_format=_format)
if result is not None:
print(result)
else:
print("Sorry. No data found with requested parameters in DB.")
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem listing all instances")
else:
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
try:
name_or_id = arguments["NAME_OR_ID"]
group = arguments["--group"]
_format = arguments["--format"] or "table"
# list_vms_on_cloud(cloud, group, _format)
if arguments["--refresh"] or Default.refresh():
_refresh()
result = Vm.list(name_or_id=name_or_id, cloud=cloud, output_format=_format)
if result is not None:
print(result)
else:
print("No data found with the requested parameters.")
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error(
"Problem listing instances on cloud {:}".format(cloud))
elif arguments["rename"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error("No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
servers = list()
servers.append(name)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
new_name = arguments["--new"]
is_name_provided = True
# If the new name is not provided, make the new new name in format username-count.
if new_name is None or len(new_name) == 0:
is_name_provided = False
count = Counter.get()
prefix = Username()
if prefix is None or count is None:
Console.error("Prefix and Count could not be retrieved correctly.")
return
# BUG THE Z FILL SHOULD BE detected from yaml file
new_name = prefix + "-" + str(count).zfill(3)
Vm.rename(cloud=cloud, servers=servers, new_name=new_name)
if is_name_provided is False:
# Incrementing count
Counter.incr()
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem deleting instances")
return ""
def do_nova(self, args, arguments):
"""
::
Usage:
nova set CLOUD
nova info [CLOUD] [--password]
nova help
nova [--group=GROUP] ARGUMENTS...
A simple wrapper for the openstack nova command
Arguments:
GROUP The group to add vms to
ARGUMENTS The arguments passed to nova
help Prints the nova manual
set reads the information from the current cloud
and updates the environment variables if
the cloud is an openstack cloud
info the environment values for OS
Options:
--group=GROUP Add VM to GROUP group
--password Prints the password
-v verbose mode
"""
# pprint(arguments)
cloud = arguments['CLOUD'] or Default.get_cloud()
if not cloud:
Console.error("Default cloud not set!")
return ""
group = arguments["--group"] or Default.get("group", category=cloud)
if not group:
Console.error("Default group not set!")
return ""
if arguments["help"]:
os.system("nova help")
return ""
elif arguments["info"]:
set_os_environ(cloud)
d = {}
#
# TODO: this naturally does not work as clouds will have
# different parameters. ALos it does not unset previous
# parameters from other clouds. See register
#
for attribute in [
'OS_USERNAME', 'OS_TENANT_NAME', 'OS_AUTH_URL',
'OS_CACERT', 'OS_PASSWORD', 'OS_REGION'
]:
try:
d[attribute] = os.environ[attribute]
except:
Console.warning(
"OS environment variable {:} not found".format(
attribute))
d[attribute] = None
if not arguments["--password"]:
d['OS_PASSWORD'] = "******"
print(row_table(d, order=None, labels=["Variable", "Value"]))
msg = "info. OK."
Console.ok(msg)
return ""
elif arguments["set"]:
if cloud:
set_os_environ(cloud)
msg = "{0} is set".format(cloud)
Console.ok(msg)
else:
Console.error("CLOUD is required")
else: # nova ARGUMENTS...
print("Cloud = {0}".format(cloud))
try:
set_os_environ(cloud)
args = arguments["ARGUMENTS"]
# arguments may contain multiple optional arguments
if len(args) == 1:
args = args[0].split()
result = Shell.execute("nova", args)
print(Nova.remove_subjectAltName_warning(result))
"""
If request for nova boot,
add the vm to group specified,
or else add to default group
"""
if "boot" in args:
# Logic to find ID of VM in the result
fields = []
for field in result.split("|"):
fields.append(field.strip())
index = fields.index('id') + 1
vm_id = fields[index]
# Add to group
Group.add(name=group, type="vm", id=vm_id, category=cloud)
except Exception as ex:
Console.error("Error executing Nova command: {}".format(ex))
return ""
def do_group(self, args, arguments):
"""
::
Usage:
group list [GROUPNAME] [--format=FORMAT]
group remove NAMES [--group=GROUPNAME]
group add NAMES [--type=TYPE] [--group=GROUPNAME]
group delete GROUPS
group copy FROM TO
group merge GROUPA GROUPB MERGEDGROUP
manage the groups
Arguments:
NAMES names of object to be added
GROUPS names of a groups
FROM name of a group
TO name of a group
GROUPA name of a group
GROUPB name of a group
MERGEDGROUP name of a group
Options:
--format=FORMAT the output format
--type=TYPE the resource type
--name=NAME the name of the group
--id=IDS the ID(s) to add to the group
Description:
Todo: design parameters that are useful and match
description
Todo: discuss and propose command
cloudmesh can manage groups of resource related
objects. As it would be cumbersome to for example delete
many virtual machines or delete VMs that are in the same
group, but are running in different clouds.
Hence it is possible to add a virtual machine to a
specific group. The group name to be added to can be set
as a default. This way all subsequent commands use this
default group. It can also be set via a command parameter.
Another convenience function is that the group command can
use the last used virtual machine. If a vm is started it
will be automatically added to the default group if it is set.
If finer grained deletion is needed, it can be achieved
with the delete command that supports deletion by name
It is also possible to remove a VM from the group using the
remove command, by supplying the ID
Note:
The type is internally called for the group species, we may
eliminate the species column and just use the type column for it,
Example:
default group mygroup
group add --type=vm --id=albert-[001-003]
adds the vms with the given name using the Parameter
see base
group add --type=vm
adds the last vm to the group
group delete --name=mygroup
deletes all objects in the group
"""
# pprint(arguments)
if arguments["list"]:
output = arguments["--format"] or Default.get(
name="format", category="general") or "table"
name = arguments["GROUPNAME"]
if name is None:
result = Group.list(output=output)
if result:
print(result)
else:
print(
"No groups found other than the default group but it has no members."
)
else:
result = Group.list(name=name, output=output)
if result:
print(result)
else:
msg_a = ("No group found with name `{name}` found in the "
"category `{category}`.".format(**locals()))
'''
# find alternate
result = Group.get(name=name)
msg_b = ""
if result is not None and len(result) < 0:
msg_b = " However we found such a variable in " \
"category `{category}`. Please consider " \
"using --category={category}".format(**locals())
Console.error(msg_a + msg_b)
else:
Console.error("No group with name {name} exists.".format(**locals()))
'''
return ""
elif arguments["add"]:
# group add NAME... [--type=TYPE] [--category=CLOUD] [--group=GROUP]
print("AAA", arguments["NAMES"])
members = Parameter.expand(arguments["NAMES"])
print("MMMM", members)
data = dotdict({
"species": arguments["--type"] or "vm",
"name": arguments["--group"] or Default.group
})
print("DDD", data)
for member in members:
data.member = member
pprint(data)
Group.add(**data)
return ""
elif arguments["delete"]:
groups = Parameter.expand(arguments["GROUPS"])
for group in groups:
result = Group.delete(group)
if result:
Console.ok(result)
else:
Console.error("delete group {}. failed.".format(group))
return ""
elif arguments["remove"]:
members = Parameter.expand(arguments["NAMES"])
group = arguments["--group"] or Default.group
for member in members:
result = Group.remove(group, member)
if result:
Console.ok(result)
else:
Console.error("remove {} from group {}. failed.".format(
group, member))
return ""
elif arguments["copy"]:
_from = arguments["FROM"]
_to = arguments["TO"]
Group.copy(_from, _to)
return ""
elif arguments["merge"]:
_groupA = arguments["GROUPA"]
_groupB = arguments["GROUPB"]
_mergedGroup = arguments["MERGEDGROUP"]
Group.merge(_groupA, _groupB, _mergedGroup)
return ""
def do_vm(self, args, arguments):
"""
::
Usage:
vm default [--cloud=CLOUD][--format=FORMAT]
vm refresh [--cloud=CLOUD]
vm boot [--name=NAME]
[--cloud=CLOUD]
[--image=IMAGE_OR_ID]
[--flavor=FLAVOR_OR_ID]
[--group=GROUP]
[--secgroup=SECGROUP]
[--key=KEY]
[--dryrun]
vm start [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm stop [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm delete [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm ip assign [NAME]...
[--cloud=CLOUD]
vm ip show [NAME]...
[--group=GROUP]
[--cloud=CLOUD]
[--format=FORMAT]
[--refresh]
vm login [NAME] [--user=USER]
[--ip=IP]
[--cloud=CLOUD]
[--key=KEY]
[--command=COMMAND]
vm rename [NAME]...
[--new=NEWNAME]
[--cloud=CLOUD]
vm list [NAME_OR_ID]
[--cloud=CLOUD|--all]
[--group=GROUP]
[--format=FORMAT]
[--refresh]
vm status [--cloud=CLOUD]
vm info [--cloud=CLOUD]
[--format=FORMAT]
Arguments:
COMMAND positional arguments, the commands you want to
execute on the server(e.g. ls -a) separated by ';',
you will get a return of executing result instead of login to
the server, note that type in -- is suggested before
you input the commands
NAME server name. By default it is set to the name of last vm from database.
NAME_OR_ID server name or ID
KEYPAIR_NAME Name of the openstack keypair to be used to create VM. Note this is not a path to key.
NEWNAME New name of the VM while renaming.
Options:
--ip=IP give the public ip of the server
--cloud=CLOUD give a cloud to work on, if not given, selected
or default cloud will be used
--count=COUNT give the number of servers to start
--detail for table print format, a brief version
is used as default, use this flag to print
detailed table
--flavor=FLAVOR_OR_ID give the name or id of the flavor
--group=GROUP give the group name of server
--secgroup=SECGROUP security group name for the server
--image=IMAGE_OR_ID give the name or id of the image
--key=KEY specify a key to use, input a string which
is the full path to the private key file
--keypair_name=KEYPAIR_NAME Name of the openstack keypair to be used to create VM.
Note this is not a path to key.
--user=USER give the user name of the server that you want
to use to login
--name=NAME give the name of the virtual machine
--force delete vms without user's confirmation
--command=COMMAND
specify the commands to be executed
--new=NEWNAME Specify the new name for a VM while renaming.
By default, this will be set to <username>-<count> format.
Description:
commands used to boot, start or delete servers of a cloud
vm default [options...] Displays default parameters that are set for VM boot.
vm boot [options...] Boots servers on a cloud, user may specify
flavor, image .etc, otherwise default values
will be used, see how to set default values
of a cloud: cloud help
vm start [options...] Starts a suspended or stopped vm instance.
vm stop [options...] Stops a vm instance .
vm delete [options...] delete servers of a cloud, user may delete
a server by its name or id, delete servers
of a group or servers of a cloud, give prefix
and/or range to find servers by their names.
Or user may specify more options to narrow
the search
vm floating_ip_assign [options...] assign a public ip to a VM of a cloud
vm ip show [options...] show the ips of VMs
vm login [options...] login to a server or execute commands on it
vm list [options...] same as command "list vm", please refer to it
vm status [options...] Retrieves status of last VM booted on cloud and displays it.
Tip:
give the VM name, but in a hostlist style, which is very
convenient when you need a range of VMs e.g. sample[1-3]
=> ['sample1', 'sample2', 'sample3']
sample[1-3,18] => ['sample1', 'sample2', 'sample3', 'sample18']
"""
def _print_dict(d, header=None, format='table'):
if format == "json":
return json.dumps(d, indent=4)
elif format == "yaml":
return pyaml.dump(d)
elif format == "table":
return dict_printer(d,
order=["id", "name", "status"],
output="table",
sort_keys=True)
else:
return d
def _print_dict_ip(d, header=None, format='table'):
if format == "json":
return json.dumps(d, indent=4)
elif format == "yaml":
return pyaml.dump(d)
elif format == "table":
return dict_printer(d,
order=["network", "version", "addr"],
output="table",
sort_keys=True)
else:
return d
"""
def list_vms_on_cloud(cloud="kilo", group=None, format="table"):
Utility reusable function to list vms on the cloud.
:param cloud:
:param group:
:param format:
:return:
_cloud = cloud
_group = group
_format = format
cloud_provider = CloudProvider(_cloud).provider
servers = cloud_provider.list_vm(_cloud)
server_list = {}
index = 0
# TODO: Improve the implementation to display more fields if required.
for server in servers:
server_list[index] = {}
server_list[index]["name"] = server.name
server_list[index]["id"] = server.id
server_list[index]["status"] = server.status
index += 1
# TODO: Get this printed in a table
print("Print table")
dict_printer(servers, output=_format)
"""
# pprint(arguments)
def _refresh():
try:
msg = "Refresh VMs for cloud {:}.".format(cloud)
if Vm.refresh(cloud=cloud):
Console.ok("{:} OK.".format(msg))
else:
Console.error("{:} failed".format(msg))
except Exception as e:
Error.traceback(e)
Console.error("Problem running VM refresh")
cloud = arguments["--cloud"] or Default.get_cloud()
if arguments["boot"]:
name = None
try:
name = arguments["--name"]
is_name_provided = True
if name is None:
is_name_provided = False
count = Counter.get()
prefix = Username()
if prefix is None or count is None:
Console.error(
"Prefix and Count could not be retrieved correctly."
)
return
# BUG THE Z FILL SHOULD BE detected from yaml file
name = prefix + "-" + str(count).zfill(3)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
image = arguments["--image"] or Default.get("image",
category=cloud)
# if default image not set, return error
if not image:
Console.error("Default image not set.")
return ""
flavor = arguments["--flavor"] or Default.get("flavor",
category=cloud)
# if default flavor not set, return error
if not flavor:
Console.error("Default flavor not set.")
return ""
group = arguments["--group"] or Default.get_group()
# if default group not set, return error
if not group:
group = "default"
Default.set_group(group)
secgroup = arguments["--secgroup"] or Default.get(
"secgroup", category=cloud)
# print("SecurityGrp : {:}".format(secgroup))
secgroup_list = ["default"]
if secgroup is not None:
secgroup_list.append(secgroup)
key_name = arguments["--key"] or Default.get_key()
# if default keypair not set, return error
if not key_name:
Console.error("Default key not set.")
return ""
if arguments["--dryrun"]:
data = {
"cloud": cloud,
"name": name,
"image": image,
"flavor": flavor,
"key_name": key_name,
"secgroup_list": secgroup_list,
"group": group
}
print(attribute_printer(data, output="table"))
msg = "dryrun info. OK."
Console.ok(msg)
else:
vm_id = Vm.boot(cloud=cloud,
name=name,
image=image,
flavor=flavor,
key_name=key_name,
secgroup_list=secgroup_list)
Default.set("last_vm_id", vm_id)
Default.set("last_vm_name", name)
# SHOULD WE NOT DO THIS BY DEFAULT EVEN IF WE SPECIFY THE NAME?
if is_name_provided is False:
# Incrementing count
Counter.incr()
# Add to group
if vm_id is not None:
Group.add(name=group,
type="vm",
id=name,
category=cloud)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem booting instance {:}".format(name))
elif arguments["default"]:
try:
count = Counter.get()
prefix = Username()
if prefix is None or count is None:
Console.error(
"Prefix and Count could not be retrieved correctly.")
return
vm_name = prefix + "-" + str(count).zfill(3)
data = {
"name": vm_name,
"cloud": arguments["--cloud"] or Default.get_cloud()
}
for attribute in [
"image", "flavor", "key", "login_key", "group",
"secgroup"
]:
data[attribute] = Default.get(attribute, category=cloud)
output_format = arguments["--format"] or "table"
print(attribute_printer(data, output=output_format))
msg = "info. OK."
Console.ok(msg)
ValueError(
"default command not implemented properly. Upon "
"first install the defaults should be read from yaml.")
except Exception as e:
Error.traceback(e)
Console.error("Problem listing defaults")
elif arguments["status"]:
try:
cloud_provider = CloudProvider(cloud).provider
vm_list = cloud_provider.list_vm(cloud)
print("Status of VM {} is {}".format(vm_list[0]["name"],
vm_list[0]["status"]))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem retrieving status of the VM")
elif arguments["info"]:
try:
cloud_provider = CloudProvider(cloud).provider
vms = cloud_provider.list_vm(cloud)
vm = vms[0]
output_format = arguments["--format"] or "table"
print(attribute_printer(vm, output=output_format))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem retrieving status of the VM")
elif arguments["start"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh."
)
return ""
name = last_vm["name"]
# print(name)
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
Vm.start(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem starting instances")
elif arguments["stop"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh."
)
return ""
name = last_vm["name"]
# print(name)
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
Vm.stop(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem stopping instances")
elif arguments["refresh"]:
_refresh()
elif arguments["delete"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh."
)
return ""
name = last_vm["name"]
servers = list()
servers.append(name)
group = arguments["--group"]
force = arguments["--force"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
Vm.delete(cloud=cloud, servers=servers)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem deleting instances")
elif arguments["ip"] and arguments["assign"]:
vmids = arguments["NAME"]
# If names not provided, take the last vm from DB.
if vmids is None or len(vmids) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
vmids = list()
vmids.append(name)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
try:
cloud_provider = CloudProvider(cloud).provider
for sname in vmids:
floating_ip = cloud_provider.create_assign_floating_ip(
sname)
if floating_ip is not None:
print(
"Floating IP assigned to {:} successfully and it is: {:}"
.format(sname, floating_ip))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem assigning floating ips.")
elif arguments["ip"] and arguments["show"]:
vmids = arguments["NAME"]
# If names not provided, take the last vm from DB.
if vmids is None or len(vmids) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
vmids = list()
vmids.append(name)
group = arguments["--group"]
output_format = arguments["--format"] or "table"
refresh = arguments["--refresh"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
try:
cloud_provider = CloudProvider(cloud).provider
for server in vmids:
ip_addr = cloud_provider.get_ips(server)
ipaddr_dict = Vm.construct_ip_dict(ip_addr, cloud)
print(
"IP Addresses of instance {:} are as follows:-".format(
server))
print(_print_dict_ip(ipaddr_dict, format=output_format))
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error(
"Problem getting ip addresses for instance {:}".format(id))
elif arguments["login"]:
vm_names = arguments["NAME"]
# If names not provided, take the last vm from DB.
if vm_names is None or len(vm_names) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh.")
return ""
name = last_vm["name"]
else:
name = vm_names[0]
print("Logging in into {:} machine...".format(name))
user = arguments["--user"]
# Get user if user argument not specified.
if user is None:
user_from_db = Vm.get_vm_login_user(name, cloud)
user_suggest = user_from_db or getpass.getuser()
user = input("Enter the user to login (Default: {}):".format(
user_suggest)) or user_suggest
Vm.set_vm_login_user(name, cloud, user)
ip = arguments["--ip"]
commands = arguments["--command"]
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
key = arguments["--key"] or Default.get("login_key",
category=cloud)
if not key:
Console.error("Default login_key not set.")
return ""
cloud_provider = CloudProvider(cloud).provider
# print("Name : {:}".format(name))
ip_addr = cloud_provider.get_ips(name)
ip_addresses = []
ipaddr_dict = Vm.construct_ip_dict(ip_addr, cloud)
for entry in ipaddr_dict:
ip_addresses.append(ipaddr_dict[entry]["addr"])
if ip is not None:
if ip not in ip_addresses:
print(
"ERROR: IP Address specified does not match with the host."
)
return ""
else:
print("Determining IP Address to use with a ping test.")
# This part assumes that the ping is allowed to the machine.
for ipadd in ip_addresses:
print("Checking {:}...".format(ipadd))
try:
socket.gethostbyaddr(ipadd)
# ip will be set if above command is successful.
ip = ipadd
except socket.herror:
print("Cannot reach {:}.".format(ipadd))
if ip is None:
print("SORRY. Unable to connect to the machine")
return ""
else:
print("IP to be used is: {:}".format(ip))
SecGroup.enable_ssh(cloud=cloud)
# print("COMMANDS : {:}".format(commands))
# Constructing the ssh command to connect to the machine.
sshcommand = "ssh"
if key is not None:
sshcommand += " -i {:}".format(key)
sshcommand += " -o StrictHostKeyChecking=no"
sshcommand += " {:}@{:}".format(user, ip)
if commands is not None:
sshcommand += " \"{:}\"".format(commands)
# print(sshcommand)
os.system(sshcommand)
elif arguments["list"]:
if arguments["--all"]:
try:
_format = arguments["--format"] or "table"
d = ConfigDict("cloudmesh.yaml")
for cloud in d["cloudmesh"]["clouds"]:
if arguments["--refresh"] or Default.refresh():
_refresh()
print("Listing VMs on Cloud: {:}".format(cloud))
result = Vm.list(cloud=cloud, output_format=_format)
if result is not None:
print(result)
else:
print(
"Sorry. No data found with requested parameters in DB."
)
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem listing all instances")
else:
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
try:
name_or_id = arguments["NAME_OR_ID"]
group = arguments["--group"]
_format = arguments["--format"] or "table"
# list_vms_on_cloud(cloud, group, _format)
if arguments["--refresh"] or Default.refresh():
_refresh()
result = Vm.list(name_or_id=name_or_id,
cloud=cloud,
output_format=_format)
if result is not None:
print(result)
else:
print("No data found with the requested parameters.")
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error(
"Problem listing instances on cloud {:}".format(cloud))
elif arguments["rename"]:
try:
servers = arguments["NAME"]
# If names not provided, take the last vm from DB.
if servers is None or len(servers) == 0:
last_vm = Vm.get_last_vm(cloud=cloud)
if last_vm is None:
Console.error(
"No VM records in database. Please run vm refresh."
)
return ""
name = last_vm["name"]
servers = list()
servers.append(name)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
new_name = arguments["--new"]
is_name_provided = True
# If the new name is not provided, make the new new name in format username-count.
if new_name is None or len(new_name) == 0:
is_name_provided = False
count = Counter.get()
prefix = Username()
if prefix is None or count is None:
Console.error(
"Prefix and Count could not be retrieved correctly."
)
return
# BUG THE Z FILL SHOULD BE detected from yaml file
new_name = prefix + "-" + str(count).zfill(3)
Vm.rename(cloud=cloud, servers=servers, new_name=new_name)
if is_name_provided is False:
# Incrementing count
Counter.incr()
msg = "info. OK."
Console.ok(msg)
except Exception as e:
Error.traceback(e)
Console.error("Problem deleting instances")
return ""
def do_vm(self, args, arguments):
"""
::
Usage:
vm default [--cloud=CLOUD][--format=FORMAT]
vm refresh [--cloud=CLOUD]
vm boot [--name=NAME]
[--cloud=CLOUD]
[--image=IMAGE_OR_ID]
[--flavor=FLAVOR_OR_ID]
[--group=GROUP]
[--secgroup=SECGROUP]
[--keypair_name=KEYPAIR_NAME]
vm start NAME...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm stop NAME...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm delete NAME...
[--group=GROUP]
[--cloud=CLOUD]
[--force]
vm floating_ip_assign NAME...
[--cloud=CLOUD]
vm ip_show NAME...
[--group=GROUP]
[--cloud=CLOUD]
[--format=FORMAT]
[--refresh]
vm login NAME [--user=USER]
[--ip=IP]
[--cloud=CLOUD]
[--key=KEY]
[--command=COMMAND]
vm list [NAME_OR_ID]
[--cloud=CLOUD|--all]
[--group=GROUP]
[--format=FORMAT]
vm status [--cloud=CLOUD]
Arguments:
COMMAND positional arguments, the commands you want to
execute on the server(e.g. ls -a) separated by ';',
you will get a return of executing result instead of login to
the server, note that type in -- is suggested before
you input the commands
NAME server name
NAME_OR_ID server name or ID
KEYPAIR_NAME Name of the openstack keypair to be used to create VM. Note this is not a path to key.
Options:
--ip=IP give the public ip of the server
--cloud=CLOUD give a cloud to work on, if not given, selected
or default cloud will be used
--count=COUNT give the number of servers to start
--detail for table print format, a brief version
is used as default, use this flag to print
detailed table
--flavor=FLAVOR_OR_ID give the name or id of the flavor
--group=GROUP give the group name of server
--secgroup=SECGROUP security group name for the server
--image=IMAGE_OR_ID give the name or id of the image
--key=KEY specify a key to use, input a string which
is the full path to the private key file
--keypair_name=KEYPAIR_NAME Name of the openstack keypair to be used to create VM.
Note this is not a path to key.
--user=USER give the user name of the server that you want
to use to login
--name=NAME give the name of the virtual machine
--force delete vms without user's confirmation
--command=COMMAND
specify the commands to be executed
Description:
commands used to boot, start or delete servers of a cloud
vm default [options...] Displays default parameters that are set for VM boot.
vm boot [options...] Boots servers on a cloud, user may specify
flavor, image .etc, otherwise default values
will be used, see how to set default values
of a cloud: cloud help
vm start [options...] Starts a suspended or stopped vm instance.
vm stop [options...] Stops a vm instance .
vm delete [options...] delete servers of a cloud, user may delete
a server by its name or id, delete servers
of a group or servers of a cloud, give prefix
and/or range to find servers by their names.
Or user may specify more options to narrow
the search
vm floating_ip_assign [options...] assign a public ip to a VM of a cloud
vm ip_show [options...] show the ips of VMs
vm login [options...] login to a server or execute commands on it
vm list [options...] same as command "list vm", please refer to it
vm status [options...] Retrieves status of last VM booted on cloud and displays it.
Tip:
give the VM name, but in a hostlist style, which is very
convenient when you need a range of VMs e.g. sample[1-3]
=> ['sample1', 'sample2', 'sample3']
sample[1-3,18] => ['sample1', 'sample2', 'sample3', 'sample18']
"""
def _print_dict(d, header=None, format='table'):
if format == "json":
return json.dumps(d, indent=4)
elif format == "yaml":
return pyaml.dump(d)
elif format == "table":
return dict_printer(d,
order=["id",
"name",
"status"],
output="table",
sort_keys=True)
else:
return d
def _print_dict_ip(d, header=None, format='table'):
if format == "json":
return json.dumps(d, indent=4)
elif format == "yaml":
return pyaml.dump(d)
elif format == "table":
return dict_printer(d,
order=["network",
"version",
"addr"],
output="table",
sort_keys=True)
else:
return d
"""
def list_vms_on_cloud(cloud="juno", group=None, format="table"):
Utility reusable function to list vms on the cloud.
:param cloud:
:param group:
:param format:
:return:
_cloud = cloud
_group = group
_format = format
cloud_provider = CloudProvider(_cloud).provider
servers = cloud_provider.list_vm(_cloud)
server_list = {}
index = 0
# TODO: Improve the implementation to display more fields if required.
for server in servers:
server_list[index] = {}
server_list[index]["name"] = server.name
server_list[index]["id"] = server.id
server_list[index]["status"] = server.status
index += 1
# TODO: Get this printed in a table
print("Print table")
dict_printer(servers, output=_format)
"""
# pprint(arguments)
cloud = arguments["--cloud"] or Default.get_cloud()
if arguments["boot"]:
name = None
try:
name = arguments["--name"]
is_name_provided = True
if name is None:
is_name_provided = False
prefix, count = Counter.get()
if prefix is None or count is None:
Console.error("Prefix and Count could not be retrieved correctly.")
return
name = prefix + "-" + str(count).zfill(3)
# if default cloud not set, return error
if not cloud:
Console.error("Default cloud not set.")
return ""
image = arguments["--image"] or Default.get("image", cloud=cloud)
# if default image not set, return error
if not image:
Console.error("Default image not set.")
return ""
flavor = arguments["--flavor"] or Default.get("flavor", cloud=cloud)
# if default flavor not set, return error
if not flavor:
Console.error("Default flavor not set.")
return ""
group = arguments["--group"] or \
Default.get("group", cloud=cloud)
# if default group not set, return error
if not group:
Console.error("Default group not set.")
return ""
secgroup = arguments["--secgroup"] or Default.get("secgroup", cloud=cloud)
# print("SecurityGrp : {:}".format(secgroup))
secgroup_list = ["default"]
if secgroup is not None:
secgroup_list.append(secgroup)
key_name = arguments["--keypair_name"] or Default.get("keypair", cloud=cloud)
# if default keypair not set, return error
if not key_name:
Console.error("Default keypair not set.")
return ""
vm_id = Vm.boot(cloud=cloud, name=name, image=image,
flavor=flavor, key_name=key_name,
secgroup_list=secgroup_list)
if is_name_provided is False:
# Incrementing count
Counter.incr()
# Add to group
Group.add(name=group, type="vm", id=vm_id, cloud=cloud)
msg = "info. OK."
Console.ok(msg)
except Exception, e:
import traceback
print(traceback.format_exc())
print(e)
Console.error("Problem booting instance {:}".format(name))
def do_group(self, args, arguments):
"""
::
Usage:
group add NAME [--type=TYPE] [--category=CLOUD] --id=IDs
group list [--category=CLOUD] [--format=FORMAT] [NAME]
group delete NAME [--category=CLOUD]
group remove [--category=CLOUD] --name=NAME --id=ID
group copy FROM TO
group merge GROUPA GROUPB MERGEDGROUP
manage the groups
Arguments:
NAME name of a group
FROM name of a group
TO name of a group
GROUPA name of a group
GROUPB name of a group
MERGEDGROUP name of a group
Options:
--category=CLOUD the name of the category
--format=FORMAT the output format
--type=TYPE the resource type
--name=NAME the name of the group
--id=IDS the ID(s) to add to the group
Description:
Todo: design parameters that are useful and match
description
Todo: discuss and propose command
cloudmesh can manage groups of resources and category related
objects. As it would be cumbersome to for example delete
many virtual machines or delete VMs that are in the same
group, but are running in different clouds.
Hence it is possible to add a virtual machine to a
specific group. The group name to be added to can be set
as a default. This way all subsequent commands use this
default group. It can also be set via a command parameter.
Another convenience function is that the group command can
use the last used virtual machine. If a vm is started it
will be automatically added to the default group if it is set.
The delete command has an optional category parameter so that
deletion of vms of a partial group by cloud can be
achieved.
If finer grained deletion is needed, it can be achieved
with the delete command that supports deletion by name
It is also possible to remove a VM from the group using the
remove command, by supplying the ID
Example:
default group mygroup
group add --type=vm --id=albert-[001-003]
adds the vms with teh given name using the Parameter
see base
group add --type=vm
adds the last vm to the group
group delete --name=mygroup
deletes all objects in the group
"""
# pprint(arguments)
category = arguments["--category"] or Default.get_cloud()
if arguments["list"]:
output = arguments["--format"] or Default.get("format", category) or "table"
name = arguments["NAME"]
if name is None:
result = Group.list(format=output, category=category)
if result:
print(result)
else:
print("There are no groups in the cloudmesh database!")
else:
result = Group.get_info(name=name, category=category,
output=output)
if result:
print(result)
else:
msg_a = ("No group found with name `{name}` found in the "
"category `{category}`.".format(**locals()))
# find alternate
result = Group.get(name=name)
msg_b = ""
if result is not None:
msg_b = " However we found such a variable in " \
"category `{category}`. Please consider " \
"using --category={category}".format(**result)
Console.error(msg_a + msg_b)
return
elif arguments["add"]:
type = arguments["--type"] or Default.get("type", category)
category_id = arguments["--id"] or Default.get("id", category)
data = {
"name": arguments["NAME"],
"type": type,
"category": category,
"id": category_id
}
Group.add(**data)
return
elif arguments["delete"]:
data = {
"name": arguments["NAME"],
"category": category,
}
result = Group.delete(**data)
if result:
Console.ok("Deletion completed. ok.")
else:
Console.error(
"No group with name `{name}` found".format(**data))
return
elif arguments["remove"]:
name = arguments["--name"]
category_id = arguments["--id"]
if not category:
Console.error("Default category not set!")
return
result = Group.remove(name, category_id, category)
if result:
Console.ok(result)
else:
Console.error(
"Failed to delete ID [{}] from group [{}] in the database!".format(
category_id, name))
return
elif arguments["copy"]:
_from = arguments["FROM"]
_to = arguments["TO"]
Group.copy(_from, _to)
return
elif arguments["merge"]:
_groupA = arguments["GROUPA"]
_groupB = arguments["GROUPB"]
_mergedGroup = arguments["MERGEDGROUP"]
Group.merge(_groupA, _groupB, _mergedGroup)
return
def do_group(self, args, arguments):
"""
::
Usage:
group list [GROUPNAME] [--format=FORMAT]
group remove NAMES [--group=GROUPNAME]
group add NAMES [--type=TYPE] [--group=GROUPNAME]
group delete GROUPS
group copy FROM TO
group merge GROUPA GROUPB MERGEDGROUP
manage the groups
Arguments:
NAMES names of object to be added
GROUPS names of a groups
FROM name of a group
TO name of a group
GROUPA name of a group
GROUPB name of a group
MERGEDGROUP name of a group
Options:
--format=FORMAT the output format
--type=TYPE the resource type
--name=NAME the name of the group
--id=IDS the ID(s) to add to the group
Description:
Todo: design parameters that are useful and match
description
Todo: discuss and propose command
cloudmesh can manage groups of resource related
objects. As it would be cumbersome to for example delete
many virtual machines or delete VMs that are in the same
group, but are running in different clouds.
Hence it is possible to add a virtual machine to a
specific group. The group name to be added to can be set
as a default. This way all subsequent commands use this
default group. It can also be set via a command parameter.
Another convenience function is that the group command can
use the last used virtual machine. If a vm is started it
will be automatically added to the default group if it is set.
If finer grained deletion is needed, it can be achieved
with the delete command that supports deletion by name
It is also possible to remove a VM from the group using the
remove command, by supplying the ID
Note:
The type is internally called for the group species, we may
eliminate the species column and just use the type column for it,
Example:
default group mygroup
group add --type=vm --id=albert-[001-003]
adds the vms with the given name using the Parameter
see base
group add --type=vm
adds the last vm to the group
group delete --name=mygroup
deletes all objects in the group
"""
# pprint(arguments)
if arguments["list"]:
output = arguments["--format"] or Default.get(name="format", category="general") or "table"
name = arguments["GROUPNAME"]
if name is None:
result = Group.list(output=output)
if result:
print(result)
else:
print("No groups found other than the default group but it has no members.")
else:
result = Group.list(name=name,
output=output)
if result:
print(result)
else:
msg_a = ("No group found with name `{name}` found in the "
"category `{category}`.".format(**locals()))
'''
# find alternate
result = Group.get(name=name)
msg_b = ""
if result is not None and len(result) < 0:
msg_b = " However we found such a variable in " \
"category `{category}`. Please consider " \
"using --category={category}".format(**locals())
Console.error(msg_a + msg_b)
else:
Console.error("No group with name {name} exists.".format(**locals()))
'''
return ""
elif arguments["add"]:
# group add NAME... [--type=TYPE] [--category=CLOUD] [--group=GROUP]
print ("AAA", arguments["NAMES"])
members = Parameter.expand(arguments["NAMES"])
print ("MMMM", members)
data = dotdict({
"species": arguments["--type"] or "vm",
"name": arguments["--group"] or Default.group
})
print ("DDD", data)
for member in members:
data.member = member
pprint(data)
Group.add(**data)
return ""
elif arguments["delete"]:
groups = Parameter.expand(arguments["GROUPS"])
for group in groups:
result = Group.delete(group)
if result:
Console.ok(result)
else:
Console.error(
"delete group {}. failed.".format(group))
return ""
elif arguments["remove"]:
members = Parameter.expand(arguments["NAMES"])
group = arguments["--group"] or Default.group
for member in members:
result = Group.remove(group, member)
if result:
Console.ok(result)
else:
Console.error(
"remove {} from group {}. failed.".format(group, member))
return ""
elif arguments["copy"]:
_from = arguments["FROM"]
_to = arguments["TO"]
Group.copy(_from, _to)
return ""
elif arguments["merge"]:
_groupA = arguments["GROUPA"]
_groupB = arguments["GROUPB"]
_mergedGroup = arguments["MERGEDGROUP"]
Group.merge(_groupA, _groupB, _mergedGroup)
return ""