osmclient/scripts/osm.py

   1 # Copyright 2017 Sandvine
   2 #
   3 # All Rights Reserved.
   4 #
   5 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   6 #    not use this file except in compliance with the License. You may obtain
   7 #    a copy of the License at
   8 #
   9 #         http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #    Unless required by applicable law or agreed to in writing, software
  12 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14 #    License for the specific language governing permissions and limitations
  15 #    under the License.
  16 """
  17 OSM shell/cli
  18 """
  19
  20 import click
  21 from osmclient.client import client
  22 from osmclient.common.exceptions import ClientException
  23 from prettytable import PrettyTable
  24 import json
  25
  26
  27 @click.group()
  28 @click.option('--hostname',default=None,envvar='OSM_HOSTNAME',help='hostname of server.  Also can set OSM_HOSTNAME in environment')
  29 @click.pass_context
  30 def cli(ctx,hostname):
  31     if hostname is None:
  32         print("either hostname option or OSM_HOSTNAME environment variable needs to be specified")
  33         exit(1)
  34     ctx.obj=client.Client(host=hostname)
  35
  36 @cli.command(name='ns-list')
  37 @click.pass_context
  38 def ns_list(ctx):
  39     resp=ctx.obj.ns.list()
  40     table=PrettyTable(['ns instance name','id','operational status','config status'])
  41     for ns in resp:
  42         nsopdata=ctx.obj.ns.get_opdata(ns['id'])
  43         nsr=nsopdata['nsr:nsr']
  44         table.add_row([nsr['name-ref'],nsr['ns-instance-config-ref'],nsr['operational-status'],nsr['config-status']])
  45     table.align='l'
  46     print(table)
  47
  48 @cli.command(name='nsd-list')
  49 @click.pass_context
  50 def nsd_list(ctx):
  51     resp=ctx.obj.nsd.list()
  52     table=PrettyTable(['nsd name','id'])
  53     for ns in resp:
  54         table.add_row([ns['name'],ns['id']])
  55     table.align='l'
  56     print(table)
  57
  58 @cli.command(name='vnfd-list')
  59 @click.pass_context
  60 def vnfd_list(ctx):
  61     resp = ctx.obj.vnfd.list()
  62     table=PrettyTable(['vnfd name','id'])
  63     for vnfd in resp:
  64         table.add_row([vnfd['name'],vnfd['id']])
  65     table.align='l'
  66     print(table)
  67
  68 @cli.command(name='vnf-list')
  69 @click.pass_context
  70 def vnf_list(ctx):
  71     resp=ctx.obj.vnf.list()
  72     table=PrettyTable(['vnf name','id','operational status','config status'])
  73     for vnfr in resp:
  74         if not 'mgmt-interface' in vnfr:
  75             vnfr['mgmt-interface'] = {}
  76             vnfr['mgmt-interface']['ip-address'] = None
  77         table.add_row([vnfr['name'],vnfr['id'],vnfr['operational-status'],vnfr['config-status']])
  78     table.align='l'
  79     print(table)
  80
  81 @cli.command(name='vnf-show')
  82 @click.argument('vnf_name')
  83 @click.option('--filter',default=None)
  84 @click.pass_context
  85 def vnf_show(ctx,vnf_name,filter):
  86     try:
  87         resp=ctx.obj.vnf.get(vnf_name)
  88     except ClientException as inst:
  89         print(inst.message)
  90         exit(1)
  91
  92     table=PrettyTable(['field','value'])
  93     for k,v in resp.items():
  94         if filter is None or filter in k:
  95             table.add_row([k,json.dumps(v,indent=2)])
  96     table.align='l'
  97     print(table)
  98
  99 @cli.command(name='vnf-monitoring-show')
 100 @click.argument('vnf_name')
 101 @click.pass_context
 102 def vnf_monitoring_show(ctx,vnf_name):
 103     try:
 104         resp=ctx.obj.vnf.get_monitoring(vnf_name)
 105     except ClientException as inst:
 106         print(inst.message)
 107         exit(1)
 108
 109     table=PrettyTable(['vnf name','monitoring name','value','units'])
 110     if resp is not None:
 111         for monitor in resp:
 112             table.add_row([vnf_name,monitor['name'],monitor['value-integer'],monitor['units']])
 113     table.align='l'
 114     print(table)
 115
 116 @cli.command(name='ns-monitoring-show')
 117 @click.argument('ns_name')
 118 @click.pass_context
 119 def ns_monitoring_show(ctx,ns_name):
 120     try:
 121         resp=ctx.obj.ns.get_monitoring(ns_name)
 122     except ClientException as inst:
 123         print(inst.message)
 124         exit(1)
 125
 126     table=PrettyTable(['vnf name','monitoring name','value','units'])
 127     for key,val in resp.items():
 128         for monitor in val:
 129             table.add_row([key,monitor['name'],monitor['value-integer'],monitor['units']])
 130     table.align='l'
 131     print(table)
 132
 133 @cli.command(name='ns-create')
 134 @click.option('--ns_name',prompt=True)
 135 @click.option('--nsd_name',prompt=True)
 136 @click.option('--vim_account',prompt=True)
 137 @click.option('--admin_status',default='ENABLED',help='administration status')
 138 @click.option('--ssh_keys',default=None,help='comma separated list of keys to inject to vnfs')
 139 @click.option('--vim_network_prefix',default=None,help='vim network name prefix')
 140 @click.pass_context
 141 def ns_create(ctx,nsd_name,ns_name,vim_account,admin_status,ssh_keys,vim_network_prefix):
 142     try:
 143         ctx.obj.ns.create(nsd_name,ns_name,vim_network_prefix=vim_network_prefix,ssh_keys=ssh_keys,account=vim_account)
 144     except ClientException as inst:
 145         print(inst.message)
 146         exit(1)
 147
 148 @cli.command(name='ns-delete')
 149 @click.argument('ns_name')
 150 @click.pass_context
 151 def ns_delete(ctx,ns_name):
 152     try:
 153         ctx.obj.ns.delete(ns_name)
 154     except ClientException as inst:
 155         print(inst.message)
 156         exit(1)
 157
 158 @cli.command(name='upload-package')
 159 @click.argument('filename')
 160 @click.pass_context
 161 def upload_package(ctx,filename):
 162     try:
 163         ctx.obj.package.upload(filename)
 164         ctx.obj.package.wait_for_upload(filename)
 165     except ClientException as inst:
 166         print(inst.message)
 167         exit(1)
 168
 169 @cli.command(name='ns-show')
 170 @click.argument('ns_name')
 171 @click.option('--filter',default=None)
 172 @click.pass_context
 173 def ns_show(ctx,ns_name,filter):
 174     try:
 175         ns = ctx.obj.ns.get(ns_name)
 176     except ClientException as inst:
 177         print(inst.message)
 178         exit(1)
 179
 180     table=PrettyTable(['field','value'])
 181
 182     for k,v in ns.items():
 183         if filter is None or filter in k:
 184             table.add_row([k,json.dumps(v,indent=2)])
 185
 186     nsopdata=ctx.obj.ns.get_opdata(ns['id'])
 187     nsr_optdata=nsopdata['nsr:nsr']
 188     for k,v in nsr_optdata.items():
 189         if filter is None or filter in k:
 190             table.add_row([k,json.dumps(v,indent=2)])
 191     table.align='l'
 192     print(table)
 193
 194 @cli.command(name='ns-scaling-show')
 195 @click.argument('ns_name')
 196 @click.pass_context
 197 def show_ns_scaling(ctx,ns_name):
 198     resp = ctx.obj.ns.list()
 199
 200     table=PrettyTable(['instance-id','operational status','create-time','vnfr ids'])
 201
 202     if 'nsr' in resp:
 203         for ns in resp['nsr']:
 204             if ns_name == ns['name']:
 205                 nsopdata=ctx.obj.ns.get_opdata(ns['id'])
 206                 scaling_records=nsopdata['nsr:nsr']['scaling-group-record']
 207                 for record in scaling_records:
 208                     if 'instance' in record:
 209                         instances=record['instance']
 210                         for inst in instances:
 211                             table.add_row([inst['instance-id'],inst['op-status'],time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(inst['create-time'])),inst['vnfrs']])
 212     table.align='l'
 213     print(table)
 214
 215 @cli.command(name='nsd-delete')
 216 @click.argument('nsd_name')
 217 @click.pass_context
 218 def nsd_delete(ctx,nsd_name):
 219     try:
 220         ctx.obj.nsd.delete(nsd_name)
 221     except ClientException as inst:
 222         print(inst.message)
 223         exit(1)
 224
 225 @cli.command(name='vnfd-delete')
 226 @click.argument('vnfd_name')
 227 @click.pass_context
 228 def vnfd_delete(ctx,vnfd_name):
 229     try:
 230         ctx.obj.vnfd.delete(vnfd_name)
 231     except ClientException as inst:
 232         print(inst.message)
 233         exit(1)
 234
 235 @cli.command(name='config-agent-list')
 236 @click.pass_context
 237 def config_agent_list(ctx):
 238     table=PrettyTable(['name','account-type','details'])
 239     for account in ctx.obj.vca.list():
 240       table.add_row([account['name'],account['account-type'],account['juju']])
 241     table.align='l'
 242     print(table)
 243
 244 @cli.command(name='config-agent-delete')
 245 @click.argument('name')
 246 @click.pass_context
 247 def config_agent_delete(ctx,name):
 248     try:
 249         ctx.obj.vca.delete(name)
 250     except ClientException as inst:
 251         print(inst.message)
 252         exit(1)
 253
 254 @cli.command(name='config-agent-add')
 255 @click.option('--name',prompt=True)
 256 @click.option('--account_type',prompt=True)
 257 @click.option('--server',prompt=True)
 258 @click.option('--user',prompt=True)
 259 @click.option('--secret',prompt=True,hide_input=True,confirmation_prompt=True)
 260 @click.pass_context
 261 def config_agent_add(ctx,name,account_type,server,user,secret):
 262     try:
 263         ctx.obj.vca.create(name,account_type,server,user,secret)
 264     except ClientException as inst:
 265         print(inst.message)
 266         exit(1)
 267
 268 @cli.command(name='vim-create')
 269 @click.option('--name',prompt=True)
 270 @click.option('--user',prompt=True)
 271 @click.option('--password',prompt=True,hide_input=True,confirmation_prompt=True)
 272 @click.option('--auth_url',prompt=True)
 273 @click.option('--tenant',prompt=True)
 274 @click.option('--floating_ip_pool',default=None)
 275 @click.option('--keypair',default=None)
 276 @click.option('--account_type',default='openstack')
 277 @click.option('--description',default='no description')
 278 @click.pass_context
 279 def vim_create(ctx,name,user,password,auth_url,tenant,floating_ip_pool,keypair,account_type,description):
 280     vim={}
 281     vim['os-username']=user
 282     vim['os-password']=password
 283     vim['os-url']=auth_url
 284     vim['os-project-name']=tenant
 285     vim['floating_ip_pool']=floating_ip_pool
 286     vim['keypair']=keypair
 287     vim['vim-type']='openstack'
 288     vim['description']=description
 289     try:
 290         ctx.obj.vim.create(name,vim)
 291     except ClientException as inst:
 292         print(inst.message)
 293         exit(1)
 294
 295 @cli.command(name='vim-delete')
 296 @click.argument('name')
 297 @click.pass_context
 298 def vim_delete(ctx,name):
 299     try:
 300         ctx.obj.vim.delete(name)
 301     except ClientException as inst:
 302         print(inst.message)
 303         exit(1)
 304
 305 @cli.command(name='vim-list')
 306 @click.pass_context
 307 def vim_list(ctx):
 308     resp=ctx.obj.vim.list()
 309     table=PrettyTable(['vim name','uuid'])
 310     for vim in resp:
 311         table.add_row([vim['name'],vim['uuid']])
 312     table.align='l'
 313     print(table)
 314
 315 @cli.command(name='vim-show')
 316 @click.argument('name')
 317 @click.pass_context
 318 def vim_show(ctx,name):
 319     try:
 320         resp=ctx.obj.vim.get(name)
 321     except ClientException as inst:
 322         print(inst.message)
 323         exit(1)
 324
 325     table=PrettyTable(['key','attribute'])
 326     for k,v in resp.items():
 327         table.add_row([k,json.dumps(v,indent=2)])
 328     table.align='l'
 329     print(table)
 330
 331 @cli.command(name='ro-dump')
 332 @click.pass_context
 333 def ro_dump(ctx):
 334     resp=ctx.obj.vim.get_resource_orchestrator()
 335     table=PrettyTable(['key','attribute'])
 336     for k,v in resp.items():
 337         table.add_row([k,json.dumps(v,indent=2)])
 338     table.align='l'
 339     print(table)
 340
 341 @cli.command(name='vcs-list')
 342 @click.pass_context
 343 def vcs_list(ctx):
 344     resp=ctx.obj.utils.get_vcs_info()
 345     table=PrettyTable(['component name','state'])
 346     for component in resp:
 347         table.add_row([component['component_name'],component['state']])
 348     table.align='l'
 349     print(table)
 350
 351 if __name__ == '__main__':
 352     cli()