Skip to content

Latest commit

 

History

History
80 lines (47 loc) · 2.75 KB

README.md

File metadata and controls

80 lines (47 loc) · 2.75 KB

acitoolkit Documentation Status Build Status

Join the chat at https://gitter.im/datacenter/acitoolkit

Description

The ACI Toolkit is a set of python libraries that allow basic configuration of the Cisco APIC controller. It is intended to allow users to quickly begin using the REST API and accelerate the learning curve necessary to begin using the APIC.

The full documentation is published at the following link: http://datacenter.github.io/acitoolkit/

Installation

Environment

Required

Downloading

Option A:

If you have git installed, clone the repository

git clone https://github.com/datacenter/acitoolkit.git

Option B:

If you don't have git, download a zip copy of the repository and extract.

Option C:

The latest build of this project is also available as a Docker image from Docker Hub

docker pull dockercisco/acitoolkit 

Installing

After downloading, install using setuptools.

cd acitoolkit
python setup.py install

If you plan on modifying the actual toolkit files, you should install the developer environment that will link the package installation to your development directory.

cd acitoolkit
python setup.py develop

Usage

A tutorial and overview of the acitoolkit object model can be found in the Documentation section found at http://datacenter.github.io/acitoolkit/

Using Docker Image

docker run -it --name acitoolkit dockercisco/acitoolkit

License

Copyright 2015 Cisco Systems, Inc.

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

http://www.apache.org/licenses/LICENSE-2.0

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.