NetboxPS/Functions/Setup.ps1

<#	
	.NOTES
	===========================================================================
	 Created with: 	SAPIEN Technologies, Inc., PowerShell Studio 2018 v5.5.148
	 Created on:   	2/28/2018 3:33 PM
	 Created by:   	Ben Claussen
	 Organization: 	NEOnet
	 Filename:     	Setup.ps1
	===========================================================================
	.DESCRIPTION
		These are the function used to setup the environment for connecting
        to a Netbox API
#>

function Set-NetboxHostName {
    [CmdletBinding(ConfirmImpact = 'Low',
                   SupportsShouldProcess = $true)]
    [OutputType([string])]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]$Hostname
    )
    
    if ($PSCmdlet.ShouldProcess('Netbox Hostname', 'Set')) {
        $script:NetboxConfig.Hostname = $Hostname.Trim()
        $script:NetboxConfig.Hostname
    }
}

function Get-NetboxHostname {
	[CmdletBinding()]
	param ()
    
    Write-Verbose "Getting Netbox hostname"
	if ($null -eq $script:NetboxConfig.Hostname) {
		throw "Netbox Hostname is not set! You may set it with Set-NetboxHostname -Hostname 'hostname.domain.tld'"
	}
	
	$script:NetboxConfig.Hostname
}

function Set-NetboxCredential {
    [CmdletBinding(DefaultParameterSetName = 'CredsObject',
                   ConfirmImpact = 'Low',
                   SupportsShouldProcess = $true)]
    [OutputType([pscredential])]
    param
    (
        [Parameter(ParameterSetName = 'CredsObject',
                   Mandatory = $true)]
        [pscredential]$Credential,
        
        [Parameter(ParameterSetName = 'UserPass',
                   Mandatory = $true)]
        [securestring]$Token
    )
    
    if ($PSCmdlet.ShouldProcess('Netbox Credentials', 'Set')) {
        switch ($PsCmdlet.ParameterSetName) {
            'CredsObject' {
                $script:NetboxConfig.Credential = $Credential
                break
            }
            
            'UserPass' {
                $script:NetboxConfig.Credential = [System.Management.Automation.PSCredential]::new('notapplicable', $Token)
                break
            }
        }
        
        $script:NetboxConfig.Credential
    }
}

function Get-NetboxCredential {
	[CmdletBinding()]
	[OutputType([pscredential])]
	param ()
	
	if (-not $script:NetboxConfig.Credential) {
		throw "Netbox Credentials not set! You may set with Set-NetboxCredential"
	}
	
	$script:NetboxConfig.Credential
}

function Connect-NetboxAPI {
<#
    .SYNOPSIS
        Connects to the Netbox API and ensures Credential work properly
    
    .DESCRIPTION
        A detailed description of the Connect-NetboxAPI function.
    
    .PARAMETER Hostname
        A description of the Hostname parameter.
    
    .PARAMETER Credential
        A description of the Credential parameter.
    
    .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()]
    param
    (
        [Parameter(Mandatory = $true)]
        [string]$Hostname,
        
        [Parameter(Mandatory = $false)]
        [pscredential]$Credential
    )
    
    if (-not $Credential) {
        try {
            $Credential = Get-NetboxCredential -ErrorAction Stop
        } catch {
            # Credentials are not set... Try to obtain from the user
            if (-not ($Credential = Get-Credential -UserName 'username-not-applicable' -Message "Enter token for Netbox")) {
                throw "Token is necessary to connect to a Netbox API."
            }
        }
    }
    
    $null = Set-NetboxHostName -Hostname $Hostname
    $null = Set-NetboxCredential -Credential $Credential
    
    try {
        Write-Verbose "Verifying API connectivity..."
        $null = VerifyAPIConnectivity
        $script:NetboxConfig.Connected = $true
        Write-Verbose "Successfully connected!"
    } catch {
        Write-Verbose "Failed to connect. Generating error"
        Write-Verbose $_.Exception.Message
        if (($_.Exception.Response) -and ($_.Exception.Response.StatusCode -eq 403)) {
            throw "Invalid token"
        } else {
            throw $_
        }
    }
    
    Write-Verbose "Caching static choices"
    $script:NetboxConfig.Choices.Circuits = Get-NetboxCircuitsChoices
    $script:NetboxConfig.Choices.DCIM = Get-NetboxDCIMChoices          # Not completed yet
    $script:NetboxConfig.Choices.Extras = Get-NetboxExtrasChoices
    $script:NetboxConfig.Choices.IPAM = Get-NetboxIPAMChoices
    #$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"
}