Skip to main content

The Open Baton CLI

Project description

Python version of the Open Baton CLI

This project contains a vnfm sdk for python projects.

Technical Requirements

This section covers the requirements that must be met by the python-vnfm-sdk in order to satisfy the demands for such a component:

  • python 2.7

How to install the Open Baton CLI

The easier way to start is to use a virtual environment. Once activated, just run

pip install openbaton-cli

How to use the Open Baton CLI

After installing the CLI you have a new command:

./openbaton -h                                                                                                                                                                                                                                                                                                                                                  2 ↵
usage: openbaton [-h] [-pid PROJECT_ID] [-u USERNAME] [-p PASSWORD]
                 [-ip NFVO_IP] [--nfvo-port NFVO_PORT]
                 agent action [params [params ...]]

positional arguments:
  agent                 the agent you want to use. Possibilities are: ['nsd',
                        'vim', 'project', 'user', 'vnfpackage', 'nsr']
  action                the action you want to call. Possibilities are:
                        ['list', 'show', 'delete', 'create']
  params                The id, file or json

optional arguments:
  -h, --help            show this help message and exit
  -pid PROJECT_ID, --project-id PROJECT_ID
                        the project-id to use
  -u USERNAME, --username USERNAME
                        the openbaton username
  -p PASSWORD, --password PASSWORD
                        the openbaton password
  -ip NFVO_IP, --nfvo-ip NFVO_IP
                        the openbaton nfvo ip
  --nfvo-port NFVO_PORT
                        the openbaton nfvo port

Where the agents are:

Agent description
nsd Agent requesting Network Service Descriptor
nsr Agent requesting Network Service Records
projects Agent requesting Projects
vim Agent requesting Point of Presence
user Agent requesting Users
vnfpackages Agent requesting VNFPAckages

And actions are:

action description
list Request the list of agent’s objects
show Show specific information of an object
create create the passed object
update update the passed object

Issue tracker

Issues and bug reports should be posted to the GitHub Issue Tracker of this project

What is Open Baton?

OpenBaton is an open source project providing a comprehensive implementation of the ETSI Management and Orchestration (MANO) specification.

Open Baton is a ETSI NFV MANO compliant framework. Open Baton was part of the OpenSDNCore ( project started almost three years ago by Fraunhofer FOKUS with the objective of providing a compliant implementation of the ETSI NFV specification.

Open Baton is easily extensible. It integrates with OpenStack, and provides a plugin mechanism for supporting additional VIM types. It supports Network Service management either using a generic VNFM or interoperating with VNF-specific VNFM. It uses different mechanisms (REST or PUB/SUB) for interoperating with the VNFMs. It integrates with additional components for the runtime management of a Network Service. For instance, it provides autoscaling and fault management based on monitoring information coming from the the monitoring system available at the NFVI level.

Source Code and documentation

The Source Code of the other Open Baton projects can be found here and the documentation can be found here .

News and Website

Check the Open Baton Website Follow us on Twitter @openbaton.

Licensing and distribution

Copyright [2015-2016] Open Baton project

Licensed under the Apache License, Version 2.0 (the “License”);

you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2015-2016 Open Baton. Licensed under Apache v2 License.


The Open Baton project provides community support through the Open Baton Public Mailing List and through StackOverflow using the tags openbaton.

Supported by

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openbaton-cli-1.0.2b0.tar.gz (20.0 kB view hashes)

Uploaded source

Built Distribution

openbaton_cli-1.0.2b0-py2.py3-none-any.whl (14.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page