BlueCatPoSh - BlueCat IPAM PowerShell Library

Leveraging the BlueCat IPAM API has generally been complex in our environment so I have been experimenting with a library to standardize and simplify access. BlueCatPoSh is the 3rd generation of my local library implementation for PowerShell and I'm working to clean it up and make it useful to a larger audience.

BlueCatPoSh attempts to move beyond a simple one-for-one implementation of the IPAM API and incorporate sanity and prerequisite testing at the most basic level. There are a few more robust functions to simplify or expand the data collection/update process as well.

This library is still very much an imperfect work in progress, but I am still actively working on it. At this time it is DNS focused as that is what I work on with BlueCat the most.

Supported Environments

BlueCatPoSh has been tested with PowerShell v5.1 on Windows.

The library is known to work with BlueCat v9.4 and v9.6 at this time.

Installation

Install-Module -Name BlueCatPoSh

Usage

BlueCatPoSh uses PowerShell classes. The 'using' command is how you should load such modules:

using module BlueCatPoSh

Using Import-Module or #Requires will not properly load the required classes and will impact your ability to fully use the module.

As this module uses the IPAM API, any connection must be with an API authorized account.

To create a new BlueCat session, use the following command:

# API enabled username and password for your IPAM appliance
$bcCredential = Get-Credential

# Create an API session with your IPAM appliance
Connect-BlueCat -Server 'ipam.example.com' -Credential $bcCredential

Your session will be stored in the $BlueCatSession variable. This session will be used as the default if you do not specify a session for other library cmdlets. You can create non-default sessions by using the -PassThru flag and catching the session variable as the return value.

For more information see:

Get-Help Connect-BlueCat -Full

You can also set a default View or Configuration. Setting these will establish defaults for any library cmdlet that requires a View or Configuration parameter. For example:

Set-BlueCatConfig -Name 'CORPORATE'

Will update the default $BlueCatSession object with your chosen Configuration.

Similarly, you can set a default View instead:

Set-BlueCatView -Name 'Developers'

This will update the default $BlueCatSession object with your chosen View. To set the View by name you must set the default Configuration first.

Important

Names of Configurations and Views are case-sensitive.

Alternatively you can set the View directly by Entity ID:

Set-BlueCatView -ID 23456

This will set both the default View as well as the default Configuration since the library can do the lookup directly by Entity ID.

To get lists of all available Configurations or Views:

# Get a list of all available Configurations
Get-BlueCatConfig -All

# Get a list of all available Views in your default Configuration
Get-BlueCatView -All

# Get a list of all available Views in all available Configurations
Get-BlueCatView -All -EveryConfig

Roadmap

1. Implement Update-* functions for DNS related records
2. Implement IP4 Address related functions

Features Under Consideration:

• Integrate ARIN lookups for IP4 block/network creation/updates
• IP6 Address related functions
• Add support for BlueCat APIv2

Minor Release Highlights

• 3.1.0 implemented Remove-* functions for DNS related records

Support

Its mostly just me, but I do have a small team that assists me with the support of tools and libraries that I can tap if the work is useful in our environment. Please feel free to log issues/bugs and feature requests. Code contributions are welcome as well. I'll respond as quickly as time permits.