PS.IPAM

Powershell module for phpIPAM
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Links

About The Project

PS.IPAM is Powershell module that wraps phpIPAM RESTful APi into cmdlets Use the README.md to get started.

(back to top)

Getting Started

Installation

• PSGallery

  Install-Module -Name ps.ipam
  

• Offline
  1. Unblock the Internet-downloaded NuGet package (.nupkg) file, for example using Unblock-File -Path C:\Downloads\module.nupkg cmdlet.
  2. Extract the contents of the NuGet package to a local folder.
  3. Delete the NuGet-specific elements from the folder.
  4. Rename the folder. The default folder name is usually <name>.<version>. The version can include -prerelease if the module is tagged as a prerelease version. Rename the folder to just the module name. For example, azurerm.storage.5.0.4-preview becomes azurerm.storage.
  5. Copy the folder to one of the folders in the $env:PSModulePath value. $env:PSModulePath is a semicolon-delimited set of paths in which PowerShell should look for modules.

(back to top)

Usage

At first you have to create new session:

New-PSIPAMSession -URL <phpIPAM URL> -AppID <API AppID> -Credentials <PSCredentialObject>

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Implement all Set functions

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPL 2.0 or later License. See LICENSE for more information.

(back to top)

Contact

Nikolay Tatarinov - arnikes@gmail.com

Project Link: https://git.arnike.ru/Arnike/ps.ipam

(back to top)

Links

• phpIPAM API Documentation
• PSGallery

(back to top)