@click.option('-v', '--verbose', count=True,
help='increase verbosity (-v INFO, -vv VERBOSE, -vvv DEBUG)')
@click.option('--all-projects',
- default=False,
+ default=None,
is_flag=True,
help='include all projects')
@click.option('--public/--no-public', default=None,
help='flag for public items (packages, instances, VIM accounts, etc.)')
+@click.option('--project-domain-name', 'project_domain_name',
+ default=None,
+ envvar='OSM_PROJECT_DOMAIN_NAME',
+ help='project domain name for keystone authentication (default to None). ' +
+ 'Also can set OSM_PROJECT_DOMAIN_NAME in environment')
+@click.option('--user-domain-name', 'user_domain_name',
+ default=None,
+ envvar='OSM_USER_DOMAIN_NAME',
+ help='user domain name for keystone authentication (default to None). ' +
+ 'Also can set OSM_USER_DOMAIN_NAME in environment')
#@click.option('--so-port',
# default=None,
# envvar='OSM_SO_PORT',
# help='hostname of RO server. ' +
# 'Also can set OSM_RO_PORT in environment')
@click.pass_context
-def cli_osm(ctx, hostname, user, password, project, verbose, all_projects, public):
+def cli_osm(ctx, **kwargs):
global logger
+ hostname = kwargs.pop("hostname", None)
if hostname is None:
print((
"either hostname option or OSM_HOSTNAME " +
"environment variable needs to be specified"))
exit(1)
- kwargs = {'verbose': verbose}
+ # Remove None values
+ kwargs = {k: v for k, v in kwargs.items() if v is not None}
# if so_port is not None:
# kwargs['so_port']=so_port
# if so_project is not None:
# if ro_port is not None:
# kwargs['ro_port']=ro_port
sol005 = os.getenv('OSM_SOL005', True)
- if user is not None:
- kwargs['user']=user
- if password is not None:
- kwargs['password']=password
- if project is not None:
- kwargs['project']=project
- if all_projects:
- kwargs['all_projects']=all_projects
- if public is not None:
- kwargs['public']=public
+# if user is not None:
+# kwargs['user']=user
+# if password is not None:
+# kwargs['password']=password
+# if project is not None:
+# kwargs['project']=project
+# if all_projects:
+# kwargs['all_projects']=all_projects
+# if public is not None:
+# kwargs['public']=public
ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs)
logger = logging.getLogger('osmclient')
vim = vim_name
current_operation = "{} ({})".format(nsr['currentOperation'],nsr['currentOperationID'])
error_details = "N/A"
- if ns_state == "BROKEN" or ns_state == "DEGRADED":
- error_details = "{}\nDetail: {}".format(nsr['errorDescription'],nsr['errorDetail'])
+ if ns_state == "BROKEN" or ns_state == "DEGRADED" or nsr['errorDescription']:
+ error_details = "{}\nDetail: {}".format(nsr['errorDescription'], nsr['errorDetail'])
else:
nsopdata = ctx.obj.ns.get_opdata(ns['id'])
nsr = nsopdata['nsr:nsr']
action_name = op['operationParams']['primitive']
detail = "-"
if op['operationState']=='PROCESSING':
- if op['lcmOperationType']=='instantiate':
+ if op['lcmOperationType'] in ('instantiate', 'terminate'):
if op['stage']:
detail = op['stage']
else:
detail = "In queue. Current position: {}".format(op['queuePosition'])
- elif op['operationState']=='FAILED' or op['operationState']=='FAILED_TEMP':
- detail = op['errorMessage']
+ elif op['operationState'] in ('FAILED', 'FAILED_TEMP'):
+ detail = op.get('errorMessage','-')
date = datetime.fromtimestamp(op['startTime']).strftime("%Y-%m-%dT%H:%M:%S")
last_update = datetime.fromtimestamp(op['statusEnteredTime']).strftime("%Y-%m-%dT%H:%M:%S")
if long:
wrap_text(text=detail,width=50)])
else:
table.add_row([op['id'], op['lcmOperationType'], action_name,
- op['operationState'], date, wrap_text(text=detail,width=50)])
+ op['operationState'], date, wrap_text(text=detail or "",width=50)])
table.align = 'l'
print(table)
if "namespace" in op_status and "info" in op_status and \
"last_deployed" in op_status["info"] and "status" in op_status["info"] and \
"code" in op_status["info"]["status"] and "resources" in op_status["info"]["status"] and \
- "notes" in op_status["info"]["status"] and "seconds" in op_status["info"]["last_deployed"]:
+ "seconds" in op_status["info"]["last_deployed"]:
last_deployed_time = datetime.fromtimestamp(op_status["info"]["last_deployed"]["seconds"]).strftime("%a %b %d %I:%M:%S %Y")
print("LAST DEPLOYED: {}".format(last_deployed_time))
print("NAMESPACE: {}".format(op_status["namespace"]))
print()
print("RESOURCES:")
print(op_status["info"]["status"]["resources"])
- print("NOTES:")
- print(op_status["info"]["status"]["notes"])
+ if "notes" in op_status["info"]["status"]:
+ print("NOTES:")
+ print(op_status["info"]["status"]["notes"])
else:
print(op_info_status)
except Exception:
@cli_osm.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.option('--config', default=None,
+ help="specific yaml configuration for the termination, e.g. '{autoremove: False, timeout_ns_terminate: "
+ "600, skip_terminate_primitives: True}'")
@click.option('--wait',
required=False,
default=False,
help='do not return the control immediately, but keep it '
'until the operation is completed, or timeout')
@click.pass_context
-def ns_delete(ctx, name, force, wait):
+def ns_delete(ctx, name, force, config, wait):
"""deletes a NS instance
NAME: name or ID of the NS instance to be deleted
logger.debug("")
# try:
if not force:
- ctx.obj.ns.delete(name, wait=wait)
+ ctx.obj.ns.delete(name, config=config, wait=wait)
else:
check_client_version(ctx.obj, '--force')
- ctx.obj.ns.delete(name, force, wait=wait)
+ ctx.obj.ns.delete(name, force, config=config, wait=wait)
# except ClientException as e:
# print(str(e))
# exit(1)
@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_controller', default=None, help='Name or id of the SDN controller to be associated with this VIM'
+ 'account. Use empty string to disassociate')
@click.option('--sdn_port_mapping', default=None, help="File describing the port mapping between compute nodes' ports and switch ports")
@click.option('--wait',
required=False,
@click.option('--port', # hidden=True,
help='Deprecated. Use --url')
@click.option('--switch_dpid', # hidden=True,
- help='Deprecated. Use --config {dpid: DPID}')
+ help='Deprecated. Use --config {switch_id: DPID}')
@click.option('--config',
- help='Extra information for SDN in yaml format, as {dpid: (Openflow Datapath ID), version: version}')
+ help='Extra information for SDN in yaml format, as {switch_id: identity used for the plugin (e.g. DPID: '
+ 'Openflow Datapath ID), version: version}')
@click.option('--user',
help='SDN controller username')
@click.option('--password',
sdncontroller = {x: kwargs[x] for x in kwargs if kwargs[x] and
x not in ("wait", "ip_address", "port", "switch_dpid")}
if kwargs.get("port"):
- print("option '--port' is deprecated, use '-url' instead")
+ print("option '--port' is deprecated, use '--url' instead")
sdncontroller["port"] = int(kwargs["port"])
if kwargs.get("ip_address"):
- print("option '--ip_address' is deprecated, use '-url' instead")
+ print("option '--ip_address' is deprecated, use '--url' instead")
sdncontroller["ip"] = kwargs["ip_address"]
if kwargs.get("switch_dpid"):
- print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead")
+ print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead")
sdncontroller["dpid"] = kwargs["switch_dpid"]
if kwargs.get("sdn_controller_version"):
- print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
+ print("option '--sdn_controller_version' is deprecated, use '--config={version: SDN_CONTROLLER_VERSION}'"
" instead")
# try:
check_client_version(ctx.obj, ctx.command.name)
@click.option('--type', help='SDN controller type')
@click.option('--url', help='URL in format http[s]://HOST:IP/')
@click.option('--config', help='Extra information for SDN in yaml format, as '
- '{dpid: (Openflow Datapath ID), version: version}')
+ '{switch_id: identity used for the plugin (e.g. DPID: '
+ 'Openflow Datapath ID), version: version}')
@click.option('--user', help='SDN controller username')
@click.option('--password', help='SDN controller password')
@click.option('--ip_address', help='Deprecated. Use --url') # hidden=True
if kwargs.get("newname"):
sdncontroller["name"] = kwargs["newname"]
if kwargs.get("port"):
- print("option '--port' is deprecated, use '-url' instead")
+ print("option '--port' is deprecated, use '--url' instead")
sdncontroller["port"] = int(kwargs["port"])
if kwargs.get("ip_address"):
- print("option '--ip_address' is deprecated, use '-url' instead")
+ print("option '--ip_address' is deprecated, use '--url' instead")
sdncontroller["ip"] = kwargs["ip_address"]
if kwargs.get("switch_dpid"):
- print("option '--switch_dpid' is deprecated, use '---config={dpid: DPID}' instead")
+ print("option '--switch_dpid' is deprecated, use '--config={switch_id: id|DPID}' instead")
sdncontroller["dpid"] = kwargs["switch_dpid"]
if kwargs.get("sdn_controller_version"):
print("option '--sdn_controller_version' is deprecated, use '---config={version: SDN_CONTROLLER_VERSION}'"
#@click.option('--description',
# default='no description',
# help='human readable description')
+@click.option('--domain-name', 'domain_name',
+ default=None,
+ help='assign to a domain')
@click.pass_context
-def project_create(ctx, name):
+def project_create(ctx, name, domain_name):
"""Creates a new project
NAME: name of the project
+ DOMAIN_NAME: optional domain name for the project when keystone authentication is used
"""
logger.debug("")
project = {}
project['name'] = name
+ if domain_name:
+ project['domain_name'] = domain_name
# try:
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.project.create(name, project)
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')
+ 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):
+def user_create(ctx, username, password, projects, project_role_mappings, domain_name):
"""Creates a new user
\b
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['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)
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,...\'')
+ 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\'')
+ 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,...\'')
+ 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='removes project,role(s) mapping: \'project,role1,role2,...\'')
+ help="remove role(s) in a project. Can be used several times: 'project,role1[,role2,...]'")
@click.pass_context
def user_update(ctx, username, password, set_username, set_project, remove_project,
add_project_role, remove_project_role):