+
+@cli_osm.command(name="project-show", short_help="shows the details of a project")
+@click.argument("name")
+@click.pass_context
+def project_show(ctx, name):
+ """shows the details of a project
+
+ NAME: name or ID of the project
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.project.get(name)
+ # except ClientException as e:
+ # print(str(e))
+ # 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)
+
+
+@cli_osm.command(
+ name="project-update", short_help="updates a project (only the name can be updated)"
+)
+@click.argument("project")
+@click.option("--name", default=None, help="new name for the project")
+@click.option(
+ "--quotas",
+ "quotas",
+ multiple=True,
+ default=None,
+ help="change quotas. Can be used several times: 'quota1=number|empty[,quota2=...]' "
+ "(use empty to reset quota to default",
+)
+@click.pass_context
+def project_update(ctx, project, name, quotas):
+ """
+ Update a project name
+
+ :param ctx:
+ :param project: id or name of the project to modify
+ :param name: new name for the project
+ :param quotas: change quotas of the project
+ :return:
+ """
+ logger.debug("")
+ project_changes = {}
+ if name:
+ project_changes["name"] = name
+ quotas_dict = _process_project_quotas(quotas)
+ if quotas_dict:
+ project_changes["quotas"] = quotas_dict
+
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.project.update(project, project_changes)
+ # except ClientException as e:
+ # print(str(e))
+
+
+####################
+# User mgmt operations
+####################
+
+
+@cli_osm.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="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
+)
+@click.option("--domain-name", "domain_name", default=None, help="assign to a domain")
+@click.pass_context
+def user_create(ctx, username, password, projects, project_role_mappings, domain_name):
+ """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)
+ DOMAIN_NAME: optional domain name for the user when keystone authentication is used
+ """
+ logger.debug("")
+ user = {}
+ user["username"] = username
+ user["password"] = password
+ user["projects"] = projects
+ user["project_role_mappings"] = project_role_mappings
+ if domain_name:
+ user["domain_name"] = domain_name
+
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.create(username, user)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.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 roles 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="assign role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
+)
+@click.option(
+ "--remove-project-role",
+ "remove_project_role",
+ default=None,
+ multiple=True,
+ help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'",
+)
+@click.option("--change_password", "change_password", help="user's current password")
+@click.option(
+ "--new_password",
+ "new_password",
+ help="user's new password to update in expiry condition",
+)
+@click.pass_context
+def user_update(
+ ctx,
+ username,
+ password,
+ set_username,
+ set_project,
+ remove_project,
+ add_project_role,
+ remove_project_role,
+ change_password,
+ new_password,
+):
+ """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)
+ CHANGE_PASSWORD: user's current password to change
+ NEW_PASSWORD: user's new password to update in expiry condition
+ """
+ logger.debug("")
+ 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
+ user["change_password"] = change_password
+ user["new_password"] = new_password
+
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ if not user.get("change_password"):
+ ctx.obj.user.update(username, user)
+ else:
+ ctx.obj.user.update(username, user, pwd_change=True)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.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
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.user.delete(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.command(name="user-list", short_help="list all users")
+@click.option(
+ "--filter",
+ default=None,
+ multiple=True,
+ 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)
+ if filter:
+ filter = "&".join(filter)
+ resp = ctx.obj.user.list(filter)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+ table = PrettyTable(["name", "id"])
+ for user in resp:
+ table.add_row([user["username"], user["_id"]])
+ table.align = "l"
+ print(table)
+
+
+@cli_osm.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
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.user.get(name)
+ if "password" in resp:
+ resp["password"] = "********"
+ # except ClientException as e:
+ # print(str(e))
+ # 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_osm.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)?
+ logger.debug("")
+ # 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 e:
+ # print(str(e))
+ # exit(1)
+
+
+# @cli_osm.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 e:
+# print(str(e))
+# exit(1)
+
+
+####################
+# Performance Management operations
+####################
+
+
+@cli_osm.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?
+ logger.debug("")
+ # 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 e:
+ # print(str(e))
+ # exit(1)
+
+
+#################
+# Subscription operations
+#################
+
+
+@cli_osm.command(
+ name="subscription-create",
+ short_help="creates a new subscription to a specific event",
+)
+@click.option(
+ "--event_type",
+ # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+ type=click.Choice(["ns"], case_sensitive=False),
+ help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.option("--event", default=None, help="specific yaml configuration for the event")
+@click.option(
+ "--event_file", default=None, help="specific yaml configuration file for the event"
+)
+@click.pass_context
+def subscription_create(ctx, event_type, event, event_file):
+ """creates a new subscription to a specific event"""
+ logger.debug("")
+ check_client_version(ctx.obj, ctx.command.name)
+ if event_file:
+ if event:
+ raise ClientException(
+ '"--event" option is incompatible with "--event_file" option'
+ )
+ with open(event_file, "r") as cf:
+ event = cf.read()
+ ctx.obj.subscription.create(event_type, event)
+
+
+@cli_osm.command(name="subscription-delete", short_help="deletes a subscription")
+@click.option(
+ "--event_type",
+ # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+ type=click.Choice(["ns"], case_sensitive=False),
+ help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.argument("subscription_id")
+@click.option(
+ "--force", is_flag=True, help="forces the deletion bypassing pre-conditions"
+)
+@click.pass_context
+def subscription_delete(ctx, event_type, subscription_id, force):
+ """deletes a subscription
+
+ SUBSCRIPTION_ID: ID of the subscription to be deleted
+ """
+ logger.debug("")
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.subscription.delete(event_type, subscription_id, force)
+
+
+@cli_osm.command(name="subscription-list", short_help="list all subscriptions")
+@click.option(
+ "--event_type",
+ # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+ type=click.Choice(["ns"], case_sensitive=False),
+ help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.option(
+ "--filter",
+ default=None,
+ multiple=True,
+ help="restricts the list to the subscriptions matching the filter",
+)
+@click.pass_context
+def subscription_list(ctx, event_type, filter):
+ """list all subscriptions"""
+ logger.debug("")
+ check_client_version(ctx.obj, ctx.command.name)
+ if filter:
+ filter = "&".join(filter)
+ resp = ctx.obj.subscription.list(event_type, filter)
+ table = PrettyTable(["id", "filter", "CallbackUri"])
+ for sub in resp:
+ table.add_row(
+ [
+ sub["_id"],
+ wrap_text(text=json.dumps(sub["filter"], indent=2), width=70),
+ sub["CallbackUri"],
+ ]
+ )
+ table.align = "l"
+ print(table)
+
+
+@cli_osm.command(
+ name="subscription-show", short_help="shows the details of a subscription"
+)
+@click.argument("subscription_id")
+@click.option(
+ "--event_type",
+ # type=click.Choice(['ns', 'nspkg', 'vnfpkg'], case_sensitive=False))
+ type=click.Choice(["ns"], case_sensitive=False),
+ help="event type to be subscribed (for the moment, only ns is supported)",
+)
+@click.option(
+ "--filter",
+ multiple=True,
+ help="restricts the information to the fields in the filter",
+)
+@click.pass_context
+def subscription_show(ctx, event_type, subscription_id, filter):
+ """shows the details of a subscription
+
+ SUBSCRIPTION_ID: ID of the subscription
+ """
+ logger.debug("")
+ # try:
+ resp = ctx.obj.subscription.get(subscription_id)
+ table = PrettyTable(["key", "attribute"])
+ for k, v in list(resp.items()):
+ if not filter or k in filter:
+ table.add_row([k, wrap_text(text=json.dumps(v, indent=2), width=100)])
+ table.align = "l"
+ print(table)
+
+
+####################
+# Other operations
+####################
+
+
+@cli_osm.command(name="version", short_help="shows client and server versions")
+@click.pass_context
+def get_version(ctx):
+ """shows client and server versions"""
+ # try:
+ check_client_version(ctx.obj, "version")
+ print("Server version: {}".format(ctx.obj.get_version()))
+ print(
+ "Client version: {}".format(pkg_resources.get_distribution("osmclient").version)
+ )
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.command(
+ name="upload-package", short_help="uploads a VNF package or NS package"
+)
+@click.argument("filename")
+@click.option(
+ "--skip-charm-build",
+ default=False,
+ is_flag=True,
+ help="the charm will not be compiled, it is assumed to already exist",
+)
+@click.pass_context
+def upload_package(ctx, filename, skip_charm_build):
+ """uploads a vnf package or ns package
+
+ filename: vnf or ns package folder, or vnf or ns package file (tar.gz)
+ """
+ logger.debug("")
+ # try:
+ ctx.obj.package.upload(filename, skip_charm_build=skip_charm_build)
+ fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
+ if fullclassname != "osmclient.sol005.client.Client":
+ ctx.obj.package.wait_for_upload(filename)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+# @cli_osm.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 e:
+# print(str(e))
+# 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_osm.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 e:
+# print(str(e))
+# exit(1)
+
+
+# @cli_osm.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 e:
+# print(str(e))
+# 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_osm.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 e:
+# print(str(e))
+# exit(1)
+
+
+# @cli_osm.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 e:
+# print(str(e))
+# exit(1)
+
+
+# @cli_osm.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_osm.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_osm.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("--kdu_name", default=None, help="kdu-name if the target is a kdu)")
+@click.option("--vdu_id", default=None, help="vdu-id if the target is a vdu")
+@click.option(
+ "--vdu_count", default=None, type=int, help="number of vdu instance of this vdu_id"
+)
+@click.option("--action_name", prompt=True, help="action name")
+@click.option("--params", default=None, help="action params in YAML/JSON inline string")
+@click.option("--params_file", default=None, help="YAML/JSON file with action params")
+@click.option(
+ "--timeout", required=False, default=None, type=int, help="timeout in seconds"
+)
+@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,
+ kdu_name,
+ vdu_id,
+ vdu_count,
+ action_name,
+ params,
+ params_file,
+ timeout,
+ wait,
+):
+ """executes an action/primitive over a NS instance
+
+ NS_NAME: name or ID of the NS instance
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ op_data = {}
+ if vnf_name:
+ op_data["member_vnf_index"] = vnf_name
+ if kdu_name:
+ op_data["kdu_name"] = kdu_name
+ if vdu_id:
+ op_data["vdu_id"] = vdu_id
+ if vdu_count is not None:
+ op_data["vdu_count_index"] = vdu_count
+ if timeout:
+ op_data["timeout_ns_action"] = timeout
+ op_data["primitive"] = action_name
+ if params_file:
+ with open(params_file, "r") as pf:
+ params = pf.read()
+ if params:
+ op_data["primitive_params"] = yaml.safe_load(params)
+ else:
+ op_data["primitive_params"] = {}
+ print(ctx.obj.ns.exec_op(ns_name, op_name="action", op_data=op_data, wait=wait))
+
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.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.option(
+ "--timeout", required=False, default=None, type=int, help="timeout in seconds"
+)
+@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 vnf_scale(
+ ctx, ns_name, vnf_name, scaling_group, scale_in, scale_out, timeout, wait
+):
+ """
+ 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.
+ """
+ logger.debug("")
+ # 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, wait, timeout
+ )
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.command(
+ name="ns-update", short_help="executes an update of a Network Service."
+)
+@click.argument("ns_name")
+@click.option(
+ "--updatetype", required=True, type=str, help="available types: CHANGE_VNFPKG"
+)
+@click.option(
+ "--config",
+ required=True,
+ type=str,
+ help="extra information for update operation as YAML/JSON inline string as --config"
+ " '{changeVnfPackageData:[{vnfInstanceId: xxx, vnfdId: yyy}]}'",
+)
+@click.option(
+ "--timeout", required=False, default=None, type=int, help="timeout in seconds"
+)
+@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 update(ctx, ns_name, updatetype, config, timeout, wait):
+ """Executes an update of a Network Service.
+
+ The update will check new revisions of the Network Functions that are part of the
+ Network Service, and it will update them if needed.
+ Sample update command: osm ns-update ns_instance_id --updatetype CHANGE_VNFPKG
+ --config '{changeVnfPackageData: [{vnfInstanceId: id_x,vnfdId: id_y}]}' --timeout 300 --wait
+
+ NS_NAME: Network service instance name or ID.
+
+ """
+ op_data = {
+ "timeout": timeout,
+ "updateType": updatetype,
+ }
+ if config:
+ op_data["config"] = yaml.safe_load(config)
+
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.ns.update(ns_name, op_data, wait=wait)
+
+
+def iterator_split(iterator, separators):
+ """
+ Splits a tuple or list into several lists whenever a separator is found
+ For instance, the following tuple will be separated with the separator "--vnf" as follows.
+ From:
+ ("--vnf", "A", "--cause", "cause_A", "--vdu", "vdu_A1", "--vnf", "B", "--cause", "cause_B", ...
+ "--vdu", "vdu_B1", "--count_index", "1", "--run-day1", "--vdu", "vdu_B1", "--count_index", "2")
+ To:
+ [
+ ("--vnf", "A", "--cause", "cause_A", "--vdu", "vdu_A1"),
+ ("--vnf", "B", "--cause", "cause_B", "--vdu", "vdu_B1", "--count_index", "1", "--run-day1", ...
+ "--vdu", "vdu_B1", "--count_index", "2")
+ ]
+
+ Returns as many lists as separators are found
+ """
+ logger.debug("")
+ if iterator[0] not in separators:
+ raise ClientException(f"Expected one of {separators}. Received: {iterator[0]}.")
+ list_of_lists = []
+ first = 0
+ for i in range(len(iterator)):
+ if iterator[i] in separators:
+ if i == first:
+ continue
+ if i - first < 2:
+ raise ClientException(
+ f"Expected at least one argument after separator (possible separators: {separators})."
+ )
+ list_of_lists.append(list(iterator[first:i]))
+ first = i
+ if (len(iterator) - first) < 2:
+ raise ClientException(
+ f"Expected at least one argument after separator (possible separators: {separators})."
+ )
+ else:
+ list_of_lists.append(list(iterator[first : len(iterator)]))
+ # logger.debug(f"List of lists: {list_of_lists}")
+ return list_of_lists
+
+
+def process_common_heal_params(heal_vnf_dict, args):
+ logger.debug("")
+ current_item = "vnf"
+ i = 0
+ while i < len(args):
+ if args[i] == "--cause":
+ if (i + 1 >= len(args)) or args[i + 1].startswith("--"):
+ raise ClientException("No cause was provided after --cause")
+ heal_vnf_dict["cause"] = args[i + 1]
+ i = i + 2
+ continue
+ if args[i] == "--run-day1":
+ if current_item == "vnf":
+ if "additionalParams" not in heal_vnf_dict:
+ heal_vnf_dict["additionalParams"] = {}
+ heal_vnf_dict["additionalParams"]["run-day1"] = True
+ else:
+ # if current_item == "vdu"
+ heal_vnf_dict["additionalParams"]["vdu"][-1]["run-day1"] = True
+ i = i + 1
+ continue
+ if args[i] == "--vdu":
+ if "additionalParams" not in heal_vnf_dict:
+ heal_vnf_dict["additionalParams"] = {}
+ heal_vnf_dict["additionalParams"]["vdu"] = []
+ if (i + 1 >= len(args)) or args[i + 1].startswith("--"):
+ raise ClientException("No VDU ID was provided after --vdu")
+ heal_vnf_dict["additionalParams"]["vdu"].append({"vdu-id": args[i + 1]})
+ current_item = "vdu"
+ i = i + 2
+ continue
+ if args[i] == "--count-index":
+ if current_item == "vnf":
+ raise ClientException(
+ "Option --count-index only applies to VDU, not to VNF"
+ )
+ if (i + 1 >= len(args)) or args[i + 1].startswith("--"):
+ raise ClientException("No count index was provided after --count-index")
+ heal_vnf_dict["additionalParams"]["vdu"][-1]["count-index"] = int(
+ args[i + 1]
+ )
+ i = i + 2
+ continue
+ i = i + 1
+ return
+
+
+def process_ns_heal_params(ctx, param, value):
+ """
+ Processes the params in the command ns-heal
+ Click does not allow advanced patterns for positional options like this:
+ --vnf volumes_vnf --cause "Heal several_volumes-VM of several_volumes_vnf"
+ --vdu several_volumes-VM
+ --vnf charm_vnf --cause "Heal two VMs of native_manual_scale_charm_vnf"
+ --vdu mgmtVM --count-index 1 --run-day1
+ --vdu mgmtVM --count-index 2
+
+ It returns the dictionary with all the params stored in ctx.params["heal_params"]
+ """
+ logger.debug("")
+ # logger.debug(f"Args: {value}")
+ if param.name != "args":
+ raise ClientException(f"Unexpected param: {param.name}")
+ # Split the tuple "value" by "--vnf"
+ vnfs = iterator_split(value, ["--vnf"])
+ logger.debug(f"VNFs: {vnfs}")
+ heal_dict = {}
+ heal_dict["healVnfData"] = []
+ for vnf in vnfs:
+ # logger.debug(f"VNF: {vnf}")
+ heal_vnf = {}
+ if vnf[1].startswith("--"):
+ raise ClientException("Expected a VNF_ID after --vnf")
+ heal_vnf["vnfInstanceId"] = vnf[1]
+ process_common_heal_params(heal_vnf, vnf[2:])
+ heal_dict["healVnfData"].append(heal_vnf)
+ ctx.params["heal_params"] = heal_dict
+ return
+
+
+@cli_osm.command(
+ name="ns-heal",
+ short_help="heals (recreates) VNFs or VDUs of a NS instance",
+ context_settings=dict(
+ ignore_unknown_options=True,
+ ),
+)
+@click.argument("ns_name")
+@click.argument(
+ "args",
+ nargs=-1,
+ type=click.UNPROCESSED,
+ callback=process_ns_heal_params,
+)
+@click.option("--timeout", type=int, default=None, help="timeout in seconds")
+@click.option(
+ "--wait",
+ 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_heal(ctx, ns_name, args, heal_params, timeout, wait):
+ """heals (recreates) VNFs or VDUs of a NS instance
+
+ NS_NAME: name or ID of the NS instance
+
+ \b
+ Options:
+ --vnf TEXT VNF instance ID or VNF id in the NS [required]
+ --cause TEXT human readable cause of the healing
+ --run-day1 indicates whether or not to run day1 primitives for the VNF/VDU
+ --vdu TEXT vdu-id
+ --count-index INTEGER count-index
+
+ \b
+ Example:
+ osm ns-heal NS_NAME|NS_ID --vnf volumes_vnf --cause "Heal several_volumes-VM of several_volumes_vnf"
+ --vdu several_volumes-VM
+ --vnf charm_vnf --cause "Heal two VMs of native_manual_scale_charm_vnf"
+ --vdu mgmtVM --count-index 1 --run-day1
+ --vdu mgmtVM --count-index 2
+ """
+ logger.debug("")
+ heal_dict = ctx.params["heal_params"]
+ logger.debug(f"Heal dict:\n{yaml.safe_dump(heal_dict)}")
+ # replace VNF id in the NS by the VNF instance ID
+ for vnf in heal_dict["healVnfData"]:
+ vnf_id = vnf["vnfInstanceId"]
+ if not validate_uuid4(vnf_id):
+ vnf_filter = f"member-vnf-index-ref={vnf_id}"
+ vnf_list = ctx.obj.vnf.list(ns=ns_name, filter=vnf_filter)
+ if len(vnf_list) == 0:
+ raise ClientException(
+ f"No VNF found in NS {ns_name} with filter {vnf_filter}"
+ )
+ elif len(vnf_list) == 1:
+ vnf["vnfInstanceId"] = vnf_list[0]["_id"]
+ else:
+ raise ClientException(
+ f"More than 1 VNF found in NS {ns_name} with filter {vnf_filter}"
+ )
+ logger.debug(f"Heal dict:\n{yaml.safe_dump(heal_dict)}")
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.ns.heal(ns_name, heal_dict, wait, timeout)
+ exit(0)
+
+
+def process_vnf_heal_params(ctx, param, value):
+ """
+ Processes the params in the command vnf-heal
+ Click does not allow advanced patterns for positional options like this:
+ --vdu mgmtVM --count-index 1 --run-day1 --vdu mgmtVM --count-index 2
+
+ It returns the dictionary with all the params stored in ctx.params["heal_params"]
+ """
+ logger.debug("")
+ # logger.debug(f"Args: {value}")
+ if param.name != "args":
+ raise ClientException(f"Unexpected param: {param.name}")
+ # Split the tuple "value" by "--vnf"
+ vnf = value
+ heal_dict = {}
+ heal_dict["healVnfData"] = []
+ logger.debug(f"VNF: {vnf}")
+ heal_vnf = {"vnfInstanceId": "id_to_be_substituted"}
+ process_common_heal_params(heal_vnf, vnf)
+ heal_dict["healVnfData"].append(heal_vnf)
+ ctx.params["heal_params"] = heal_dict
+ return
+
+
+@cli_osm.command(
+ name="vnf-heal",
+ short_help="heals (recreates) a VNF instance or the VDUs of a VNF instance",
+ context_settings=dict(
+ ignore_unknown_options=True,
+ ),
+)
+@click.argument("vnf_name")
+@click.argument(
+ "args",
+ nargs=-1,
+ type=click.UNPROCESSED,
+ callback=process_vnf_heal_params,
+)
+@click.option("--timeout", type=int, default=None, help="timeout in seconds")
+@click.option(
+ "--wait",
+ 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 vnf_heal2(
+ ctx,
+ vnf_name,
+ args,
+ heal_params,
+ timeout,
+ wait,
+):
+ """heals (recreates) a VNF instance or the VDUs of a VNF instance
+
+ VNF_NAME: name or ID of the VNF instance
+
+ \b
+ Options:
+ --cause TEXT human readable cause of the healing of the VNF
+ --run-day1 indicates whether or not to run day1 primitives for the VNF/VDU
+ --vdu TEXT vdu-id
+ --count-index INTEGER count-index
+
+ \b
+ Example:
+ osm vnf-heal VNF_INSTANCE_ID --vdu mgmtVM --count-index 1 --run-day1
+ --vdu mgmtVM --count-index 2
+ """
+ logger.debug("")
+ heal_dict = ctx.params["heal_params"]
+ heal_dict["healVnfData"][-1]["vnfInstanceId"] = vnf_name
+ logger.debug(f"Heal dict:\n{yaml.safe_dump(heal_dict)}")
+ check_client_version(ctx.obj, ctx.command.name)
+ vnfr = ctx.obj.vnf.get(vnf_name)
+ ns_id = vnfr["nsr-id-ref"]
+ ctx.obj.ns.heal(ns_id, heal_dict, wait, timeout)
+ exit(0)
+
+
+@cli_osm.command(name="alarm-show", short_help="show alarm details")
+@click.argument("uuid")
+@click.pass_context
+def alarm_show(ctx, uuid):
+ """Show alarm's detail information"""
+
+ check_client_version(ctx.obj, ctx.command.name)
+ resp = ctx.obj.ns.get_alarm(uuid=uuid)
+ alarm_filter = [
+ "uuid",
+ "name",
+ "metric",
+ "statistic",
+ "threshold",
+ "operation",
+ "ns-id",
+ "vnf-id",
+ "vdu_name",
+ "action",
+ "status",
+ ]
+ table = PrettyTable(["key", "attribute"])
+ try:
+ # Arrange and return the response data
+ alarm = resp.replace("ObjectId", "")
+ for key in alarm_filter:
+ if key == "uuid":
+ value = alarm.get(key)
+ key = "alarm-id"
+ elif key == "name":
+ value = alarm.get(key)
+ key = "alarm-name"
+ elif key == "ns-id":
+ value = alarm["tags"].get("ns_id")
+ elif key == "vdu_name":
+ value = alarm["tags"].get("vdu_name")
+ elif key == "status":
+ value = alarm["alarm_status"]
+ else:
+ value = alarm[key]
+ table.add_row([key, wrap_text(text=json.dumps(value, indent=2), width=100)])
+ table.align = "l"
+ print(table)
+ except Exception:
+ print(resp)
+
+
+# List alarm
+@cli_osm.command(name="alarm-list", short_help="list all alarms")
+@click.option(
+ "--ns_id", default=None, required=False, help="List out alarm for given ns id"
+)
+@click.pass_context
+def alarm_list(ctx, ns_id):
+ """list all alarm"""
+
+ check_client_version(ctx.obj, ctx.command.name)
+ project_name = os.getenv("OSM_PROJECT", "admin")
+ resp = ctx.obj.ns.get_alarm(project_name=project_name, ns_id=ns_id)
+
+ table = PrettyTable(
+ ["alarm-id", "metric", "threshold", "operation", "action", "status"]
+ )
+ if resp:
+ # return the response data in a table
+ resp = resp.replace("ObjectId", "")
+ for alarm in resp:
+ table.add_row(
+ [
+ wrap_text(text=str(alarm["uuid"]), width=38),
+ alarm["metric"],
+ alarm["threshold"],
+ alarm["operation"],
+ wrap_text(text=alarm["action"], width=25),
+ alarm["alarm_status"],
+ ]
+ )
+ table.align = "l"
+ print(table)
+
+
+# Update alarm
+@cli_osm.command(name="alarm-update", short_help="Update a alarm")
+@click.argument("uuid")
+@click.option("--threshold", default=None, help="Alarm threshold")
+@click.option("--is_enable", default=None, type=bool, help="enable or disable alarm")
+@click.pass_context
+def alarm_update(ctx, uuid, threshold, is_enable):
+ """
+ Update alarm
+
+ """
+ if not threshold and is_enable is None:
+ raise ClientException(
+ "Please provide option to update i.e threshold or is_enable"
+ )
+ ctx.obj.ns.update_alarm(uuid, threshold, is_enable)
+
+
+##############################
+# Role Management Operations #
+##############################
+
+
+@cli_osm.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.
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.create(name, permissions)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.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.
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.update(name, set_name, None, add, remove)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.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.
+ """
+ logger.debug("")
+ # try:
+ check_client_version(ctx.obj, ctx.command.name)
+ ctx.obj.role.delete(name)
+ # except ClientException as e:
+ # print(str(e))
+ # exit(1)
+
+
+@cli_osm.command(name="role-list", short_help="list all roles")
+@click.option(
+ "--filter",
+ default=None,
+ multiple=True,
+ help="restricts the list to the projects matching the filter",
+)