import yaml
import json
import time
+import pycurl
def check_client_version(obj, what, version='sol005'):
'''
@click.group()
@click.option('--hostname',
- default=None,
+ default="127.0.0.1",
envvar='OSM_HOSTNAME',
help='hostname of server. ' +
'Also can set OSM_HOSTNAME in environment')
envvar='OSM_RO_PORT',
help='hostname of RO server. ' +
'Also can set OSM_RO_PORT in environment')
-@click.option('--sol005',
- is_flag=True,
+@click.option('--sol005/--no-sol005',
+ default=True,
envvar='OSM_SOL005',
- help='Use ETSI NFV SOL005 API')
+ help='Use ETSI NFV SOL005 API (default) or the previous SO API')
@click.pass_context
def cli(ctx, hostname, so_port, so_project, ro_hostname, ro_port, sol005):
if hostname is None:
- print(
+ print((
"either hostname option or OSM_HOSTNAME " +
- "environment variable needs to be specified")
+ "environment variable needs to be specified"))
exit(1)
kwargs={}
if so_port is not None:
kwargs['ro_host']=ro_hostname
if ro_port is not None:
kwargs['ro_port']=ro_port
-
+
ctx.obj = client.Client(host=hostname, sol005=sol005, **kwargs)
@cli.command(name='ns-list')
@click.option('--filter', default=None,
- help='restricts the list to the NS instances matching the filter')
+ help='restricts the list to the NS instances matching the filter.')
@click.pass_context
def ns_list(ctx, filter):
- '''list all NS instances'''
+ '''list all NS instances
+
+ \b
+ Options:
+ --filter filterExpr Restricts the list to the NS instances matching the filter
+
+ \b
+ filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
+ concatenated using the "&" character:
+
+ \b
+ filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
+ simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
+ op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
+ attrName := string
+ value := scalar value
+
+ \b
+ where:
+ * zero or more occurrences
+ ? zero or one occurrence
+ [] grouping of expressions to be used with ? and *
+ "" quotation marks for marking string constants
+ <> name separator
+
+ \b
+ "AttrName" is the name of one attribute in the data type that defines the representation
+ of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
+ <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
+ "Op" stands for the comparison operator. If the expression has concatenated <attrName>
+ entries, it means that the operator "op" is applied to the attribute addressed by the last
+ <attrName> entry included in the concatenation. All simple filter expressions are combined
+ by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
+ the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
+ concatenation of all "attrName" entries except the leaf attribute is called the "attribute
+ prefix". If an attribute referenced in an expression is an array, an object that contains a
+ corresponding array shall be considered to match the expression if any of the elements in the
+ array matches all expressions that have the same attribute prefix.
+
+ \b
+ Filter examples:
+ --filter admin-status=ENABLED
+ --filter nsd-ref=<NSD_NAME>
+ --filter nsd.vendor=<VENDOR>
+ --filter nsd.vendor=<VENDOR>&nsd-ref=<NSD_NAME>
+ --filter nsd.constituent-vnfd.vnfd-id-ref=<VNFD_NAME>
+ '''
if filter:
check_client_version(ctx.obj, '--filter')
resp = ctx.obj.ns.list(filter)
@cli.command(name='vnf-list')
@click.option('--ns', default=None, help='NS instance id or name to restrict the VNF list')
+@click.option('--filter', default=None,
+ help='restricts the list to the VNF instances matching the filter.')
@click.pass_context
-def vnf_list(ctx, ns):
- ''' list all VNF instances'''
+def vnf_list(ctx, ns, filter):
+ '''list all VNF instances
+
+ \b
+ Options:
+ --ns TEXT NS instance id or name to restrict the VNF list
+ --filter filterExpr Restricts the list to the VNF instances matching the filter
+
+ \b
+ filterExpr consists of one or more strings formatted according to "simpleFilterExpr",
+ concatenated using the "&" character:
+
+ \b
+ filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
+ simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
+ op := "eq" | "neq" | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
+ attrName := string
+ value := scalar value
+
+ \b
+ where:
+ * zero or more occurrences
+ ? zero or one occurrence
+ [] grouping of expressions to be used with ? and *
+ "" quotation marks for marking string constants
+ <> name separator
+
+ \b
+ "AttrName" is the name of one attribute in the data type that defines the representation
+ of the resource. The dot (".") character in "simpleFilterExpr" allows concatenation of
+ <attrName> entries to filter by attributes deeper in the hierarchy of a structured document.
+ "Op" stands for the comparison operator. If the expression has concatenated <attrName>
+ entries, it means that the operator "op" is applied to the attribute addressed by the last
+ <attrName> entry included in the concatenation. All simple filter expressions are combined
+ by the "AND" logical operator. In a concatenation of <attrName> entries in a <simpleFilterExpr>,
+ the rightmost "attrName" entry in a "simpleFilterExpr" is called "leaf attribute". The
+ concatenation of all "attrName" entries except the leaf attribute is called the "attribute
+ prefix". If an attribute referenced in an expression is an array, an object that contains a
+ corresponding array shall be considered to match the expression if any of the elements in the
+ array matches all expressions that have the same attribute prefix.
+
+ \b
+ Filter examples:
+ --filter vim-account-id=<VIM_ACCOUNT_ID>
+ --filter vnfd-ref=<VNFD_NAME>
+ --filter vdur.ip-address=<IP_ADDRESS>
+ --filter vnfd-ref=<VNFD_NAME>,vdur.ip-address=<IP_ADDRESS>
+ '''
try:
- if ns:
- check_client_version(ctx.obj, '--ns')
- resp = ctx.obj.vnf.list(ns)
+ if ns or filter:
+ if ns:
+ check_client_version(ctx.obj, '--ns')
+ if filter:
+ check_client_version(ctx.obj, '--filter')
+ resp = ctx.obj.vnf.list(ns, filter)
else:
resp = ctx.obj.vnf.list()
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
fullclassname = ctx.obj.__module__ + "." + ctx.obj.__class__.__name__
if fullclassname == 'osmclient.sol005.client.Client':
'ns id',
'vnf member index',
'vnfd name',
+ 'vim account id',
'ip address'])
for vnfr in resp:
name = vnfr['name'] if 'name' in vnfr else '-'
vnfr['nsr-id-ref'],
vnfr['member-vnf-index-ref'],
vnfr['vnfd-ref'],
+ vnfr['vim-account-id'],
vnfr['ip-address']])
else:
table = PrettyTable(
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.ns.list_op(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['id', 'operation', 'status'])
resp = ctx.obj.nsd.get(name)
#resp = ctx.obj.nsd.get_individual(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if literal:
- print yaml.safe_dump(resp)
+ print(yaml.safe_dump(resp))
return
table = PrettyTable(['field', 'value'])
- for k, v in resp.items():
+ for k, v in list(resp.items()):
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
print(table)
resp = ctx.obj.vnfd.get(name)
#resp = ctx.obj.vnfd.get_individual(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if literal:
- print yaml.safe_dump(resp)
+ print(yaml.safe_dump(resp))
return
table = PrettyTable(['field', 'value'])
- for k, v in resp.items():
+ for k, v in list(resp.items()):
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
print(table)
try:
ns = ctx.obj.ns.get(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if literal:
- print yaml.safe_dump(resp)
+ print(yaml.safe_dump(ns))
return
table = PrettyTable(['field', 'value'])
- for k, v in ns.items():
+ for k, v in list(ns.items()):
if filter is None or filter in k:
table.add_row([k, json.dumps(v, indent=2)])
if fullclassname != 'osmclient.sol005.client.Client':
nsopdata = ctx.obj.ns.get_opdata(ns['id'])
nsr_optdata = nsopdata['nsr:nsr']
- for k, v in nsr_optdata.items():
+ for k, v in list(nsr_optdata.items()):
if filter is None or filter in k:
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.vnf.get(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if literal:
- print yaml.safe_dump(resp)
+ print(yaml.safe_dump(resp))
return
table = PrettyTable(['field', 'value'])
- for k, v in resp.items():
+ for k, v in list(resp.items()):
if filter is None or filter in k:
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
check_client_version(ctx.obj, ctx.command.name, 'v1')
resp = ctx.obj.vnf.get_monitoring(vnf_name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
check_client_version(ctx.obj, ctx.command.name, 'v1')
resp = ctx.obj.ns.get_monitoring(ns_name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['vnf name', 'monitoring name', 'value', 'units'])
- for key, val in resp.items():
+ for key, val in list(resp.items()):
for monitor in val:
table.add_row(
[key,
check_client_version(ctx.obj, ctx.command.name)
op_info = ctx.obj.ns.get_op(id)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['field', 'value'])
- for k, v in op_info.items():
+ for k, v in list(op_info.items()):
if filter is None or filter in k:
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nsd.create(filename, overwrite)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.vnfd.create(filename, overwrite)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
help='administration status')
@click.option('--ssh_keys',
default=None,
- help='comma separated list of keys to inject to vnfs')
+ help='comma separated list of public key files to inject to vnfs')
@click.option('--config',
default=None,
- help='ns specific yaml configuration:\nvnf: [member-vnf-index: TEXT, vim_account: TEXT]\n'
- 'vld: [name: TEXT, vim-network-name: TEXT or DICT with vim_account, vim_net entries]')
+ help='ns specific yaml configuration')
+@click.option('--config_file',
+ default=None,
+ help='ns specific yaml configuration file')
@click.pass_context
def ns_create(ctx,
nsd_name,
vim_account,
admin_status,
ssh_keys,
- config):
+ config,
+ config_file):
'''creates a new NS instance'''
try:
- # if config:
- # check_client_version(ctx.obj, '--config', 'v1')
+ if config_file:
+ check_client_version(ctx.obj, '--config_file')
+ if config:
+ raise ClientException('"--config" option is incompatible with "--config_file" option')
+ with open(config_file, 'r') as cf:
+ config=cf.read()
ctx.obj.ns.create(
nsd_name,
ns_name,
ssh_keys=ssh_keys,
account=vim_account)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.nsd.update(name, content)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
@cli.command(name='nsd-update', short_help='updates a NSD/NSpkg')
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.vnfd.update(name, content)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, '--force')
ctx.obj.nsd.delete(name, force)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, '--force')
ctx.obj.vnfd.delete(name, force)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, '--force')
ctx.obj.ns.delete(name, force)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
####################
# VIM operations
####################
-
+
@cli.command(name='vim-create')
@click.option('--name',
prompt=True,
vim['vim-tenant-name'] = tenant
vim['vim-type'] = account_type
vim['description'] = description
- vim ['config'] = config
+ 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)
+ print((inst.message))
exit(1)
if config: vim['config'] = config
ctx.obj.vim.update(name, vim, sdn_controller, sdn_port_mapping)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, '--force')
ctx.obj.vim.delete(name, force)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if 'vim_password' in resp:
resp['vim_password']='********'
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['key', 'attribute'])
- for k, v in resp.items():
+ for k, v in list(resp.items()):
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
print(table)
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.sdnc.create(name, sdncontroller)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
@cli.command(name='sdnc-update', short_help='updates an SDN controller')
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.sdnc.update(name, sdncontroller)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.sdnc.delete(name, force)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.sdnc.list(filter)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['name', 'id'])
for sdnc in resp:
check_client_version(ctx.obj, ctx.command.name)
resp = ctx.obj.sdnc.get(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['key', 'attribute'])
- for k, v in resp.items():
+ for k, v in list(resp.items()):
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
print(table)
check_client_version(ctx.obj, ctx.command.name)
ctx.obj.ns.create_alarm(alarm)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name)
if not interval:
- print '{}'.format(ctx.obj.ns.export_metric(metric_data))
+ print('{}'.format(ctx.obj.ns.export_metric(metric_data)))
else:
i = 1
while True:
- print '{} {}'.format(ctx.obj.ns.export_metric(metric_data),i)
+ print('{} {}'.format(ctx.obj.ns.export_metric(metric_data),i))
time.sleep(int(interval))
i+=1
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if fullclassname != 'osmclient.sol005.client.Client':
ctx.obj.package.wait_for_upload(filename)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
check_client_version(ctx.obj, ctx.command.name, 'v1')
resp = ctx.obj.ns.list()
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(
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)
+ print((inst.message))
exit(1)
try:
check_client_version(ctx.obj, ctx.command.name, 'v1')
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
table = PrettyTable(['name', 'account-type', 'details'])
for account in ctx.obj.vca.list():
check_client_version(ctx.obj, ctx.command.name, 'v1')
ctx.obj.vca.delete(name)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
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)
+ print((inst.message))
exit(1)
@cli.command(name='ro-dump')
check_client_version(ctx.obj, ctx.command.name, 'v1')
resp = ctx.obj.vim.get_resource_orchestrator()
table = PrettyTable(['key', 'attribute'])
- for k, v in resp.items():
+ for k, v in list(resp.items()):
table.add_row([k, json.dumps(v, indent=2)])
table.align = 'l'
print(table)
ctx.obj.ns.exec_op(ns_name, op_name='action', op_data=op_data)
except ClientException as inst:
- print(inst.message)
+ print((inst.message))
exit(1)
if __name__ == '__main__':
- cli()
+ try:
+ cli()
+ except pycurl.error as e:
+ print(e)
+ print('Maybe "--hostname" option or OSM_HOSTNAME' +
+ 'environment variable needs to be specified')
+ exit(1)
+
projects / osm / osmclient.git / blobdiff