README.md

   1 # python-osmclient
   2 A python client for osm orchestration
   3
   4 # Installation
   5
   6 ## Install dependencies
   7 ```bash
   8 sudo apt-get install python-dev libcurl4-gnutls-dev python-pip libgnutls-dev python-prettytable
   9 sudo pip install pycurl
  10 ```
  11
  12 ## Install python-osmclient
  13     sudo pip install git+https://github.com/mfmarche/python-osmclient
  14
  15 # Setup
  16 Set the OSM_HOSTNAME variable to the host of the osm server.
  17
  18 Example
  19 ```bash
  20 localhost$ export OSM_HOSTNAME=<hostname>:8008
  21 ```
  22
  23 # Examples
  24
  25 ## upload vnfd
  26 ```bash
  27 localhost$ osm upload-package ubuntu_xenial_vnf.tar.gz
  28 {'transaction_id': 'ec12af77-1b91-4c84-b233-60f2c2c16d14'}
  29 localhost$ osm vnfd-list
  30 +--------------------+--------------------+
  31 | vnfd name          | id                 |
  32 +--------------------+--------------------+
  33 | ubuntu_xenial_vnfd | ubuntu_xenial_vnfd |
  34 +--------------------+--------------------+
  35 ```
  36
  37 ## upload nsd
  38 ```bash
  39 localhost$ osm upload-package ubuntu_xenial_ns.tar.gz
  40 {'transaction_id': 'b560c9cb-43e1-49ef-a2da-af7aab24ce9d'}
  41 localhost$ osm nsd-list
  42 +-------------------+-------------------+
  43 | nsd name          | id                |
  44 +-------------------+-------------------+
  45 | ubuntu_xenial_nsd | ubuntu_xenial_nsd |
  46 +-------------------+-------------------+
  47 ```
  48 ## vim-list
  49
  50 ```bash
  51 localhost$ osm vim-list
  52 +-------------+-----------------+--------------------------------------+
  53 | ro-account  | datacenter name | uuid                                 |
  54 +-------------+-----------------+--------------------------------------+
  55 | osmopenmano | openstack-site  | 2ea04690-0e4a-11e7-89bc-00163e59ff0c |
  56 +-------------+-----------------+--------------------------------------+
  57 ```
  58
  59
  60 ## instantiate ns
  61 ```bash
  62 localhost$ osm ns-create ubuntu_xenial_nsd testns openstack-site
  63 {'success': ''}
  64 localhost$ osm ns-list
  65 +------------------+--------------------------------------+-------------------+--------------------+---------------+
  66 | ns instance name | id                                   | catalog name      | operational status | config status |
  67 +------------------+--------------------------------------+-------------------+--------------------+---------------+
  68 | testns           | 6b0d2906-13d4-11e7-aa01-b8ac6f7d0c77 | ubuntu_xenial_nsd | running            | configured    |
  69 +------------------+--------------------------------------+-------------------+--------------------+---------------+
  70 ```
  71
  72 # Bash Completion
  73 python-osmclient uses [click](http://click.pocoo.org/5/).  You can setup bash completion by putting this in your .bashrc:
  74
  75     eval "$(_OSM_COMPLETE=source osm)"
  76