PSNetboxFunctions.psm1
|
Function Connect-NetboxAPI { <# .SYNOPSIS Connect to the Netbox API .DESCRIPTION Connect to the Netbox API and generate a Token variable that can be used with your own Invoke-RestMethod commands '$netboxAuthenticationHeader' All Functions within this Module already has this variable implemented. .PARAMETER Url Your Netbox Url .PARAMETER Token Your API Token .PARAMETER LogToFile Connect to PSLoggingFunctions module, read more on GitHub, it create a Log folder in your directory if set to True .EXAMPLE Connect-NetboxAPI -Url "https://netbox.internal.local" -Token se651bsb651sdf132adsfg1asd65f46b5 -LogToFile $True OUTPUT Netbox Authenticated: True Use Header Connection Variable = $netboxAuthenticationHeader #> Param( [parameter(mandatory)] $Url, [parameter(mandatory)] $Token, [parameter(mandatory)] $LogToFile ) $netboxAuthenticationHeader = @{ "Authorization" = "Token "+$Token "Accept" = "application/json; indent=4" } Write-Log -Message "Connecting to Netbox API" -Active $LogToFile $testConnection = Invoke-RestMethod -Method GET -Uri "$Url/api/users/tokens/" -Headers $netboxAuthenticationHeader $global:NetboxAuthenticated = $false if ($testConnection){ $global:NetboxAuthenticated = $true $global:netboxUrl = $Url Write-Log -Message "Netbox Authenticated: $NetboxAuthenticated`nNetbox URL = $netboxUrl" -Active $LogToFile Write-Host "Netbox Authenticated: $NetboxAuthenticated`nNetbox URL = $netboxUrl`nUse Header Connection Variable ="'$netboxAuthenticationHeader' $global:netboxAuthenticationHeader = $netboxAuthenticationHeader return "" } Write-Log -Message "Netbox Authenticated: $NetboxAuthenticated" -Active $LogToFile Write-Host "Netbox Authenticated: $NetboxAuthenticated" return $false } Function Find-NetboxConnection { if (!$NetboxAuthenticated) { Write-Warning "Netbox API is not authenticated, you need to run Connect-NetboxAPI and make sure you put in the correct token!" return $false } return $true } Function ConvertTo-ValidSlug { param( [parameter(mandatory)] $InputString ) return (Remove-SpecialCharacters($InputString)).replace(" ","-").replace([char]0xA0,"-") } Function Get-NetboxObjects { <# .SYNOPSIS Retrieve any Netbox Objects .DESCRIPTION You can retrieve any Netbox Objects through the API by supplying the parameter APIEndpoint with the sort of objects you want to retrieve. .PARAMETER APIEndpoint The APIEndpoint (look in Netbox official API) it looks like this example: '/api/dcim/devices/' .PARAMETER LogToFile Connect to PSLoggingFunctions module, read more on GitHub, it create a Log folder in your directory if set to True .EXAMPLE This retrieves all Dcim Devices and Gives you a log in the script root directory Get-NetboxObjects -APIEndpoint "/api/dcim/devices/" -LogToFile $True #> Param( [parameter(mandatory)] $APIEndpoint, [parameter(mandatory)] [ValidateSet("True","False")] $LogToFile ) if (Find-NetboxConnection){ $Devices = @() $uri = "$($netboxUrl)$($APIEndpoint)?limit=0" do { $uri = $uri -replace("http://","https://") $Results = Invoke-TryCatchLog -InfoLog "Retrieving 1000 Netbox Objects from Endpoint: $APIEndpoint" -LogToFile $LogToFile -ScriptBlock { Invoke-RestMethod -Uri $uri -Method GET -Headers $netboxAuthenticationHeader -ContentType "application/json" } if ($Results.results) { $Devices += $Results.results } else { $Devices += $Results } $uri = $Results.next } until (!($uri)) return $Devices } } Function New-NetboxTenant { <# .SYNOPSIS Create a new netbox tenant (customer) .DESCRIPTION Create new tenants, include tags or other object data if needed. .PARAMETER tenantName Name of the new Tenant (customer) .PARAMETER objectData If you have other data you want to add as well. You supply it like a normal powershell object Example: -objectData @{custom_fields=@{customer_id = "CUSTOMERID"}} .PARAMETER tags If you have any tags you want to add, it is in a string array -tags ("Tag1","Tag2") .PARAMETER LogToFile Connect to PSLoggingFunctions module, read more on GitHub, it create a Log folder in your directory if set to True .EXAMPLE # If you want to add a value to the customer that does not already exist, for example a customer id. $customAddition = @{ custom_fields = @{ customer_id = "123123" } } New-NetboxTenant -tenantName "TurboTenant" -tags ("tag123","cooltenant") -objectData $customAddition -LogToFile $false if you have nothing extra to add just skip objectData and if there are no tags, you can skip that aswell. New-NetboxTenant -tenantName "TurboTenant" -LogToFile $false #> param( [parameter(mandatory)] $tenantName, $objectData, [string[]]$tags, [parameter(mandatory)] [ValidateSet("True","False")] $LogToFile ) if (Find-NetboxConnection){ $tenantObject = @{ name = $tenantName.replace([char]0xA0," ") slug = ConvertTo-ValidSlug($tenantName) } if ($objectData){ $tenantObject += $objectData } if ($tags){ $tenantObject += AddTagsToObject -newTags $tags } $tenantObject = $tenantObject | ConvertTo-Json -Compress Invoke-TryCatchLog -LogType CREATE -InfoLog "Creating new Netbox Tenant: $tenantName" -LogToFile $LogToFile -ScriptBlock { Invoke-RestMethod -Method POST -Uri "$netboxUrl/api/tenancy/tenants/" -Headers $netboxAuthenticationHeader -Body $tenantObject -ContentType "application/json;charset=utf-8" } } } function New-NetboxSite { <# .SYNOPSIS Create a new netbox site (address/location) .DESCRIPTION Create new sites, include tags or other object data if needed. .PARAMETER siteName Name of the new site (address/location) .PARAMETER objectData If you have other data you want to add as well. You supply it like a normal powershell object Example: -objectData @{custom_fields=@{customer_id = "CUSTOMERID"}} .PARAMETER tags If you have any tags you want to add, it is in a string array -tags ("Tag1","Tag2") .PARAMETER LogToFile Connect to PSLoggingFunctions module, read more on GitHub, it create a Log folder in your directory if set to True .EXAMPLE # If you want to add a value to the site that does not already exist, for example a customer id. $customAddition = @{ custom_fields = @{ customer_id = "123123" } } New-NetboxSite -siteName "My-road 12B" -tags ("tag123","coolsite") -objectData $customAddition -LogToFile $false if you have nothing extra to add just skip objectData and if there are no tags, you can skip that aswell. New-NetboxSite -siteName "My-road 12B" -LogToFile $false #> param( [parameter(mandatory)] $siteName, $objectData, [string[]]$tags, [parameter(mandatory)] [ValidateSet("True","False")] $LogToFile ) $siteObject = @{ name = $siteName slug = Remove-SpecialCharacters($siteName) } if ($objectData){ $siteObject += $objectData } if ($tags){ $siteObject += AddTagsToObject -newTags $tags } $siteObject = $siteObject | ConvertTo-Json -Compress Invoke-TryCatchLog -LogType CREATE -InfoLog "Creating new Netbox Site: $siteName - $siteObject" -LogToFile $LogToFile -ScriptBlock { Invoke-RestMethod -Method POST -Uri "$netboxUrl/api/dcim/sites/" -Headers $netboxAuthenticationHeader -Body $siteObject -ContentType "application/json" } } function AddTagsToObject { <# .SYNOPSIS Add Tags to a Object .DESCRIPTION Make sure that tags are not being overwritten, add them to the other current tags, or just add new ones .PARAMETER currentTags Array of current tags, only used if you want to keep your current tags on the object .PARAMETER newTags Array of the new Tags you want to apply .EXAMPLE Add new tags and keep the current ones aswell. AddTagsToObject -CurrentTags $tenantObject.tags.name -NewTags $newTags Only add new Tags AddTagsToObject -NewTags $newTags Usually used in combination when updated Tenant or other Object. #> param( $currentTags, [parameter(mandatory)] [string[]]$newTags ) $tagObject = @{ tags = @() } if ($currentTags){ foreach ($tag in $currentTags){ $tagObject.tags += @{ name = "$tag" } } } foreach ($tag in $newTags){ if ($tag -notin $currentTags){ $tagObject.tags += @{ name = "$tag" } } } return $tagObject } function Remove-NetboxObject { <# .SYNOPSIS Remove any sort of Netbox Object by supplying its ID .DESCRIPTION Remove any sort of Netbox Object by supplying its ID, APIEndpoint need to be set like this example: '/api/tenancy/tenants/' .PARAMETER APIEndpoint The APIEndpoint for example: /api/tenancy/tenants/ .PARAMETER ObjectID The ID of the object you want to delete/remove .PARAMETER LogToFile Connect to PSLoggingFunctions module, read more on GitHub, it create a Log folder in your directory if set to True .EXAMPLE Remove-NetboxObject -APIEndpoint "/api/tenancy/tenants/" -ObjectID "235" -LogToFile $True .NOTES You need API permissions for the objects you want to delete. #> Param( [parameter(mandatory)] $APIEndpoint, [parameter(mandatory)] $ObjectID, [parameter(mandatory)] [ValidateSet("True","False")] $LogToFile ) if (Find-NetboxConnection){ Invoke-TryCatchLog -LogType DELETE -InfoLog "Removing Netbox Object: $APIEndpoint - $ObjectID" -LogToFile $LogToFile -ScriptBlock { Invoke-RestMethod -Method DELETE -Uri "$($netboxUrl)$($APIEndpoint)$($ObjectID)/" -Headers $netboxAuthenticationHeader -Body $DeleteObject -ContentType "application/json" } } } function Update-NetboxTenant { <# .SYNOPSIS Update a Netbox Tenant .DESCRIPTION Update a Netbox Tenant with your own object values and ability to add new tags .PARAMETER tenantObject Input a complete Tenant Object so we have all properties from the current Tenant. .PARAMETER tenantName tenantName if you want to change the current name, this will also update the slug .PARAMETER newData Input a Powershell Object of which attribute you want to update, for example. $customAddition = @{ custom_fields = @{ customer_id = "123123" } } -newData $customAddition .PARAMETER newTags -newTags ("Tag1","Tag2") .PARAMETER LogToFile Connect to PSLoggingFunctions module, read more on GitHub, it create a Log folder in your directory if set to True .EXAMPLE Update the Tenants name and add a tag called syncedtenant (must exist a tag with this name) Update-NetboxTenant -tenantObject $NetboxTenant -tenantName "NewTenantName" -newTags ("syncedtenant") -LogToFile $True Update the customer with your own custom value $customAddition = @{ custom_fields = @{ customer_id = "123123" } } Update-NetboxTenant -tenantObject $NetboxTenant -newData $customAddition -LogToFile $True #> param( [parameter(mandatory)] $tenantObject, $tenantName, $newData, [string[]]$newTags, [parameter(mandatory)] [ValidateSet("True","False")] $LogToFile ) if (Find-NetboxConnection){ $updateObject = @{} if ($tenantName){ $updateObject += @{ name = $tenantName.replace([char]0xA0," ") slug = ConvertTo-ValidSlug($tenantName) } } if ($newData){ $updateObject += $newData } if ($tags){ $updateObject += AddTagsToObject -CurrentTags $tenantObject.tags.name -newTags $newTags } $updateObject = $updateObject | ConvertTo-Json -Compress Invoke-TryCatchLog -LogType UPDATE -InfoLog "Updating Netbox Tenant: $tenantName - $($tenantObject.id) - $updateObject" -LogToFile $LogToFile -ScriptBlock { Invoke-RestMethod -Uri "$netboxUrl/api/tenancy/tenants/$($tenantObject.id)/" -Method PATCH -Headers $netboxAuthenticationHeader -Body $updateObject -ContentType "application/json;charset=utf-8" } } } |