+@cli.command(name='project-update', short_help='updates a project (only the name can be updated)')
+@click.argument('project')
+@click.option('--name',
+ prompt=True,
+ help='new name for the project')
+
+@click.pass_context
+def project_update(ctx, project, name):
+ """
+ Update a project name
+
+ :param ctx:
+ :param project: id or name of the project to modify
+ :param name: new name for the project
+ :return:
+ """
+
+ project_changes = {}
+ project_changes['name'] = name
+
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.project.update(project, project_changes)
+ except ClientException as inst:
+ print(inst.message)
+
+
+####################
+# User mgmt operations
+####################
+
+@cli.command(name='user-create', short_help='creates a new user')
+@click.argument('username')
+@click.option('--password',
+ prompt=True,
+ hide_input=True,
+ confirmation_prompt=True,
+ help='user password')
+@click.option('--projects',
+ # prompt="Comma separate list of projects",
+ multiple=True,
+ callback=lambda ctx, param, value: ''.join(value).split(',') if all(len(x)==1 for x in value) else value,
+ help='list of project ids that the user belongs to')
+@click.option('--project-role-mappings', 'project_role_mappings',
+ default=None, multiple=True,
+ help='creating user project/role(s) mapping')
+@click.pass_context
+def user_create(ctx, username, password, projects, project_role_mappings):
+ """Creates a new user
+
+ \b
+ USERNAME: name of the user
+ PASSWORD: password of the user
+ PROJECTS: projects assigned to user (internal only)
+ PROJECT_ROLE_MAPPING: roles in projects assigned to user (keystone)
+ """
+ user = {}
+ user['username'] = username
+ user['password'] = password
+ user['projects'] = projects
+ user['project_role_mappings'] = project_role_mappings
+
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.create(username, user)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@cli.command(name='user-update', short_help='updates user information')
+@click.argument('username')
+@click.option('--password',
+ # prompt=True,
+ # hide_input=True,
+ # confirmation_prompt=True,
+ help='user password')
+@click.option('--set-username', 'set_username',
+ default=None,
+ help='change username')
+@click.option('--set-project', 'set_project',
+ default=None, multiple=True,
+ help='create/replace the project,role(s) mapping for this project: \'project,role1,role2,...\'')
+@click.option('--remove-project', 'remove_project',
+ default=None, multiple=True,
+ help='removes project from user: \'project\'')
+@click.option('--add-project-role', 'add_project_role',
+ default=None, multiple=True,
+ help='adds project,role(s) mapping: \'project,role1,role2,...\'')
+@click.option('--remove-project-role', 'remove_project_role',
+ default=None, multiple=True,
+ help='removes project,role(s) mapping: \'project,role1,role2,...\'')
+@click.pass_context
+def user_update(ctx, username, password, set_username, set_project, remove_project,
+ add_project_role, remove_project_role):
+ """Update a user information
+
+ \b
+ USERNAME: name of the user
+ PASSWORD: new password
+ SET_USERNAME: new username
+ SET_PROJECT: creating mappings for project/role(s)
+ REMOVE_PROJECT: deleting mappings for project/role(s)
+ ADD_PROJECT_ROLE: adding mappings for project/role(s)
+ REMOVE_PROJECT_ROLE: removing mappings for project/role(s)
+ """
+ user = {}
+ user['password'] = password
+ user['username'] = set_username
+ user['set-project'] = set_project
+ user['remove-project'] = remove_project
+ user['add-project-role'] = add_project_role
+ user['remove-project-role'] = remove_project_role
+
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.update(username, user)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@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
+def user_delete(ctx, name):
+ """deletes a user
+
+ \b
+ NAME: name or ID of the user to be deleted
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.delete(name)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@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
+def user_list(ctx, filter):
+ """list all users"""
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.user.list(filter)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+ table = PrettyTable(['name', 'id'])
+ for user in resp:
+ table.add_row([user['username'], user['_id']])
+ table.align = 'l'
+ print(table)
+
+
+@cli.command(name='user-show', short_help='shows the details of a user')
+@click.argument('name')
+@click.pass_context
+def user_show(ctx, name):
+ """shows the details of a user
+
+ NAME: name or ID of the user
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.user.get(name)
+ if 'password' in resp:
+ resp['password']='********'
+ 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"""
+ # TODO: Check how to validate threshold_value.
+ # Should it be an integer (1-100), percentage, or decimal (0.01-1.00)?
+ try:
+ 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
+ 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', 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)')
+@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"""
+ # TODO: Check how to validate interval.
+ # Should it be an integer (seconds), or should a suffix (s,m,h,d,w) also be permitted?
+ try:
+ 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
+ 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
+####################
+
+@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):
+ """uploads a VNF package or NS package
+
+ FILENAME: VNF or NS package file (tar.gz)
+ """
+ try:
+ ctx.obj.package.upload(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))
+ exit(1)
+
+
+#@cli.command(name='ns-scaling-show')
+#@click.argument('ns_name')
+#@click.pass_context
+#def show_ns_scaling(ctx, ns_name):
+# """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',
+# 'instance-id',
+# 'operational status',
+# 'create-time',
+# 'vnfr ids'])
+#
+# for ns in resp:
+# if ns_name == ns['name']:
+# nsopdata = ctx.obj.ns.get_opdata(ns['id'])
+# scaling_records = nsopdata['nsr:nsr']['scaling-group-record']
+# for record in scaling_records:
+# if 'instance' in record:
+# instances = record['instance']
+# for inst in instances:
+# table.add_row(
+# [record['scaling-group-name-ref'],
+# inst['instance-id'],
+# inst['op-status'],
+# time.strftime('%Y-%m-%d %H:%M:%S',
+# time.localtime(
+# inst['create-time'])),
+# inst['vnfrs']])
+# table.align = 'l'
+# print(table)
+
+
+#@cli.command(name='ns-scale')
+#@click.argument('ns_name')
+#@click.option('--ns_scale_group', prompt=True)
+#@click.option('--index', prompt=True)
+#@click.option('--wait',
+# required=False,
+# default=False,
+# is_flag=True,
+# help='do not return the control immediately, but keep it \
+# until the operation is completed, or timeout')
+#@click.pass_context
+#def ns_scale(ctx, ns_name, ns_scale_group, index, wait):
+# """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, wait=wait)
+# except ClientException as inst:
+# print((inst.message))
+# exit(1)
+
+
+#@cli.command(name='config-agent-list')
+#@click.pass_context
+#def config_agent_list(ctx):
+# """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(
+# [account['name'],
+# account['account-type'],
+# account['juju']])
+# table.align = 'l'
+# print(table)
+
+
+#@cli.command(name='config-agent-delete')
+#@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)
+# except ClientException as inst:
+# print((inst.message))
+# exit(1)
+
+
+#@cli.command(name='config-agent-add')
+#@click.option('--name',
+# prompt=True)
+#@click.option('--account_type',
+# prompt=True)
+#@click.option('--server',
+# prompt=True)
+#@click.option('--user',
+# prompt=True)
+#@click.option('--secret',
+# prompt=True,
+# hide_input=True,
+# 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)
+# except ClientException as inst:
+# print((inst.message))
+# exit(1)
+
+
+#@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'])
+# for k, v in list(resp.items()):
+# table.add_row([k, json.dumps(v, indent=2)])
+# table.align = 'l'
+# print(table)
+
+
+#@cli.command(name='vcs-list')
+#@click.pass_context
+#def vcs_list(ctx):
+# check_client_version(ctx.obj, ctx.command.name, 'v1')
+# resp = ctx.obj.utils.get_vcs_info()
+# table = PrettyTable(['component name', 'state'])
+# for component in resp:
+# table.add_row([component['component_name'], component['state']])
+# table.align = 'l'
+# print(table)
+
+
+@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')
+@click.option('--vdu_count', default=None, help='number of vdu instance of this vdu_id')
+@click.option('--action_name', prompt=True)
+@click.option('--params', default=None)
+@click.option('--wait',
+ required=False,
+ default=False,
+ is_flag=True,
+ help='do not return the control immediately, but keep it \
+ until the operation is completed, or timeout')
+@click.pass_context
+def ns_action(ctx,
+ ns_name,
+ vnf_name,
+ vdu_id,
+ vdu_count,
+ action_name,
+ params,
+ wait):
+ """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['member_vnf_index'] = vnf_name
+ if vdu_id:
+ op_data['vdu_id'] = vdu_id
+ if vdu_count:
+ op_data['vdu_count_index'] = vdu_count
+ op_data['primitive'] = action_name
+ if 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)
+ exit(1)
+
+
+@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")
+@click.option('--scale-in', default=False, is_flag=True, help="performs a scale in operation")
+@click.option('--scale-out', default=False, is_flag=True, help="performs a scale out operation (by default)")
+@click.pass_context
+def vnf_scale(ctx,
+ ns_name,
+ vnf_name,
+ scaling_group,
+ scale_in,
+ scale_out):
+ """
+ Executes a VNF scale (adding/removing VDUs)
+
+ \b
+ NS_NAME: name or ID of the NS instance.
+ VNF_NAME: member-vnf-index in the NS to be scaled.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ 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))
+ exit(1)
+
+
+##############################
+# Role Management Operations #
+##############################
+
+@cli.command(name='role-create', short_help='creates a new role')
+@click.argument('name')
+@click.option('--permissions',
+ default=None,
+ help='role permissions using a dictionary')
+@click.pass_context
+def role_create(ctx, name, permissions):
+ """
+ Creates a new role.
+
+ \b
+ NAME: Name or ID of the role.
+ DEFINITION: Definition of grant/denial of access to resources.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.create(name, permissions)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@cli.command(name='role-update', short_help='updates a role')
+@click.argument('name')
+@click.option('--set-name',
+ default=None,
+ help='change name of rle')
+# @click.option('--permissions',
+# default=None,
+# help='provide a yaml format dictionary with incremental changes. Values can be bool or None to delete')
+@click.option('--add',
+ default=None,
+ help='yaml format dictionary with permission: True/False to access grant/denial')
+@click.option('--remove',
+ default=None,
+ help='yaml format list to remove a permission')
+@click.pass_context
+def role_update(ctx, name, set_name, add, remove):
+ """
+ Updates a role.
+
+ \b
+ NAME: Name or ID of the role.
+ DEFINITION: Definition overwrites the old definition.
+ ADD: Grant/denial of access to resource to add.
+ REMOVE: Grant/denial of access to resource to remove.
+ """
+ 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)
+ exit(1)
+
+
+@cli.command(name='role-delete', short_help='deletes a role')
+@click.argument('name')
+# @click.option('--force', is_flag=True, help='forces the deletion bypassing pre-conditions')
+@click.pass_context
+def role_delete(ctx, name):
+ """
+ Deletes a role.
+
+ \b
+ NAME: Name or ID of the role.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.delete(name)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+
+
+@cli.command(name='role-list', short_help='list all roles')
+@click.option('--filter', default=None,
+ help='restricts the list to the projects matching the filter')
+@click.pass_context
+def role_list(ctx, filter):
+ """
+ List all roles.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.role.list(filter)
+ except ClientException as inst:
+ print(inst.message)
+ exit(1)
+ table = PrettyTable(['name', 'id'])
+ for role in resp:
+ table.add_row([role['name'], role['_id']])
+ table.align = 'l'
+ print(table)
+
+
+@cli.command(name='role-show', short_help='show specific role')
+@click.argument('name')
+@click.pass_context
+def role_show(ctx, name):
+ """
+ Shows the details of a role.
+
+ \b
+ NAME: Name or ID of the role.
+ """
+ try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.role.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)
+