Publish-20240919-105900/PowerPAN/Public/Device/Update-PanDeviceVsys.ps1
|
function Update-PanDeviceVsys { <# .SYNOPSIS Updates the PanDevice vsys layout within PanDeviceDb. .DESCRIPTION Updates to the vsys layout do not persist across PowerShell sessions. The setting/layout is not saved to disk and is updated (refreshed) at runtime. .NOTES .INPUTS PanDevice[] You can pipe a PanDevice to this cmdlet .OUTPUTS None .EXAMPLE #> [CmdletBinding(SupportsShouldProcess,ConfirmImpact='Low')] param( [parameter( Mandatory=$true, ValueFromPipeline=$true, HelpMessage='PanDevice(s) on which vsys layout will be determined and then PanDeviceDb updated')] [PanDevice[]] $Device ) Begin { # Propagate -Debug and -Verbose to this module function, https://tinyurl.com/y5dcbb34 if($PSBoundParameters.Debug) { $DebugPreference = 'Continue' } if($PSBoundParameters.Verbose) { $VerbosePreference = 'Continue' } # Announce Write-Debug ($MyInvocation.MyCommand.Name + ':') # Initialize PanDeviceDb Initialize-PanDeviceDb } # Begin block Process { foreach($DeviceCur in $Device) { Write-Debug ($MyInvocation.MyCommand.Name + ': Device: ' + $DeviceCur.Name) if($DeviceCur.VsysUpdated -eq $true) { # If PanDevice has been updated this PowerShell session, no need to update again Write-Debug ($MyInvocation.MyCommand.Name + ': Device updated already') continue } # https://live.paloaltonetworks.com/t5/automation-api-discussions/retrieve-device-list-and-vsys-names-using-pan-rest-api/m-p/15238 $XPath = "/config/devices/entry[@name='localhost.localdomain']/vsys/entry/@name" $DeviceCurVsysAgg = @() # Fetch a list of vsys names (not display-name) $PanResponse = Invoke-PanXApi -Device $DeviceCur -Config -Get -XPath $XPath if($PanResponse.Status -eq 'success') { foreach($EntryCur in $PanResponse.Result.entry) { # Add each entry's name to an aggregate. In most firewalls there is a single entry with name 'vsys1' $DeviceCurVsysAgg += $EntryCur.name } # Update the PanDevice in PanDeviceDb if($PSCmdlet.ShouldProcess('PanDeviceDb','Update ' + $DeviceCur.Name + ' vsys layout')) { $DeviceCur.Vsys = $DeviceCurVsysAgg $DeviceCur.VsysUpdated = $true } } } } # Process block End { } # End block } # Function |