Powershell module for Netbox
Find a file
Ben Claussen 26c7ccfdd0
v1.5.0 (#22)
* Connect(Setup): Fix indent (using Visual code Formatter)

* Setup(Functions): Fix indent (using Visual Code Formatter)

* Support(Setup): Fix indent (using Visual Code Formatter)

* InvokeNetboxRequest(Helpers): Fix indent (using Visual Code Formatter)

* Add Set-netboxCipherSSL for enable TLS1.1 and TLS1.2 (for PS 5.0)

From PowerAruba/FortiPower Module :)

* Add Set-NetboxUnstrustedSSL for disable SSL chain test (for PS 5.0

From PowerAruba/FortiPwoer Module :)

* Add Get/Set netboxInvokeParms for Get and Set Invoke Params (array)

Like -SkipCertificate, Timeout...

* InvokeNetboxRequest: Add to Splat NetboxInvokeParams

* Connect: Add SkipCertificateCheck parameter (for PS5 and Core)

Also enable TLS 1.1 and 1.2 for PS5

* PSSA: Add Github Actions for launch PSSA (PowerShell Script Analyzer) when launch PR (#11)

Add also vscode/PSScriptAnalyzerSettings.psd1 for Settings for PSSA (can be reuse also for vscode...)

* Update psproj

* Correct typo

* Correct brace formatting

* Add Get/Set timeout functions

* Add Get/Set timeout functions

* Add TimeoutSeconds parameter and logic to Connect-NetboxAPI
- Updated `InvokeNetboxRequest` to use `NetboxConfig.Timeout`
- Updated `Get-NetboxAPIDefinition` to use `NetboxConfig.Timeout`

* Trim whitespaces

* Add Get-NetboxVersion function

* Remove API Definition caching and replace with Netbox version check

* Increment version to 1.4

* Fix Typo and Enhance AvailableIP Example (#18)

* AvailableIP(IPAM/Address): Fix typo

* AvailableIP(IAPM/Address): Enhance Example

* NetboxPS(.psm1): Fix typo (paramters => parameters

* Update deployment files

* Add Assigned Object (Type and ID) to New IPAM Address (#19)

* IPAMAddress(New): Remove tab (use 4 spaces)

* IPAMAddress(New): Remove not longer needed code about value validation

* IPAMAddress(New): Add Assigned Object Type and ID

Fix #17

* IPAMAddress(New): add Parameter example

* IPAMAddress(New): Add Validate for Assigned Object Type

Can be only dcim.interface or virtualization.vminterface

* IPAMAddress(New): Fix Example (it is New and not Create Verb !)

* IPAMAddress(New): Remove -Force parameter, use -Confirm if you want a confirmation

it is the standard with ShouldProcess

* Fix PSSA Warning (#20)

* Fix trailing white space

using Invoke-ScriptAnalyzer -Fix -Path . -Recurse

* add settings.json for configure Visual Code (Formatter)

* PSSA: Fix Command accepts pipeline input but has not defined a process block

* PSSA: Fix PSUseDeclaredVarsMoreThanAssignments

The variable 'I_B' is assigned but never used
The variable 'I_A' is assigned but never used

* PSSA: Fix PSUseShouldProcessForStateChangingFunctions

Function New-/Set-... has verb that could change system state. Therefore, the function has to support 'ShouldProcess'

* Add release.(yml) Github Actions (#21)

It will push on PSGallery module when release a new version !

* Update deploy.ps1 docs

* Update readme

* Remove unused files

* Increment version to 1.5.0

Co-authored-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Co-authored-by: Ben Claussen <claussen@neonet.org>
2021-07-23 16:24:34 -04:00
.github/workflows v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
.vscode v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
Functions v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
NetboxPS v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
Postman Version 1.3.0 (#3) 2021-03-25 16:52:08 -04:00
Tests v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
.gitignore Add deploy.ps1 for PSS deploy workaround 2020-04-09 09:57:59 -04:00
_config.yml Set theme jekyll-theme-slate 2020-12-08 09:29:51 -05:00
deploy.ps1 v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
LICENSE Add license 2018-05-18 12:19:15 -04:00
NetboxPS.psd1 v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
NetboxPS.psm1 v1.5.0 (#22) 2021-07-23 16:24:34 -04:00
NetboxPS.psproj Version 1.4 (#14) 2021-07-22 12:00:12 -04:00
NetboxPS.psproj.bak Project file updates 2018-10-18 12:56:18 -04:00
README.md v1.5.0 (#22) 2021-07-23 16:24:34 -04:00

NetboxPS

Powershell Netbox API module

Disclaimer

This module is beta. Use it at your own risk. I have only added functions as I have needed them, so not everything is available.

All functions are exported at the moment, including internal/private functions.

Description

This module is a wrapper for the Netbox API.

Usage

  1. Install module from the netboxPS folder
  2. Import module
  3. Connect to an API endpoint by using Connect-NetboxAPI -Hostname netbox.example.com

Notes

I started this project years ago with Powershell Studio using the built in deployment methods, learning Git, and learning PS best practices. So please forgive any "obvious" mistakes 😅 Over time I have had to adjust my methods for deployment... change the design of functions, and refactor code as I learn new and better things.

This was built out of a need at my job to interact with Netbox for automation. Only recently has it become a "public" project with other collaborators (which I truly appreciate!). I have done my best to ensure each function does exactly one thing according to the API.

I will do my best to keep up, but please understand it is given attention as I can at work. As time permits, I will open issues for TODOs for things I have wanted to do for a while, just haven't had time or enough "need" to do them.

Contributing

I am always open to suggestions for improvement with reasons and data to back up the suggestion.