Public/Receive-IBFile.ps1
|
function Receive-IBFile { [CmdletBinding()] param( [Parameter(Mandatory=$True)] [Alias('name')] [string]$FunctionName, [Parameter(Mandatory=$True)] [string]$OutFile, [Alias('args')] [hashtable]$FunctionArgs, [Alias('_ref','ref','ObjectType','type')] [string]$ObjectRef = 'fileop', [switch]$OverrideTransferHost, [ValidateScript({Test-NonEmptyString $_ -ThrowOnFail})] [Alias('host')] [string]$WAPIHost, [ValidateScript({Test-VersionString $_ -ThrowOnFail})] [Alias('version')] [string]$WAPIVersion, [PSCredential]$Credential, [switch]$SkipCertificateCheck, [ValidateScript({Test-ValidProfile $_ -ThrowOnFail})] [string]$ProfileName ) Begin { # grab the variables we'll be using for our REST calls try { $opts = Initialize-CallVars @PSBoundParameters } catch { $PsCmdlet.ThrowTerminatingError($_) } } Process { # requestion the download token and url $response = Invoke-IBFunction -ObjectRef $ObjectRef ` -FunctionName $FunctionName -FunctionArgs $FunctionArgs @opts -EA Stop $dlUrl = $response.url # try to download the file try { $restOpts = @{ Uri = $dlUrl OutFile = $OutFile Credential = $opts.Credential SkipCertificateCheck = $true ContentType = 'application/force-download' ErrorAction = 'Stop' } # We need to add an empty Body parameter on PowerShell Core to work around # this bug which kills the ContentType we set. # https://github.com/PowerShell/PowerShell/issues/9574 if ($PSEdition -and $PSEdition -eq 'Core') { $restOpts.Body = [String]::Empty } if ($OverrideTransferHost) { # make sure the host portion of the URL matches the original WAPIHost $urlHost = ([uri]$restOpts.Uri).Host if ($opts.WAPIHost -ne $urlHost) { $restOpts.Uri = $restOpts.Uri.Replace("https://$urlHost/", "https://$($opts.WAPIHost)/") Write-Verbose "Overrode URL host: $($opts.WAPIHost)" } else { Write-Verbose "URL host already matches original. No need to override." } # and now match the state of SkipCertificateCheck $restOpts.SkipCertificateCheck = $opts.SkipCertificateCheck } # download the file from the designated URL Write-Debug "Downloading file" Invoke-IBWAPI @restOpts } finally { # inform Infoblox that the download is complete if ($response.token) { $null = Invoke-IBFunction -ObjectRef 'fileop' ` -FunctionName 'downloadcomplete' -FunctionArgs @{token=$response.token} @opts } } } <# .SYNOPSIS Download a file from a fileop function .DESCRIPTION This is a wrapper around the various fileop functions that allow data export from Infoblox. .PARAMETER FunctionName The name of the fileop download function to call. .PARAMETER OutFile Specifies the output file that this cmdlet saves the response body. Enter a path and file name. If you omit the path, the default is the current location. .PARAMETER FunctionArgs A hashtable with the required parameters for the function. NOTE: 'token' parameters are handled automatically and can be ignored. .PARAMETER ObjectRef Object reference string. This is usually found in the "_ref" field of returned objects. .PARAMETER OverrideTransferHost If set, the hostname in the transfer URL returned by WAPI will be overridden to match the original WAPIHost if they don't already match. The SkipCertificateCheck switch will also be updated to match the passed in value instead of always being set to true for the call. .PARAMETER WAPIHost The fully qualified DNS name or IP address of the Infoblox WAPI endpoint (usually the grid master). This parameter is required if not already set using Set-IBConfig. .PARAMETER WAPIVersion The version of the Infoblox WAPI to make calls against (e.g. '2.2'). .PARAMETER Credential Username and password for the Infoblox appliance. This parameter is required unless it was already set using Set-IBConfig. .PARAMETER SkipCertificateCheck If set, SSL/TLS certificate validation will be disabled. Overrides value stored with Set-IBConfig. .EXAMPLE Receive-IBFile getgriddata .\backup.tar.gz -args @{type='BACKUP'} Download a grid backup file using the 'getgriddata' fileop function. .EXAMPLE Receive-IBFile csv_export .\host-records.csv -args @{_object='record:host'} Download a CSV export of all host records using the 'csv_export' fileop function. .LINK Project: https://github.com/rmbolger/Posh-IBWAPI .LINK Invoke-IBFunction #> } |