return
-@click.group()
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'], max_content_width=160)
+
+@click.group(context_settings=CONTEXT_SETTINGS)
@click.option('--hostname',
default="127.0.0.1",
envvar='OSM_HOSTNAME',
# LIST operations
####################
-@cli.command(name='ns-list')
+@cli.command(name='ns-list', short_help='list all NS instances')
@click.option('--filter', default=None,
help='restricts the list to the NS instances matching the filter.')
@click.pass_context
print(table)
-@cli.command(name='nsd-list')
+@cli.command(name='nsd-list', short_help='list all NS packages')
@click.option('--filter', default=None,
help='restricts the list to the NSD/NSpkg matching the filter')
@click.pass_context
nsd_list(ctx, filter)
-@cli.command(name='nspkg-list')
+@cli.command(name='nspkg-list', short_help='list all NS packages')
@click.option('--filter', default=None,
help='restricts the list to the NSD/NSpkg matching the filter')
@click.pass_context
def nsd_list2(ctx, filter):
- """list all NSD/NS pkg in the system"""
+ """list all NS packages"""
nsd_list(ctx, filter)
print(table)
-@cli.command(name='vnfd-list')
+@cli.command(name='vnfd-list', short_help='list all xNF packages (VNF, HNF, PNF)')
@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
@click.option('--filter', default=None,
help='restricts the list to the NF pkg matching the filter')
@click.pass_context
def vnfd_list1(ctx, nf_type, filter):
- """list all VNFD/VNF pkg in the system"""
+ """list all xNF packages (VNF, HNF, PNF)"""
vnfd_list(ctx, nf_type, filter)
-@cli.command(name='vnfpkg-list')
+@cli.command(name='vnfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
@click.option('--filter', default=None,
help='restricts the list to the NFpkg matching the filter')
@click.pass_context
def vnfd_list2(ctx, nf_type, filter):
- """list all VNFD/VNF pkg in the system"""
+ """list all xNF packages (VNF, HNF, PNF)"""
vnfd_list(ctx, nf_type, filter)
-@cli.command(name='nfpkg-list')
+@cli.command(name='nfpkg-list', short_help='list all xNF packages (VNF, HNF, PNF)')
@click.option('--nf_type', help='type of NF (vnf, pnf, hnf)')
@click.option('--filter', default=None,
help='restricts the list to the NFpkg matching the filter')
@click.pass_context
def nfpkg_list(ctx, nf_type, filter):
- """list all NF pkg (VNF pkg, PNF pkg, HNF pkg) in the system"""
+ """list all xNF packages (VNF, HNF, PNF)"""
try:
check_client_version(ctx.obj, ctx.command.name)
vnfd_list(ctx, nf_type, filter)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
resp = ctx.obj.vnf.list(ns, filter)
else:
resp = ctx.obj.vnf.list()
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname == 'osmclient.sol005.client.Client':
print(table)
-@cli.command(name='vnf-list')
+@cli.command(name='vnf-list', short_help='list all NF instances')
@click.option('--ns', default=None, help='NS instance id or name to restrict the NF list')
@click.option('--filter', default=None,
help='restricts the list to the NF instances matching the filter.')
vnf_list(ctx, ns, filter)
-@cli.command(name='nf-list')
+@cli.command(name='nf-list', short_help='list all NF instances')
@click.option('--ns', default=None, help='NS instance id or name to restrict the NF list')
@click.option('--filter', default=None,
help='restricts the list to the NF instances matching the filter.')
vnf_list(ctx, ns, filter)
-@cli.command(name='ns-op-list')
+@cli.command(name='ns-op-list', short_help='shows the history of operations over a NS instance')
@click.argument('name')
@click.pass_context
def ns_op_list(ctx, name):
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.ns.list_op(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['id', 'operation', 'status'])
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.nsi.list(filter)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(
['netslice instance name',
print(table)
-@cli.command(name='nsi-list')
+@cli.command(name='nsi-list', short_help='list all Network Slice Instances (NSI)')
@click.option('--filter', default=None,
help='restricts the list to the Network Slice Instances matching the filter')
@click.pass_context
nsi_list(ctx, filter)
-@cli.command(name='netslice-instance-list')
+@cli.command(name='netslice-instance-list', short_help='list all Network Slice Instances (NSI)')
@click.option('--filter', default=None,
help='restricts the list to the Network Slice Instances matching the filter')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.nst.list(filter)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
# print(yaml.safe_dump(resp))
table = PrettyTable(['nst name', 'id'])
print(table)
-@cli.command(name='nst-list')
+@cli.command(name='nst-list', short_help='list all Network Slice Templates (NST)')
@click.option('--filter', default=None,
help='restricts the list to the NST matching the filter')
@click.pass_context
nst_list(ctx, filter)
-@cli.command(name='netslice-template-list')
+@cli.command(name='netslice-template-list', short_help='list all Network Slice Templates (NST)')
@click.option('--filter', default=None,
help='restricts the list to the NST matching the filter')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.nsi.list_op(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['id', 'operation', 'status'])
for op in resp:
print(table)
-@cli.command(name='nsi-op-list')
+@cli.command(name='nsi-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
@click.argument('name')
@click.pass_context
def nsi_op_list1(ctx, name):
nsi_op_list(ctx, name)
-@cli.command(name='netslice-instance-op-list')
+@cli.command(name='netslice-instance-op-list', short_help='shows the history of operations over a Network Slice Instance (NSI)')
@click.argument('name')
@click.pass_context
def nsi_op_list2(ctx, name):
nsi_op_list(ctx, name)
-@cli.command(name='pdu-list')
+@cli.command(name='pdu-list', short_help='list all Physical Deployment Units (PDU)')
@click.option('--filter', default=None,
help='restricts the list to the Physical Deployment Units matching the filter')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.pdu.list(filter)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(
['pdu name',
try:
resp = ctx.obj.nsd.get(name)
# resp = ctx.obj.nsd.get_individual(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
try:
resp = ctx.obj.vnfd.get(name)
# resp = ctx.obj.vnfd.get_individual(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
"""
try:
ns = ctx.obj.ns.get(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.vnf.get(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
# resp = ctx.obj.vnf.get_monitoring(vnf_name)
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
#
# table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
# resp = ctx.obj.ns.get_monitoring(ns_name)
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
#
# table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
# print(table)
-@cli.command(name='ns-op-show', short_help='shows the info of an operation')
+@cli.command(name='ns-op-show', short_help='shows the info of a NS operation')
@click.argument('id')
@click.option('--filter', default=None)
@click.pass_context
def ns_op_show(ctx, id, filter):
- """shows the detailed info of an operation
+ """shows the detailed info of a NS operation
ID: operation identifier
"""
try:
check_client_version(ctx.obj, ctx.command.name)
op_info = ctx.obj.ns.get_op(id)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['field', 'value'])
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.nst.get(name)
#resp = ctx.obj.nst.get_individual(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
try:
check_client_version(ctx.obj, ctx.command.name)
nsi = ctx.obj.nsi.get(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
try:
check_client_version(ctx.obj, ctx.command.name)
op_info = ctx.obj.nsi.get_op(id)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['field', 'value'])
try:
check_client_version(ctx.obj, ctx.command.name)
pdu = ctx.obj.pdu.get(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if literal:
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nsd.create(filename, overwrite)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
@cli.command(name='nsd-create', short_help='creates a new NSD/NSpkg')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in NSD')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrite deprecated, use override')
+@click.option('--override', 'overwrite', default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def nsd_create1(ctx, filename, overwrite):
"""creates a new NSD/NSpkg
@cli.command(name='nspkg-create', short_help='creates a new NSD/NSpkg')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in NSD')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrite deprecated, use override')
+@click.option('--override', 'overwrite', default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def nsd_create2(ctx, filename, overwrite):
"""creates a new NSD/NSpkg
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.vnfd.create(filename, overwrite)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
@cli.command(name='vnfd-create', short_help='creates a new VNFD/VNFpkg')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in VNFD')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrite deprecated, use override')
+@click.option('--override', 'overwrite', default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def vnfd_create1(ctx, filename, overwrite):
"""creates a new VNFD/VNFpkg
@cli.command(name='vnfpkg-create', short_help='creates a new VNFD/VNFpkg')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in VNFD')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrite deprecated, use override')
+@click.option('--override', 'overwrite', default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def vnfd_create2(ctx, filename, overwrite):
"""creates a new VNFD/VNFpkg
@cli.command(name='nfpkg-create', short_help='creates a new NFpkg')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in NFD')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrite deprecated, use override')
+@click.option('--override', 'overwrite', default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def nfpkg_create(ctx, filename, overwrite):
"""creates a new NFpkg
ssh_keys=ssh_keys,
account=vim_account,
wait=wait)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nst.create(filename, overwrite)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
@cli.command(name='nst-create', short_help='creates a new Network Slice Template (NST)')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in NST')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrites deprecated use override')
+@click.option('--override', 'overwrite' ,default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def nst_create1(ctx, filename, overwrite):
"""creates a new Network Slice Template (NST)
@cli.command(name='netslice-template-create', short_help='creates a new Network Slice Template (NST)')
@click.argument('filename')
-@click.option('--overwrite', default=None,
- help='overwrites some fields in NST')
+@click.option('--overwrite', 'overwrite', default=None,
+ help='overwrites deprecated use override')
+@click.option('--override', 'overwrite', default=None,
+ help='overrides fields in descriptor, format: '
+ '"key1.key2...=value[;key3...=value;...]"')
@click.pass_context
def nst_create2(ctx, filename, overwrite):
"""creates a new Network Slice Template (NST)
config=cf.read()
ctx.obj.nsi.create(nst_name, nsi_name, config=config, ssh_keys=ssh_keys,
account=vim_account, wait=wait)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
raise ClientException('in absence of descriptor file, option "--vim_account" is mandatory (at least once)')
else:
with open(descriptor_file, 'r') as df:
- pdu = yaml.load(df.read())
+ pdu = yaml.safe_load(df.read())
if name: pdu["name"] = name
if pdu_type: pdu["type"] = pdu_type
if description: pdu["description"] = description
ifaces_list.append(new_iface)
pdu["interfaces"] = ifaces_list
ctx.obj.pdu.create(pdu)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
####################
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nsd.update(name, content)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.vnfd.update(name, content)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nst.update(name, content)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
else:
check_client_version(ctx.obj, '--force')
ctx.obj.nsd.delete(name, force)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
else:
check_client_version(ctx.obj, '--force')
ctx.obj.vnfd.delete(name, force)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
else:
check_client_version(ctx.obj, '--force')
ctx.obj.ns.delete(name, force, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nst.delete(name, force)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nsi.delete(name, force, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.pdu.delete(name, force)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
# VIM operations
#################
-@cli.command(name='vim-create')
+@cli.command(name='vim-create', short_help='creates a new VIM account')
@click.option('--name',
prompt=True,
help='Name to create datacenter')
ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
else:
ctx.obj.vim.create(name, vim, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if description: vim['description'] = description
if config: vim['config'] = config
ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='vim-delete')
+@cli.command(name='vim-delete', short_help='deletes a VIM account')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
else:
check_client_version(ctx.obj, '--force')
ctx.obj.vim.delete(name, force, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='vim-list')
+@cli.command(name='vim-list', short_help='list all VIM accounts')
#@click.option('--ro_update/--no_ro_update',
# default=False,
# help='update list from RO')
print(table)
-@cli.command(name='vim-show')
+@cli.command(name='vim-show', short_help='shows the details of a VIM account')
@click.argument('name')
@click.pass_context
def vim_show(ctx, name):
resp = ctx.obj.vim.get(name)
if 'vim_password' in resp:
resp['vim_password']='********'
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['key', 'attribute'])
# WIM operations
####################
-@cli.command(name='wim-create')
+@cli.command(name='wim-create', short_help='creates a new WIM account')
@click.option('--name',
prompt=True,
help='Name for the WIM account')
if description: wim['description'] = description
if config: wim['config'] = config
ctx.obj.wim.create(name, wim, wim_port_mapping, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
if description: wim['description'] = description
if config: wim['config'] = config
ctx.obj.wim.update(name, wim, wim_port_mapping, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='wim-delete')
+@cli.command(name='wim-delete', short_help='deletes a WIM account')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.wim.delete(name, force, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='wim-list')
+@cli.command(name='wim-list', short_help='list all WIM accounts')
@click.option('--filter', default=None,
help='restricts the list to the WIM accounts matching the filter')
@click.pass_context
table.add_row([wim['name'], wim['uuid']])
table.align = 'l'
print(table)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='wim-show')
+@cli.command(name='wim-show', short_help='shows the details of a WIM account')
@click.argument('name')
@click.pass_context
def wim_show(ctx, name):
resp = ctx.obj.wim.get(name)
if 'password' in resp:
resp['wim_password']='********'
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['key', 'attribute'])
# SDN controller operations
####################
-@cli.command(name='sdnc-create')
+@cli.command(name='sdnc-create', short_help='creates a new SDN controller')
@click.option('--name',
prompt=True,
help='Name to create sdn controller')
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.sdnc.create(name, sdncontroller, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
@cli.command(name='sdnc-update', short_help='updates an SDN controller')
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.sdnc.update(name, sdncontroller, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='sdnc-delete')
+@cli.command(name='sdnc-delete', short_help='deletes an SDN controller')
@click.argument('name')
@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.option('--wait',
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.sdnc.delete(name, force, wait=wait)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='sdnc-list')
+@cli.command(name='sdnc-list', short_help='list all SDN controllers')
@click.option('--filter', default=None,
help='restricts the list to the SDN controllers matching the filter')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.sdnc.list(filter)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['sdnc name', 'id'])
for sdnc in resp:
print(table)
-@cli.command(name='sdnc-show')
+@cli.command(name='sdnc-show', short_help='shows the details of an SDN controller')
@click.argument('name')
@click.pass_context
def sdnc_show(ctx, name):
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.sdnc.get(name)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['key', 'attribute'])
# Project mgmt operations
####################
-@cli.command(name='project-create')
+@cli.command(name='project-create', short_help='creates a new project')
@click.argument('name')
#@click.option('--description',
# default='no description',
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.project.create(name, project)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='project-delete')
+@cli.command(name='project-delete', short_help='deletes a project')
@click.argument('name')
#@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.project.delete(name)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='project-list')
+@cli.command(name='project-list', short_help='list all projects')
@click.option('--filter', default=None,
help='restricts the list to the projects matching the filter')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.project.list(filter)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['name', 'id'])
for proj in resp:
print(table)
-@cli.command(name='project-show')
+@cli.command(name='project-show', short_help='shows the details of a project')
@click.argument('name')
@click.pass_context
def project_show(ctx, name):
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.project.get(name)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['key', 'attribute'])
print(table)
-@cli.command(name='project-update')
+@cli.command(name='project-update', short_help='updates a project (only the name can be updated)')
@click.argument('project')
@click.option('--name',
prompt=True,
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.project.update(project, project_changes)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
####################
# User mgmt operations
####################
-@cli.command(name='user-create')
+@cli.command(name='user-create', short_help='creates a new user')
@click.argument('username')
@click.option('--password',
prompt=True,
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.user.create(username, user)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='user-update')
+@cli.command(name='user-update', short_help='updates user information')
@click.argument('username')
@click.option('--password',
# prompt=True,
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.user.update(username, user)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='user-delete')
+@cli.command(name='user-delete', short_help='deletes a user')
@click.argument('name')
#@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.user.delete(name)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='user-list')
+@cli.command(name='user-list', short_help='list all users')
@click.option('--filter', default=None,
help='restricts the list to the users matching the filter')
@click.pass_context
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.user.list(filter)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['name', 'id'])
for user in resp:
print(table)
-@cli.command(name='user-show')
+@cli.command(name='user-show', short_help='shows the details of a user')
@click.argument('name')
@click.pass_context
def user_show(ctx, name):
resp = ctx.obj.user.get(name)
if 'password' in resp:
resp['password']='********'
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['key', 'attribute'])
alarm['statistic'] = statistic
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.ns.create_alarm(alarm)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
# try:
# check_client_version(ctx.obj, ctx.command.name)
# ctx.obj.ns.delete_alarm(name)
-# except ClientException as inst:
-# print(inst.message)
+# except ClientException as e:
+# print(str(e))
# exit(1)
# Performance Management operations
####################
-@cli.command(name='ns-metric-export')
+@cli.command(name='ns-metric-export', short_help='exports a metric to the internal OSM bus, which can be read by other apps')
@click.option('--ns', prompt=True, help='NS instance id or name')
@click.option('--vnf', prompt=True,
help='VNF name (VNF member index as declared in the NSD)')
print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i))
time.sleep(int(interval))
i+=1
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
# Other operations
####################
-@cli.command(name='upload-package')
+@cli.command(name='upload-package', short_help='uploads a VNF package or NS package')
@click.argument('filename')
@click.pass_context
def upload_package(ctx, filename):
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname != 'osmclient.sol005.client.Client':
ctx.obj.package.wait_for_upload(filename)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
# resp = ctx.obj.ns.list()
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
#
# table = PrettyTable(
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
# ctx.obj.ns.scale(ns_name, ns_scale_group, index, wait=wait)
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
# """list config agents"""
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
# table = PrettyTable(['name', 'account-type', 'details'])
# for account in ctx.obj.vca.list():
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
# ctx.obj.vca.delete(name)
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
# try:
# check_client_version(ctx.obj, ctx.command.name, 'v1')
# ctx.obj.vca.create(name, account_type, server, user, secret)
-# except ClientException as inst:
-# print((inst.message))
+# except ClientException as e:
+# print(str(e))
# exit(1)
# print(table)
-@cli.command(name='ns-action')
+@cli.command(name='ns-action', short_help='executes an action/primitive over a NS instance')
@click.argument('ns_name')
@click.option('--vnf_name', default=None, help='member-vnf-index if the target is a vnf instead of a ns)')
@click.option('--vdu_id', default=None, help='vdu-id if the target is a vdu o a vnf')
op_data['vdu_count_index'] = vdu_count
op_data['primitive'] = action_name
if params:
- op_data['primitive_params'] = yaml.load(params)
+ op_data['primitive_params'] = yaml.safe_load(params)
else:
op_data['primitive_params'] = {}
ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data, wait=wait)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
-@cli.command(name='vnf-scale')
+@cli.command(name='vnf-scale', short_help='executes a VNF scale (adding/removing VDUs)')
@click.argument('ns_name')
@click.argument('vnf_name')
@click.option('--scaling-group', prompt=True, help="scaling-group-descriptor name to use")
if not scale_in and not scale_out:
scale_out = True
ctx.obj.ns.scale_vnf(ns_name, vnf_name, scaling_group, scale_in, scale_out)
- except ClientException as inst:
- print((inst.message))
+ except ClientException as e:
+ print(str(e))
exit(1)
# Role Management Operations #
##############################
-@cli.command(name='role-create', short_help='creates a role')
+@cli.command(name='role-create', short_help='creates a new role')
@click.argument('name')
@click.option('--permissions',
default=None,
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.role.create(name, permissions)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.role.update(name, set_name, None, add, remove)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.role.delete(name)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.role.list(filter)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['name', 'id'])
for role in resp:
try:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.role.get(name)
- except ClientException as inst:
- print(inst.message)
+ except ClientException as e:
+ print(str(e))
exit(1)
table = PrettyTable(['key', 'attribute'])
print(table)
+@cli.command(name='package-create',
+ short_help='Create a package descriptor')
+@click.argument('package-type')
+@click.argument('package-name')
+@click.option('--base-directory',
+ default='.',
+ help=('(NS/VNF/NST) Set the location for package creation. Default: "."'))
+@click.option('--image',
+ default="image-name",
+ help='(VNF) Set the name of the vdu image. Default "image-name"')
+@click.option('--vdus',
+ default=1,
+ help='(VNF) Set the number of vdus in a VNF. Default 1')
+@click.option('--vcpu',
+ default=1,
+ help='(VNF) Set the number of virtual CPUs in a vdu. Default 1')
+@click.option('--memory',
+ default=1024,
+ help='(VNF) Set the memory size (MB) of the vdu. Default 1024')
+@click.option('--storage',
+ default=10,
+ help='(VNF) Set the disk size (GB) of the vdu. Default 10')
+@click.option('--interfaces',
+ default=0,
+ help='(VNF) Set the number of additional interfaces apart from the management interface. Default 0')
+@click.option('--vendor',
+ default="OSM",
+ help='(NS/VNF) Set the descriptor vendor. Default "OSM"')
+@click.option('--override',
+ default=False,
+ is_flag=True,
+ help='(NS/VNF/NST) Flag for overriding the package if exists.')
+@click.option('--detailed',
+ is_flag=True,
+ default=False,
+ help='(NS/VNF/NST) Flag for generating descriptor .yaml with all possible commented options')
+@click.option('--netslice-subnets',
+ default=1,
+ help='(NST) Number of netslice subnets. Default 1')
+@click.option('--netslice-vlds',
+ default=1,
+ help='(NST) Number of netslice vlds. Default 1')
+@click.pass_context
+def package_create(ctx,
+ package_type,
+ base_directory,
+ package_name,
+ override,
+ image,
+ vdus,
+ vcpu,
+ memory,
+ storage,
+ interfaces,
+ vendor,
+ detailed,
+ netslice_subnets,
+ netslice_vlds):
+ """
+ Creates an OSM NS, VNF, NST package
+
+ \b
+ PACKAGE_TYPE: Package to be created: NS, VNF or NST.
+ PACKAGE_NAME: Name of the package to create the folder with the content.
+ """
+
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ print("Creating the {} structure: {}/{}".format(package_type.upper(), base_directory, package_name))
+ resp = ctx.obj.package_tool.create(package_type,
+ base_directory,
+ package_name,
+ override=override,
+ image=image,
+ vdus=vdus,
+ vcpu=vcpu,
+ memory=memory,
+ storage=storage,
+ interfaces=interfaces,
+ vendor=vendor,
+ detailed=detailed,
+ netslice_subnets=netslice_subnets,
+ netslice_vlds=netslice_vlds)
+ print(resp)
+ except ClientException as inst:
+ print("ERROR: {}".format(inst))
+ exit(1)
+
+@cli.command(name='package-validate',
+ short_help='Validate a package descriptor')
+@click.argument('base-directory',
+ default=".",
+ required=False)
+@click.pass_context
+def package_validate(ctx,
+ base_directory):
+ """
+ Validate descriptors given a base directory.
+
+ \b
+ BASE_DIRECTORY: Stub folder for NS, VNF or NST package.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ results = ctx.obj.package_tool.validate(base_directory)
+ table = PrettyTable()
+ table.field_names = ["TYPE", "PATH", "VALID", "ERROR"]
+ # Print the dictionary generated by the validation function
+ for result in results:
+ table.add_row([result["type"], result["path"], result["valid"], result["error"]])
+ table.sortby = "VALID"
+ table.align["PATH"] = "l"
+ table.align["TYPE"] = "l"
+ table.align["ERROR"] = "l"
+ print(table)
+ except ClientException as inst:
+ print("ERROR: {}".format(inst))
+ exit(1)
+
+@cli.command(name='package-build',
+ short_help='Build the tar.gz of the package')
+@click.argument('package-folder')
+@click.option('--skip-validation',
+ default=False,
+ is_flag=True,
+ help='skip package validation')
+@click.pass_context
+def package_build(ctx,
+ package_folder,
+ skip_validation):
+ """
+ Build the package NS, VNF given the package_folder.
+
+ \b
+ PACKAGE_FOLDER: Folder of the NS, VNF or NST to be packaged
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ results = ctx.obj.package_tool.build(package_folder, skip_validation)
+ print(results)
+ except ClientException as inst:
+ print("ERROR: {}".format(inst))
+ exit(1)
+
+
if __name__ == '__main__':
try:
cli()