PowerShell module for the F5 LTM REST API

Do I need special permissions in F5 to be able to run PS commands?

I am able to get a session

PS C:\Windows\system32> $F5session = New-F5Session -LTMName 192.168.XXX.XXX -LTMCredentials $mycredentials -Passthrough

PS C:\Windows\system32> $F5session

Name

BaseURL

WebSession

----

-------

----------

192.168.XXX.XXX

https://192.168.XXX.XXX/mgmt/tm/ltm/

Microsoft.PowerShell.Commands.WebReq...

but when I try get-pool, i get this

PS C:\Windows\system32> Get-Pool $F5session
Invoke-RestMethodOverride : "401 F5 Authorization Required: Authorization failed:
user=https://localhost/mgmt/shared/authz/users/Mayur.Kirtani resource=/mgmt/tm/ltm/pool verb=GET
uri:http://localhost:8100/mgmt/tm/ltm/pool/ referrer:10.XXX.XXX.XXX sender:10.XXX.XXX.XXX
At C:\windows\system32\windowspowershell\v1.0\Modules\F5-LTM\Public\Get-Pool.ps1:32 char:21
+             $JSON = Invoke-RestMethodOverride -Method Get -Uri $URI -WebSession  ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,Invoke-RestMethodOverride

am i missing something?

thanks M

Hi, Mayur,

You'll need tmsh terminal access to be able to successfully make calls against the iControlREST API. I'd recommend checking your user permissions in the F5 and seeing if this is enabled.

Cheers, Joel

I would first like to say this is awesome, great work! I was able to easily deploy a node in about 5 minutes of scripting development. I don't know if this is on the roadmap or not but would be very useful for me is a way to deploy an entire iApp using something like this. I have went through the documentation Here: which was pretty good at explaining some of the REST options but didn't seem to have a good way of showing how to add members to a pool since those parts are truncated. I have a custom iApp that I have created that I use for most of my HTTP deployments. I am looking for an easier way to deploy VIPs in our HQ and DR environments at the same time if possible in a more automated fashion. It looks like REST will do it, is there a really good article on the API, possibly with complete examples someone could point me to?

Thanks! Buddy

Hi, Buddy. Thanks for the kind words! I haven't used iApps for anything, so I've been relying on others' experience and contributions to get iApp support into the module. The best way to get something on the roadmap for the module is to open an issue in the github repo, so if this is something you'd like to see added, please consider doing that. Thanks!

Cheers, Joel

This worked when I initially installed the module. And now it is not working.

PS C:> import-module -name f5-ltm PS C:> $secpasswd = ConvertTo-SecureString "MYPASSWORD" -AsPlainText -Force PS C:> $mycreds = New-Object System.Management.Automation.PSCredential "admin", $secpasswd PS C:> PS C:> $MyLTM_IP=”MYIP” PS C:> $F5Sess= New-F5Session -LTMName $MyLTM_IP -LTMCredentials $MyCreds –PassThru PS C:> $F5Sess

Name BaseURL Credential WebSession

MYIP System.Management.Automation.PSCredential Microsoft.PowerShell.Commands.WebRequestSessi

PS C:> get-virtualserver -F5Session $F5Sess ConvertFrom-json : Invalid JSON primitive: Document. At C:\Program Files\WindowsPowerShell\Modules\f5-ltm\1.4.110\Private\Invoke-F5RestMethod.ps1:39 char:50 + ... $message = $_.ErrorDetails.Message | ConvertFrom-json | Selec ... + ~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [ConvertFrom-Json], ArgumentException + FullyQualifiedErrorId : System.ArgumentException,Microsoft.PowerShell.Commands.ConvertFromJsonCommand

I get a convertfrom-json issue with pretty much any get command I try.

Hi, bujnovskyd, what version of the LTM do you have, and are you using local authentication or external (i.e. AD or something)?

Well it is working today again. Hurray. FYI updated to f5-ltm 1.4.111 today. F5 is Version 12.1.1 Build 2.0.204 Hotfix HF2 and I am using local Authentication on the F5.

Not sure what was happening yesterday, and maybe a local computer reboot helped?

Thank you for the quick response and all of your hard work on this module.

You're welcome, and I'm glad to hear it's working again.

All the best, Joel

Ok, when I run

New-F5Session -LTMName 0.0.0.0 -LTMCredentials $cred

I get nothing back to let me know the session.

If you want your session returned, you need to use -PassThru. Otherwise it gets assigned to the Script scope.