Increment version to 1.4

NetboxPS.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Ben Claussen
 #
-# Generated on: 2021-03-31
+# Generated on: 2021-07-22
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'NetboxPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.3.3'
+ModuleVersion = '1.4'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

NetboxPS/NetboxPS.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Ben Claussen
 #
-# Generated on: 2021-03-31
+# Generated on: 2021-07-22
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'NetboxPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.3.3'
+ModuleVersion = '1.4'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

NetboxPS/NetboxPS.psm1

@@ -490,6 +490,12 @@ function Connect-NetboxAPI {
     .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"
 
@@ -518,7 +524,14 @@ function Connect-NetboxAPI {
 
         [Parameter(ParameterSetName = 'URI',
                    Mandatory = $true)]
-        [string]$URI
+        [string]$URI,
+
+        [Parameter(Mandatory = $false)]
+        [switch]$SkipCertificateCheck = $false,
+
+        [ValidateNotNullOrEmpty()]
+        [ValidateRange(1, 65535)]
+        [uint16]$TimeoutSeconds = 30
     )
 
     if (-not $Credential) {
@@ -532,7 +545,22 @@ function Connect-NetboxAPI {
         }
     }
 
-    $null = Set-NetboxCredential -Credential $Credential
+    $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
+        Set-NetboxCipherSSL
+        if ($SkipCertificateCheck) {
+            #Disable SSL chain trust...
+            Set-NetboxuntrustedSSL
+        }
+    }
 
     switch ($PSCmdlet.ParameterSetName) {
         'Manual' {
@@ -548,8 +576,11 @@ function Connect-NetboxAPI {
     }
 
     $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..."
@@ -564,12 +595,21 @@ function Connect-NetboxAPI {
         }
     }
 
-    Write-Verbose "Caching API definition"
+#    Write-Verbose "Caching API definition"
-    $script:NetboxConfig.APIDefinition = Get-NetboxAPIDefinition
+#    $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)"
+    #    }
 
-    if ([version]$script:NetboxConfig.APIDefinition.info.version -lt 2.8) {
+    Write-Verbose "Checking Netbox version compatibility"
+    $script:NetboxConfig.NetboxVersion = Get-NetboxVersion
+    if ([version]$script:NetboxConfig.NetboxVersion.'netbox-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)"
+        throw "Netbox version is incompatible with this PS module. Requires >=2.8.*, found version $($script:NetboxConfig.NetboxVersion.'netbox-version')"
+    } else {
+        Write-Verbose "Found compatible version [$($script:NetboxConfig.NetboxVersion.'netbox-version')]!"
     }
 
     $script:NetboxConfig.Connected = $true
@@ -707,16 +747,16 @@ function Get-ModelDefinition {
 #region File Get-NetboxAPIDefinition.ps1
 
 <#
-	.NOTES
+    .NOTES
-	===========================================================================
+    ===========================================================================
-	 Created with: 	SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.174
+     Created with:     SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.174
-	 Created on:   	4/28/2020 11:57
+     Created on:       4/28/2020 11:57
-	 Created by:   	Claussen
+     Created by:       Claussen
-	 Organization: 	NEOnet
+     Organization:     NEOnet
-	 Filename:     	Get-NetboxAPIDefinition.ps1
+     Filename:         Get-NetboxAPIDefinition.ps1
-	===========================================================================
+    ===========================================================================
-	.DESCRIPTION
+    .DESCRIPTION
-		A description of the file.
+        A description of the file.
 #>
 
 
@@ -729,11 +769,11 @@ function Get-NetboxAPIDefinition {
 
     $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
 
-    InvokeNetboxRequest -URI $URI -Timeout 10
+    InvokeNetboxRequest -URI $URI
 }
 
 #endregion
@@ -1745,6 +1785,22 @@ function Get-NetboxHostScheme {
 
 #endregion
 
+#region File Get-NetboxInvokeParams.ps1
+
+function Get-NetboxInvokeParams {
+    [CmdletBinding()]
+    param ()
+
+    Write-Verbose "Getting Netbox InvokeParams"
+    if ($null -eq $script:NetboxConfig.InvokeParams) {
+        throw "Netbox Invoke Params is not set! You may set it with Set-NetboxInvokeParams -InvokeParams ..."
+    }
+
+    $script:NetboxConfig.InvokeParams
+}
+
+#endregion
+
 #region File Get-NetboxIPAMAddress.ps1
 
 function Get-NetboxIPAMAddress {
@@ -2553,6 +2609,44 @@ function Get-NetboxTenant {
 
 #endregion
 
+#region File Get-NetboxTimeout.ps1
+
+
+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
+}
+
+#endregion
+
+#region File Get-NetboxVersion.ps1
+
+
+function Get-NetboxVersion {
+    [CmdletBinding()]
+    param ()
+
+    $Segments = [System.Collections.ArrayList]::new(@('status'))
+
+    $URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary @{
+        'format' = 'json'
+    }
+
+    $URI = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters -SkipConnectedCheck
+
+    InvokeNetboxRequest -URI $URI
+}
+
+#endregion
+
 #region File Get-NetboxVirtualizationCluster.ps1
 
 <#	
@@ -2995,8 +3089,8 @@ function InvokeNetboxRequest {
 
         [pscustomobject]$Body = $null,
 
-        [ValidateRange(0, 60)]
+        [ValidateRange(1, 65535)]
-        [uint16]$Timeout = 5,
+        [uint16]$Timeout = (Get-NetboxTimeout),
 
         [ValidateSet('GET', 'PATCH', 'PUT', 'POST', 'DELETE', 'OPTIONS', IgnoreCase = $true)]
         [string]$Method = 'GET',
@@ -3009,15 +3103,17 @@ function InvokeNetboxRequest {
     $Headers.Authorization = "Token {0}" -f $creds.GetNetworkCredential().Password
 
     $splat = @{
-        'Method' = $Method
+        'Method'      = $Method
-        'Uri'    = $URI.Uri.AbsoluteUri # This property auto generates the scheme, hostname, path, and query
+        'Uri'         = $URI.Uri.AbsoluteUri # This property auto generates the scheme, hostname, path, and query
-        'Headers' = $Headers
+        'Headers'     = $Headers
-        'TimeoutSec' = $Timeout
+        'TimeoutSec'  = $Timeout
         'ContentType' = 'application/json'
         'ErrorAction' = 'Stop'
-        'Verbose' = $VerbosePreference
+        'Verbose'     = $VerbosePreference
     }
 
+    $splat += Get-NetboxInvokeParams
+
     if ($Body) {
         Write-Verbose "BODY: $($Body | ConvertTo-Json -Compress)"
         $null = $splat.Add('Body', ($Body | ConvertTo-Json -Compress))
@@ -3936,21 +4032,34 @@ function Remove-NetboxVirtualMachine {
 
 #endregion
 
+#region File Set-NetboxCipherSSL.ps1
+
+Function Set-NetboxCipherSSL {
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessforStateChangingFunctions", "")]
+    Param(  )
+    # Hack for allowing TLS 1.1 and TLS 1.2 (by default it is only SSL3 and TLS (1.0))
+    $AllProtocols = [System.Net.SecurityProtocolType]'Ssl3,Tls,Tls11,Tls12'
+    [System.Net.ServicePointManager]::SecurityProtocol = $AllProtocols
+
+}
+
+#endregion
+
 #region File Set-NetboxCredential.ps1
 
 function Set-NetboxCredential {
     [CmdletBinding(DefaultParameterSetName = 'CredsObject',
-                   ConfirmImpact = 'Low',
+        ConfirmImpact = 'Low',
-                   SupportsShouldProcess = $true)]
+        SupportsShouldProcess = $true)]
     [OutputType([pscredential])]
     param
     (
         [Parameter(ParameterSetName = 'CredsObject',
-                   Mandatory = $true)]
+            Mandatory = $true)]
         [pscredential]$Credential,
 
         [Parameter(ParameterSetName = 'UserPass',
-                   Mandatory = $true)]
+            Mandatory = $true)]
         [securestring]$Token
     )
 
@@ -4277,7 +4386,7 @@ function Set-NetboxDCIMInterfaceConnection {
 
 function Set-NetboxHostName {
     [CmdletBinding(ConfirmImpact = 'Low',
-                   SupportsShouldProcess = $true)]
+        SupportsShouldProcess = $true)]
     [OutputType([string])]
     param
     (
@@ -4338,6 +4447,25 @@ function Set-NetboxHostScheme {
 
 #endregion
 
+#region File Set-NetboxInvokeParams.ps1
+
+function Set-NetboxInvokeParams {
+    [CmdletBinding(ConfirmImpact = 'Low',
+        SupportsShouldProcess = $true)]
+    [OutputType([string])]
+    param(
+        [Parameter(Mandatory = $true)]
+        [array]$InvokeParams
+    )
+
+    if ($PSCmdlet.ShouldProcess('Netbox Invoke Params', 'Set')) {
+        $script:NetboxConfig.InvokeParams = $InvokeParams
+        $script:NetboxConfig.InvokeParams
+    }
+}
+
+#endregion
+
 #region File Set-NetboxIPAMAddress.ps1
 
 <#
@@ -4534,6 +4662,52 @@ function Set-NetboxIPAMPrefix {
 
 
 
+#endregion
+
+#region File Set-NetboxTimeout.ps1
+
+
+function Set-NetboxTimeout {
+    [CmdletBinding(ConfirmImpact = 'Low',
+                   SupportsShouldProcess = $true)]
+    [OutputType([uint16])]
+    param
+    (
+        [Parameter(Mandatory = $false)]
+        [ValidateRange(1, 65535)]
+        [uint16]$TimeoutSeconds = 30
+    )
+
+    if ($PSCmdlet.ShouldProcess('Netbox Timeout', 'Set')) {
+        $script:NetboxConfig.Timeout = $TimeoutSeconds
+        $script:NetboxConfig.Timeout
+    }
+}
+
+#endregion
+
+#region File Set-NetboxUnstrustedSSL.ps1
+
+Function Set-NetboxUntrustedSSL {
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessforStateChangingFunctions", "")]
+    Param(  )
+    # Hack for allowing untrusted SSL certs with https connections
+    Add-Type -TypeDefinition @"
+    using System.Net;
+    using System.Security.Cryptography.X509Certificates;
+    public class TrustAllCertsPolicy : ICertificatePolicy {
+        public bool CheckValidationResult(
+        ServicePoint srvPoint, X509Certificate certificate,
+        WebRequest request, int certificateProblem) {
+            return true;
+        }
+    }
+"@
+
+    [System.Net.ServicePointManager]::CertificatePolicy = New-Object -TypeName TrustAllCertsPolicy
+
+}
+
 #endregion
 
 #region File Set-NetboxVirtualMachine.ps1
@@ -4696,8 +4870,8 @@ function SetupNetboxConfigVariable {
     if ((-not ($script:NetboxConfig)) -or $Overwrite) {
         Write-Verbose "Creating NetboxConfig hashtable"
         $script:NetboxConfig = @{
-            'Connected' = $false
+            'Connected'     = $false
-            'Choices'   = @{
+            'Choices'       = @{
             }
             'APIDefinition' = $null
         }
@@ -4786,7 +4960,7 @@ function VerifyAPIConnectivity {
 
     $uriSegments = [System.Collections.ArrayList]::new(@('extras'))
 
-    $uri = BuildNewURI -Segments $uriSegments -Parameters @{'format' = 'json'} -SkipConnectedCheck
+    $uri = BuildNewURI -Segments $uriSegments -Parameters @{'format' = 'json' } -SkipConnectedCheck
 
     InvokeNetboxRequest -URI $uri
 }