Public/New-F5Session.ps1
|
Function New-F5Session{ <# .SYNOPSIS Generate an F5 session object to be used in querying and modifying the F5 LTM .DESCRIPTION This function takes the DNS name or IP address of the F5 LTM device, and a PSCredential credential object for a user with permissions to work with the REST API. Based on the scope value, it either returns the session object (local scope) or adds the session object to the script scope #> [cmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] param( [Parameter(Mandatory=$true)][string]$LTMName, [Parameter(Mandatory=$true)][System.Management.Automation.PSCredential]$LTMCredentials, [switch]$Default, [switch]$PassThrough ) $BaseURL = "https://$LTMName/mgmt/tm/ltm/" $session = New-Object Microsoft.PowerShell.Commands.WebRequestSession #First we attempt to get an auth token. We need an auth token to do anything, include getting the LTM version, for LTMs using external auth. #If we fail to get an auth token, that means the version is prior to 11.6, so we fall back on basic auth $AuthURL = "https://$LTMName/mgmt/shared/authn/login"; $JSONBody = @{username = $LTMCredentials.username; password=$LTMCredentials.GetNetworkCredential().password; loginProviderName='tmos'} | ConvertTo-Json Try { $Result = Invoke-RestMethodOverride -Method POST -Uri $AuthURL -Body $JSONBody -Credential $LTMCredentials -ContentType 'application/json' $Token = $Result.token.token $session.Headers.Add('X-F5-Auth-Token', $Token) # Add token expiration time to session $ts = New-TimeSpan -Minutes 20 $date = Get-Date -Date $Result.token.startTime $ExpirationTime = $date + $ts $session.Headers.Add('Token-Expiration', $ExpirationTime) } Catch { Write-Verbose "The version must be prior to 11.6 since we failed to retrieve an auth token." $session.Credentials = $LTMCredentials } $newSession = [pscustomobject]@{ Name = $LTMName BaseURL = $BaseURL WebSession = $session } | Add-Member -Name GetLink -MemberType ScriptMethod { param($Link) $Link -replace 'localhost', $this.Name } -PassThru #If the Default switch is set, and/or if no script-scoped F5Session exists, then set the script-scoped F5Session If ($Default -or !($Script:F5Session)){ $Script:F5Session = $newSession } #If the Passthrough switch is set, then return the created F5Session object. If ($PassThrough){ $newSession } } |