Foreman plugin for IPAM integration with External IPAM providers. Provides a basic Dashboard for viewing External IPAM groups and subnets via External IPAM Smart Proxy API's.
See How_to_Install_a_Plugin for how to install Foreman plugins.
Once plugin is installed, you can look at the External IPAM Dashboard at Infrastructure --> External IPAM, for a simple view of groups and subnets.
- Clone the Foreman repo
git clone https://github.com/theforeman/foreman.git
- Clone the Smart Proxy repo
git clone https://github.com/theforeman/smart-proxy
- Fork both the foreman plugin and smart proxy plugin repos, then clone
git clone https://github.com/<GITHUB_USER>/foreman_ipam
git clone https://github.com/<GITHUB_USER>/smart_proxy_ipam
- Add the foreman_ipam plugin to
Gemfile.local.rbin the Foreman bundler.d directory
gem 'foreman_ipam', :path => '/path/to/foreman_ipam'
- From Foreman root directory run
bundle exec rails db:migrate
bundle exec rails db:seed
bundle exec foreman start
- Add the smart_proxy_ipam plugin to
Gemfile.local.rbin Smart Proxy bundler.d directory
gem 'smart_proxy_ipam', :path => '/path/to/smart_proxy_ipam'
config/settings.d/externalipam.yml, and set
enabledto true, and
config/settings.d/externalipam_phpipam.ymland replace values with your phpIPAM URL and credentials.
config/settings.d/externalipam_netbox.ymland replace values with your Netbox URL and API token.
From Smart Proxy root directory run ...
bundle exec smart-proxy start
- Navigate to Foreman UI at http://localhost:5000
- Add a Local Smart Proxy in the Foreman UI(Infrastructure => Smart Proxies)
- Ensure that the
External IPAMfeature is present on the proxy(http://proxy_url/features)
- Create a Subnet, and associate the subnet to the
From the Foreman core, run ...
bundle exec rails test:foreman_ipam
Fork and send a Pull Request. Thanks!
Copyright (c) 2019 Christopher Smith
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.