diff --git a/Functions/Setup/Connect-NetboxAPI.ps1 b/Functions/Setup/Connect-NetboxAPI.ps1 index 70c6457..72e84c7 100644 --- a/Functions/Setup/Connect-NetboxAPI.ps1 +++ b/Functions/Setup/Connect-NetboxAPI.ps1 @@ -2,69 +2,69 @@ <# .SYNOPSIS Connects to the Netbox API and ensures Credential work properly - + .DESCRIPTION Connects to the Netbox API and ensures Credential work properly - + .PARAMETER Hostname The hostname for the resource such as netbox.domain.com - + .PARAMETER Credential Credential object containing the API key in the password. Username is not applicable - + .PARAMETER Scheme Scheme for the URI such as HTTP or HTTPS. Defaults to HTTPS - + .PARAMETER Port Port for the resource. Value between 1-65535 - + .PARAMETER URI The full URI for the resource such as "https://netbox.domain.com:8443" - + .PARAMETER SkipCertificateCheck A description of the SkipCertificateCheck parameter. - + .PARAMETER TimeoutSeconds The number of seconds before the HTTP call times out. Defaults to 30 seconds - + .EXAMPLE PS C:\> Connect-NetboxAPI -Hostname "netbox.domain.com" - + This will prompt for Credential, then proceed to attempt a connection to Netbox - + .NOTES Additional information about the function. #> - + [CmdletBinding(DefaultParameterSetName = 'Manual')] param ( [Parameter(ParameterSetName = 'Manual', Mandatory = $true)] [string]$Hostname, - + [Parameter(Mandatory = $false)] [pscredential]$Credential, - + [Parameter(ParameterSetName = 'Manual')] [ValidateSet('https', 'http', IgnoreCase = $true)] [string]$Scheme = 'https', - + [Parameter(ParameterSetName = 'Manual')] [uint16]$Port = 443, - + [Parameter(ParameterSetName = 'URI', Mandatory = $true)] [string]$URI, - + [Parameter(Mandatory = $false)] [switch]$SkipCertificateCheck = $false, - + [ValidateNotNullOrEmpty()] [ValidateRange(1, 65535)] [uint16]$TimeoutSeconds = 30 ) - + if (-not $Credential) { try { $Credential = Get-NetboxCredential -ErrorAction Stop @@ -75,14 +75,14 @@ } } } - + $invokeParams = @{ SkipCertificateCheck = $SkipCertificateCheck; } - + if ("Desktop" -eq $PSVersionTable.PsEdition) { #Remove -SkipCertificateCheck from Invoke Parameter (not supported <= PS 5) $invokeParams.remove("SkipCertificateCheck") } - + #for PowerShell (<=) 5 (Desktop), Enable TLS 1.1, 1.2 and Disable SSL chain trust if ("Desktop" -eq $PSVersionTable.PsEdition) { #Enable TLS 1.1 and 1.2 @@ -92,12 +92,12 @@ Set-NetboxuntrustedSSL } } - + switch ($PSCmdlet.ParameterSetName) { 'Manual' { $uriBuilder = [System.UriBuilder]::new($Scheme, $Hostname, $Port) } - + 'URI' { $uriBuilder = [System.UriBuilder]::new($URI) if ([string]::IsNullOrWhiteSpace($uriBuilder.Host)) { @@ -105,14 +105,14 @@ } } } - + $null = Set-NetboxHostName -Hostname $uriBuilder.Host $null = Set-NetboxCredential -Credential $Credential $null = Set-NetboxHostScheme -Scheme $uriBuilder.Scheme $null = Set-NetboxHostPort -Port $uriBuilder.Port $null = Set-NetboxInvokeParams -invokeParams $invokeParams $null = Set-NetboxTimeout -TimeoutSeconds $TimeoutSeconds - + try { Write-Verbose "Verifying API connectivity..." $null = VerifyAPIConnectivity @@ -125,18 +125,18 @@ throw $_ } } - + Write-Verbose "Caching API definition" $script:NetboxConfig.APIDefinition = Get-NetboxAPIDefinition - + if ([version]$script:NetboxConfig.APIDefinition.info.version -lt 2.8) { $Script:NetboxConfig.Connected = $false throw "Netbox version is incompatible with this PS module. Requires >=2.8.*, found version $($script:NetboxConfig.APIDefinition.info.version)" } - + $script:NetboxConfig.Connected = $true Write-Verbose "Successfully connected!" - + #Write-Verbose "Caching static choices" #$script:NetboxConfig.Choices.Circuits = Get-NetboxCircuitsChoices #$script:NetboxConfig.Choices.DCIM = Get-NetboxDCIMChoices # Not completed yet @@ -145,6 +145,6 @@ ##$script:NetboxConfig.Choices.Secrets = Get-NetboxSecretsChoices # Not completed yet ##$script:NetboxConfig.Choices.Tenancy = Get-NetboxTenancyChoices #$script:NetboxConfig.Choices.Virtualization = Get-NetboxVirtualizationChoices - + Write-Verbose "Connection process completed" } \ No newline at end of file diff --git a/Functions/Setup/Get-NetboxTimeout.ps1 b/Functions/Setup/Get-NetboxTimeout.ps1 index 7547e33..220e3f1 100644 --- a/Functions/Setup/Get-NetboxTimeout.ps1 +++ b/Functions/Setup/Get-NetboxTimeout.ps1 @@ -3,11 +3,11 @@ function Get-NetboxTimeout { [CmdletBinding()] [OutputType([uint16])] param () - + Write-Verbose "Getting Netbox Timeout" if ($null -eq $script:NetboxConfig.Timeout) { throw "Netbox Timeout is not set! You may set it with Set-NetboxTimeout -TimeoutSeconds [uint16]" } - + $script:NetboxConfig.Timeout } \ No newline at end of file diff --git a/Functions/Setup/Set-NetboxTimeout.ps1 b/Functions/Setup/Set-NetboxTimeout.ps1 index cee71d2..a738019 100644 --- a/Functions/Setup/Set-NetboxTimeout.ps1 +++ b/Functions/Setup/Set-NetboxTimeout.ps1 @@ -9,7 +9,7 @@ function Set-NetboxTimeout { [ValidateRange(1, 65535)] [uint16]$TimeoutSeconds = 30 ) - + if ($PSCmdlet.ShouldProcess('Netbox Timeout', 'Set')) { $script:NetboxConfig.Timeout = $TimeoutSeconds $script:NetboxConfig.Timeout diff --git a/Functions/Setup/Support/Get-NetboxAPIDefinition.ps1 b/Functions/Setup/Support/Get-NetboxAPIDefinition.ps1 index 59ca911..4fcdf0c 100644 --- a/Functions/Setup/Support/Get-NetboxAPIDefinition.ps1 +++ b/Functions/Setup/Support/Get-NetboxAPIDefinition.ps1 @@ -1,29 +1,29 @@ <# - .NOTES - =========================================================================== - Created with: SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.174 - Created on: 4/28/2020 11:57 - Created by: Claussen - Organization: NEOnet - Filename: Get-NetboxAPIDefinition.ps1 - =========================================================================== - .DESCRIPTION - A description of the file. + .NOTES + =========================================================================== + Created with: SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.174 + Created on: 4/28/2020 11:57 + Created by: Claussen + Organization: NEOnet + Filename: Get-NetboxAPIDefinition.ps1 + =========================================================================== + .DESCRIPTION + A description of the file. #> function Get-NetboxAPIDefinition { - [CmdletBinding()] - param () + [CmdletBinding()] + param () - #$URI = "https://netbox.neonet.org/api/docs/?format=openapi" + #$URI = "https://netbox.neonet.org/api/docs/?format=openapi" - $Segments = [System.Collections.ArrayList]::new(@('docs')) + $Segments = [System.Collections.ArrayList]::new(@('docs')) - $URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary @{'format' = 'openapi' } + $URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary @{'format' = 'openapi' } - $URI = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters -SkipConnectedCheck + $URI = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters -SkipConnectedCheck - InvokeNetboxRequest -URI $URI + InvokeNetboxRequest -URI $URI }