python-neutronclient documentation

This is a client for OpenStack Networking API. It provides Python API bindings (the neutronclient module) and command-line interface (CLI).

There are two CLIs which support the Networking API: neutron CLI and OpenStack Client (OSC). OpenStack Client provides the basic network commands and python-neutronclient provides extensions (aka OSC plugins) for advanced networking services.

User Documentation

• Using CLI
  • OpenStackClient
  • neutron CLI
• neutronclient Python API
  • Basic Usage

Contributor Guide

In the Contributor Guide, you will find information on neutronclient’s lower level programming details or APIs as well as the transition to OpenStack client.

• Contributor Guide
  • Client command extension support
  • CLI Option Guideline
  • Transition to OpenStack Client

Note

neutron CLI has been deprecated from Ocata release. We do not add, change and drop any existing commands any more. We only accept changes on OSC plugin, neutronclient python bindings and bug fixes on the deprecated CLI (neutron command).

History

Release notes is available at http://docs.openstack.org/releasenotes/python-neutronclient/.