:raises ClientError: if the specified version does not match the client version
'''
fullclassname = obj.__module__ + "." + obj.__class__.__name__
- message = 'the following commands or options are only supported with the option "--sol005": {}'.format(what)
+ message = 'The following commands or options are only supported with the option "--sol005": {}'.format(what)
if version == 'v1':
- message = 'the following commands or options are not supported when using option "--sol005": {}'.format(what)
+ message = 'The following commands or options are not supported when using option "--sol005": {}'.format(what)
if fullclassname != 'osmclient.{}.client.Client'.format(version):
raise ClientException(message)
return
['ns instance name',
'id',
'operational status',
- 'config status'])
+ 'config status',
+ 'detailed status'])
for ns in resp:
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname == 'osmclient.sol005.client.Client':
nsr_id = nsr['ns-instance-config-ref']
opstatus = nsr['operational-status'] if 'operational-status' in nsr else 'Not found'
configstatus = nsr['config-status'] if 'config-status' in nsr else 'Not found'
+ detailed_status = nsr['detailed-status'] if 'detailed-status' in nsr else 'Not found'
if configstatus == "config_not_needed":
configstatus = "configured (no charms)"
table.add_row(
[nsr_name,
nsr_id,
opstatus,
- configstatus])
+ configstatus,
+ detailed_status])
table.align = 'l'
print(table)
@cli.command(name='vnf-list')
+@click.option('--ns', default=None, help='NS instance id or name to restrict the VNF list')
@click.pass_context
-def vnf_list(ctx):
+def vnf_list(ctx, ns):
''' list all VNF instances'''
- resp = ctx.obj.vnf.list()
+ try:
+ if ns:
+ check_client_version(ctx.obj, '--ns')
+ resp = ctx.obj.vnf.list(ns)
+ else:
+ resp = ctx.obj.vnf.list()
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
table = PrettyTable(
['vnf name',
'id',
table.align = 'l'
print(table)
+@cli.command(name='ns-op-list')
+@click.argument('name')
+@click.pass_context
+def ns_op_list(ctx, name):
+ '''shows the history of operations over a NS instance
+
+ NAME: name or ID of the NS instance
+ '''
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.ns.list_op(name)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+ table = PrettyTable(['id', 'operation', 'status'])
+ for op in resp:
+ table.add_row([op['id'], op['lcmOperationType'],
+ op['operationState']])
+ table.align = 'l'
+ print(table)
####################
# SHOW operations
NAME: name or ID of the VNF instance
'''
try:
- check_client_version(ctx.obj, ctx.command.name, 'v1')
+ check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.vnf.get(name)
except ClientException as inst:
print(inst.message)
table.align = 'l'
print(table)
+@cli.command(name='ns-op-show', short_help='shows the info of an 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
+
+ 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)
+ exit(1)
+
+ table = PrettyTable(['field', 'value'])
+ for k, v in op_info.items():
+ if filter is None or filter in k:
+ table.add_row([k, json.dumps(v, indent=2)])
+ table.align = 'l'
+ print(table)
+
####################
# CREATE operations
# DELETE operations
####################
-def nsd_delete(ctx, name):
+def nsd_delete(ctx, name, force):
try:
- ctx.obj.nsd.delete(name)
+ if not force:
+ ctx.obj.nsd.delete(name)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.nsd.delete(name, force)
except ClientException as inst:
print(inst.message)
exit(1)
@cli.command(name='nsd-delete', short_help='deletes a NSD/NSpkg')
@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
-def nsd_delete1(ctx, name):
+def nsd_delete1(ctx, name, force):
'''deletes a NSD/NSpkg
NAME: name or ID of the NSD/NSpkg to be deleted
'''
- nsd_delete(ctx, name)
+ nsd_delete(ctx, name, force)
@cli.command(name='nspkg-delete', short_help='deletes a NSD/NSpkg')
@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
-def nsd_delete2(ctx, name):
+def nsd_delete2(ctx, name, force):
'''deletes a NSD/NSpkg
NAME: name or ID of the NSD/NSpkg to be deleted
'''
- nsd_delete(ctx, name)
+ nsd_delete(ctx, name, force)
-def vnfd_delete(ctx, name):
+def vnfd_delete(ctx, name, force):
try:
- ctx.obj.vnfd.delete(name)
+ if not force:
+ ctx.obj.vnfd.delete(name)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.vnfd.delete(name, force)
except ClientException as inst:
print(inst.message)
exit(1)
@cli.command(name='vnfd-delete', short_help='deletes a VNFD/VNFpkg')
@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
-def vnfd_delete1(ctx, name):
+def vnfd_delete1(ctx, name, force):
'''deletes a VNFD/VNFpkg
NAME: name or ID of the VNFD/VNFpkg to be deleted
'''
- vnfd_delete(ctx, name)
+ vnfd_delete(ctx, name, force)
@cli.command(name='vnfpkg-delete', short_help='deletes a VNFD/VNFpkg')
@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
-def vnfd_delete2(ctx, name):
+def vnfd_delete2(ctx, name, force):
'''deletes a VNFD/VNFpkg
NAME: name or ID of the VNFD/VNFpkg to be deleted
'''
- vnfd_delete(ctx, name)
+ vnfd_delete(ctx, name, force)
@cli.command(name='ns-delete', short_help='deletes a NS instance')
@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
-def ns_delete(ctx, name):
+def ns_delete(ctx, name, force):
'''deletes a NS instance
NAME: name or ID of the NS instance to be deleted
'''
try:
- ctx.obj.ns.delete(name)
+ if not force:
+ ctx.obj.ns.delete(name)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.ns.delete(name, force)
except ClientException as inst:
print(inst.message)
exit(1)
@click.option('--description',
default='no description',
help='human readable description')
+@click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account')
+@click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports")
@click.pass_context
def vim_create(ctx,
name,
tenant,
config,
account_type,
- description):
+ description,
+ sdn_controller,
+ sdn_port_mapping):
'''creates a new VIM account
'''
- vim = {}
- vim['vim-username'] = user
- vim['vim-password'] = password
- vim['vim-url'] = auth_url
- vim['vim-tenant-name'] = tenant
- vim['config'] = config
- vim['vim-type'] = account_type
- vim['description'] = description
try:
- ctx.obj.vim.create(name, vim)
+ if sdn_controller:
+ check_client_version(ctx.obj, '--sdn_controller')
+ if sdn_port_mapping:
+ check_client_version(ctx.obj, '--sdn_port_mapping')
+ vim = {}
+ vim['vim-username'] = user
+ vim['vim-password'] = password
+ vim['vim-url'] = auth_url
+ vim['vim-tenant-name'] = tenant
+ vim['vim-type'] = account_type
+ vim['description'] = description
+ vim ['config'] = config
+ if sdn_controller or sdn_port_mapping:
+ ctx.obj.vim.create(name, vim, sdn_controller, sdn_port_mapping)
+ else:
+ ctx.obj.vim.create(name, vim)
except ClientException as inst:
print(inst.message)
exit(1)
@cli.command(name='vim-update', short_help='updates a VIM account')
@click.argument('name')
-@click.option('--newname', default=None, help='New name for the VIM account')
-@click.option('--user', default=None, help='VIM username')
-@click.option('--password', default=None, help='VIM password')
-@click.option('--auth_url', default=None, help='VIM url')
-@click.option('--tenant', default=None, help='VIM tenant name')
-@click.option('--config', default=None, help='VIM specific config parameters')
-@click.option('--account_type', default=None, help='VIM type')
-@click.option('--description', default=None, help='human readable description')
+@click.option('--newname', help='New name for the VIM account')
+@click.option('--user', help='VIM username')
+@click.option('--password', help='VIM password')
+@click.option('--auth_url', help='VIM url')
+@click.option('--tenant', help='VIM tenant name')
+@click.option('--config', help='VIM specific config parameters')
+@click.option('--account_type', help='VIM type')
+@click.option('--description', help='human readable description')
+@click.option('--sdn_controller', default=None, help='Name or id of the SDN controller associated to this VIM account')
+@click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports")
@click.pass_context
def vim_update(ctx,
name,
tenant,
config,
account_type,
- description):
+ description,
+ sdn_controller,
+ sdn_port_mapping):
'''updates a VIM account
NAME: name or ID of the VIM account
'''
- vim = {}
- if newname:
- vim['name'] = newname
- vim['vim_user'] = user
- vim['vim_password'] = password
- vim['vim_url'] = auth_url
- vim['vim-tenant-name'] = tenant
- vim['config'] = config
- vim['vim_type'] = account_type
- vim['description'] = description
try:
check_client_version(ctx.obj, ctx.command.name)
- ctx.obj.vim.update(name, vim)
+ vim = {}
+ if newname: vim['name'] = newname
+ if user: vim['vim_user'] = user
+ if password: vim['vim_password'] = password
+ if auth_url: vim['vim_url'] = auth_url
+ if tenant: vim['vim-tenant-name'] = tenant
+ if account_type: vim['vim_type'] = account_type
+ if description: vim['description'] = description
+ if config: vim['config'] = config
+ ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping)
except ClientException as inst:
print(inst.message)
exit(1)
@cli.command(name='vim-delete')
@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
@click.pass_context
-def vim_delete(ctx, name):
+def vim_delete(ctx, name, force):
'''deletes a VIM account
NAME: name or ID of the VIM account to be deleted
'''
try:
- ctx.obj.vim.delete(name)
+ if not force:
+ ctx.obj.vim.delete(name)
+ else:
+ check_client_version(ctx.obj, '--force')
+ ctx.obj.vim.delete(name, force)
except ClientException as inst:
print(inst.message)
exit(1)
'''
try:
resp = ctx.obj.vim.get(name)
+ if 'vim_password' in resp:
+ resp['vim_password']='********'
except ClientException as inst:
print(inst.message)
exit(1)
print(table)
+####################
+# SDN controller operations
+####################
+
+@cli.command(name='sdnc-create')
+@click.option('--name',
+ prompt=True,
+ help='Name to create sdn controller')
+@click.option('--type',
+ prompt=True,
+ help='SDN controller type')
+@click.option('--sdn_controller_version',
+ help='SDN controller username')
+@click.option('--ip_address',
+ prompt=True,
+ help='SDN controller IP address')
+@click.option('--port',
+ prompt=True,
+ help='SDN controller port')
+@click.option('--switch_dpid',
+ prompt=True,
+ help='Switch DPID (Openflow Datapath ID)')
+@click.option('--user',
+ help='SDN controller username')
+@click.option('--password',
+ hide_input=True,
+ confirmation_prompt=True,
+ help='SDN controller password')
+#@click.option('--description',
+# default='no description',
+# help='human readable description')
+@click.pass_context
+def sdnc_create(ctx,
+ name,
+ type,
+ sdn_controller_version,
+ ip_address,
+ port,
+ switch_dpid,
+ user,
+ password):
+ '''creates a new SDN controller
+ '''
+ sdncontroller = {}
+ sdncontroller['name'] = name
+ sdncontroller['type'] = type
+ sdncontroller['ip'] = ip_address
+ sdncontroller['port'] = int(port)
+ sdncontroller['dpid'] = switch_dpid
+ if sdn_controller_version:
+ sdncontroller['version'] = sdn_controller_version
+ if user:
+ sdncontroller['user'] = user
+ if password:
+ sdncontroller['password'] = password
+# sdncontroller['description'] = description
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.sdnc.create(name, sdncontroller)
+ except ClientException as inst:
+ print(inst.message)
+
+
+@cli.command(name='sdnc-update', short_help='updates an SDN controller')
+@click.argument('name')
+@click.option('--newname', help='New name for the SDN controller')
+@click.option('--type', help='SDN controller type')
+@click.option('--sdn_controller_version', help='SDN controller username')
+@click.option('--ip_address', help='SDN controller IP address')
+@click.option('--port', help='SDN controller port')
+@click.option('--switch_dpid', help='Switch DPID (Openflow Datapath ID)')
+@click.option('--user', help='SDN controller username')
+@click.option('--password', help='SDN controller password')
+#@click.option('--description', default=None, help='human readable description')
+@click.pass_context
+def sdnc_update(ctx,
+ name,
+ newname,
+ type,
+ sdn_controller_version,
+ ip_address,
+ port,
+ switch_dpid,
+ user,
+ password):
+ '''updates an SDN controller
+
+ NAME: name or ID of the SDN controller
+ '''
+ sdncontroller = {}
+ if newname: sdncontroller['name'] = newname
+ if type: sdncontroller['type'] = type
+ if ip_address: sdncontroller['ip'] = ip_address
+ if port: sdncontroller['port'] = int(port)
+ if switch_dpid: sdncontroller['dpid'] = switch_dpid
+# sdncontroller['description'] = description
+ if sdn_controller_version is not None:
+ if sdn_controller_version=="":
+ sdncontroller['version'] = None
+ else:
+ sdncontroller['version'] = sdn_controller_version
+ if user is not None:
+ if user=="":
+ sdncontroller['user'] = None
+ else:
+ sdncontroller['user'] = user
+ if password is not None:
+ if password=="":
+ sdncontroller['password'] = None
+ else:
+ sdncontroller['password'] = user
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.sdnc.update(name, sdncontroller)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@cli.command(name='sdnc-delete')
+@click.argument('name')
+@click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
+@click.pass_context
+def sdnc_delete(ctx, name, force):
+ '''deletes an SDN controller
+
+ NAME: name or ID of the SDN controller to be deleted
+ '''
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.sdnc.delete(name, force)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@cli.command(name='sdnc-list')
+@click.option('--filter', default=None,
+ help='restricts the list to the SDN controllers matching the filter')
+@click.pass_context
+def sdnc_list(ctx, filter):
+ '''list all SDN controllers'''
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.sdnc.list(filter)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+ table = PrettyTable(['name', 'id'])
+ for sdnc in resp:
+ table.add_row([sdnc['name'], sdnc['_id']])
+ table.align = 'l'
+ print(table)
+
+
+@cli.command(name='sdnc-show')
+@click.argument('name')
+@click.pass_context
+def sdnc_show(ctx, name):
+ '''shows the details of an SDN controller
+
+ NAME: name or ID of the SDN controller
+ '''
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.sdnc.get(name)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+ table = PrettyTable(['key', 'attribute'])
+ for k, v in resp.items():
+ table.add_row([k, json.dumps(v, indent=2)])
+ table.align = 'l'
+ print(table)
+
+
+####################
+# Fault Management operations
+####################
+
+@cli.command(name='ns-alarm-create')
+@click.argument('name')
+@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)')
+@click.option('--vdu', prompt=True,
+ help='VDU name (VDU name as declared in the VNFD)')
+@click.option('--metric', prompt=True,
+ help='Name of the metric (e.g. cpu_utilization)')
+@click.option('--severity', default='WARNING',
+ help='severity of the alarm (WARNING, MINOR, MAJOR, CRITICAL, INDETERMINATE)')
+@click.option('--threshold_value', prompt=True,
+ help='threshold value that, when crossed, an alarm is triggered')
+@click.option('--threshold_operator', prompt=True,
+ help='threshold operator describing the comparison (GE, LE, GT, LT, EQ)')
+@click.option('--statistic', default='AVERAGE',
+ help='statistic (AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM)')
+@click.pass_context
+def ns_alarm_create(ctx, name, ns, vnf, vdu, metric, severity,
+ threshold_value, threshold_operator, statistic):
+ '''creates a new alarm for a NS instance'''
+ ns_instance = ctx.obj.ns.get(ns)
+ alarm = {}
+ alarm['alarm_name'] = name
+ alarm['ns_id'] = ns_instance['_id']
+ alarm['correlation_id'] = ns_instance['_id']
+ alarm['vnf_member_index'] = vnf
+ alarm['vdu_name'] = vdu
+ alarm['metric_name'] = metric
+ alarm['severity'] = severity
+ alarm['threshold_value'] = int(threshold_value)
+ alarm['operation'] = threshold_operator
+ alarm['statistic'] = statistic
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.ns.create_alarm(alarm)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+#@cli.command(name='ns-alarm-delete')
+#@click.argument('name')
+#@click.pass_context
+#def ns_alarm_delete(ctx, name):
+# '''deletes an alarm
+#
+# NAME: name of the alarm to be deleted
+# '''
+# try:
+# check_client_version(ctx.obj, ctx.command.name)
+# ctx.obj.ns.delete_alarm(name)
+# except ClientException as inst:
+# print(inst.message)
+# exit(1)
+
+
+####################
+# Performance Management operations
+####################
+
+@cli.command(name='ns-metric-export')
+@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)')
+@click.option('--vdu', prompt=True,
+ help='VDU name (VDU name as declared in the VNFD)')
+@click.option('--metric', prompt=True,
+ help='name of the metric (e.g. cpu_utilization)')
+#@click.option('--period', default='1w',
+# help='metric collection period (e.g. 20s, 30m, 2h, 3d, 1w)')
+@click.option('--interval', help='periodic interval (seconds) to export metrics continuously')
+@click.pass_context
+def ns_metric_export(ctx, ns, vnf, vdu, metric, interval):
+ '''exports a metric to the internal OSM bus, which can be read by other apps
+ '''
+ ns_instance = ctx.obj.ns.get(ns)
+ metric_data = {}
+ metric_data['ns_id'] = ns_instance['_id']
+ metric_data['correlation_id'] = ns_instance['_id']
+ metric_data['vnf_member_index'] = vnf
+ metric_data['vdu_name'] = vdu
+ metric_data['metric_name'] = metric
+ metric_data['collection_unit'] = 'WEEK'
+ metric_data['collection_period'] = 1
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ if not interval:
+ print '{}'.format(ctx.obj.ns.export_metric(metric_data))
+ else:
+ i = 1
+ while True:
+ print '{} {}'.format(ctx.obj.ns.export_metric(metric_data),i)
+ time.sleep(int(interval))
+ i+=1
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
####################
# Other operations
####################
@click.argument('ns_name')
@click.pass_context
def show_ns_scaling(ctx, ns_name):
- check_client_version(ctx.obj, ctx.command.name, 'v1')
- resp = ctx.obj.ns.list()
+ '''shows the status of a NS scaling operation
+
+ NS_NAME: name of the NS instance being scaled
+ '''
+ try:
+ check_client_version(ctx.obj, ctx.command.name, 'v1')
+ resp = ctx.obj.ns.list()
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
table = PrettyTable(
['group-name',
@click.option('--index', prompt=True)
@click.pass_context
def ns_scale(ctx, ns_name, ns_scale_group, index):
- check_client_version(ctx.obj, ctx.command.name, 'v1')
- ctx.obj.ns.scale(ns_name, ns_scale_group, index)
+ '''scales NS
+
+ NS_NAME: name of the NS instance to be scaled
+ '''
+ try:
+ check_client_version(ctx.obj, ctx.command.name, 'v1')
+ ctx.obj.ns.scale(ns_name, ns_scale_group, index)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
@cli.command(name='config-agent-list')
@click.pass_context
def config_agent_list(ctx):
- check_client_version(ctx.obj, ctx.command.name, 'v1')
+ '''list config agents'''
+ try:
+ check_client_version(ctx.obj, ctx.command.name, 'v1')
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
table = PrettyTable(['name', 'account-type', 'details'])
for account in ctx.obj.vca.list():
table.add_row(
@click.argument('name')
@click.pass_context
def config_agent_delete(ctx, name):
+ '''deletes a config agent
+
+ NAME: name of the config agent to be deleted
+ '''
try:
check_client_version(ctx.obj, ctx.command.name, 'v1')
ctx.obj.vca.delete(name)
confirmation_prompt=True)
@click.pass_context
def config_agent_add(ctx, name, account_type, server, user, secret):
+ '''adds a config agent'''
try:
check_client_version(ctx.obj, ctx.command.name, 'v1')
ctx.obj.vca.create(name, account_type, server, user, secret)
@cli.command(name='ro-dump')
@click.pass_context
def ro_dump(ctx):
+ '''shows RO agent information'''
check_client_version(ctx.obj, ctx.command.name, 'v1')
resp = ctx.obj.vim.get_resource_orchestrator()
table = PrettyTable(['key', 'attribute'])
print(table)
+@cli.command(name='ns-action')
+@click.argument('ns_name')
+@click.option('--vnf_name', default=None)
+@click.option('--action_name', prompt=True)
+@click.option('--params', prompt=True)
+@click.pass_context
+def ns_action(ctx,
+ ns_name,
+ vnf_name,
+ action_name,
+ params):
+ '''executes an action/primitive over a NS instance
+
+ NS_NAME: name or ID of the NS instance
+ '''
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ op_data={}
+ if vnf_name:
+ op_data['vnf_member_index'] = vnf_name
+ op_data['primitive'] = action_name
+ op_data['primitive_params'] = yaml.load(params)
+ ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data)
+
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
if __name__ == '__main__':
cli()