Skip to main content

Python wrapper around Bluecat APIs

Project description

# Bluecat BAM API Wrapper #

## Installation ##

Supported on python 2.7, no promises on 3.x

You can clone the repo, change to the top-level directory (with the setup.py file) and use pip to install the local files in "editable" mode (-e).

```bash
git clone https://github.com/ForrestT/pyBluecat.git
cd pybluecat
pip install --user .
```
- - - -
## How to Use ##

The library can be used within python

```python
import pybluecat

bam = pybluecat.BAM(hostname, username, password)

network_obj = bam.get_network('10.97.12.0')

ip_obj = bam.get_ip_address('10.97.12.101')

bam.logout()
```
In an interactive python interpreter, use help() to play with the available methods
```python
>>> from pybluecat import BAM
>>> help(BAM)
```

You can also just use the CLI scripts interactively (use -h, --help)

```bash
bluecat --help

usage: Bluecat CLI Tool [-h] {static,dhcp,search} ...

optional arguments:
-h, --help show this help message and exit

Subcommands:
{static,dhcp,search} subparsers command help
static static IP record manipulation
dhcp dhcp IP record manipulation
search search BAM for Objects

# Create a DHCP reservation
bluecat dhcp create <hostname> <mac> --network <networkAddress> --creds /location/of/creds.json

# Delete a STATIC IP reservation
bluecat static delete <ipAddress>
```



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

pybluecat-0.1.1.tar.gz (23.3 kB view hashes)

Uploaded source

Built Distribution

pybluecat-0.1.1-py2.py3-none-any.whl (38.7 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