-
Ensure you have PowerShell v7.3+ installed
-
Install options
Install-Module AVIREST
Copy the contents of this folder to a unique module directory
Eg.
%userprofile%Documents\PowerShell\Modules\AviRest
-
Review the Examples Readme
-
Import the module
Import-Module AviRest
-
Connect to an ALB
Eg.
Connect-AVIRest -Server $albFQDN -Credential $credential
Eg.
Connect-AVIRest -Server $albFQDN -Username $username -Password $password
-
Review available cmdlets
Get-Command -Module AviRest
This module is targetted at traditional PowerShell users. If you are comfortable referencing the API guide for each command, the AviPowerShellSDK is available.
- This module provides a cmdlet for each API method and endpoint offering easy discovery using
Get-Command -Module AviRest
or TAB completion - Support for
Get-Help
demonstrating available parameter snippets - Support for dynamically building API JSON body without referencing the API guide and crafting a 100 property object using
New-AviRest*Object
where*
is any endpoint. UseGet-Command -Module AviRest -Name 'New-AVIRest*Object'
to find all cmdlets - Pipeline support with type enforcement. Aka
New-AviRestvsvip | Remove-AviRestvsvip
will work butNew-AviRestvsvip | Remove-AviRestvsGS
will not. - API Revision cmdlet enforcement based on connected ALB. Unsupported cmdlets will throw and error based on API revision.
- HTTP query support on
Get-AviRest*
cmdlets including-Name
,-First
,-Fields
,