SophosFirewall.Diagnostics

1.4.0

PowerShell module for the MONITOR & ANALYZE > Diagnostics area of Sophos XGS / SFOS 22.0 firewalls: remote support access, read-only access to the web admin console log viewer, and running commands on the appliance device console. Intended for administrators who need to open a temporary support channel, review recent log activity, or reach the device console without a
PowerShell module for the MONITOR & ANALYZE > Diagnostics area of Sophos XGS / SFOS 22.0 firewalls: remote support access, read-only access to the web admin console log viewer, and running commands on the appliance device console. Intended for administrators who need to open a temporary support channel, review recent log activity, or reach the device console without a physical or serial connection.
Show more

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name SophosFirewall.Diagnostics

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name SophosFirewall.Diagnostics

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Package Details

Author(s)

  • Jan Weis

Tags

Sophos Firewall API XGS SFOS Diagnostics SupportAccess LogViewer

Functions

Get-SfosSupportAccess Set-SfosSupportAccess Get-SfosLog Get-SfosLogCategory Export-SfosLog Import-SfosLog Invoke-SfosCliCommand Enter-SfosCliConsole

PSEditions

Desktop Core

Dependencies

Release Notes

1.4.0: Turns log retrieval into an analysis tool. Get-SfosLog and Get-SfosLogCategory read the web admin console's log viewer, which the XML API does not expose. 28 field filters are available; each accepts multiple values combined with OR, different filters combine with AND, and each has a matching -Exclude... counterpart. -AnyIP and -AnyPort match either the source or the destination side, while -SourceIP/-DestinationIP and -SourcePort/-DestinationPort match one side only. New -Protocol and -Text filters; -Text searches every field value at once and never the field names. Export-SfosLog and Import-SfosLog capture a set of log entries to a file so it can be filtered repeatedly offline, without querying the appliance again; the captured file records when and from what it was taken, and whether a filter was already applied during capture. Invoke-SfosCliCommand and Enter-SfosCliConsole give access to the device console; Invoke-SfosCliCommand asks for confirmation before running a command, because the console executes commands without a confirmation step of its own. Fixed: filtered log queries could lose matching entries when a request came back short of the requested count and was retried with a broader query; this affected every filter and was most visible with the text search. Empty and unreadable entries returned by the appliance are now discarded instead of surfacing as binding errors.

FileList

Version History

Version Downloads Last updated
1.4.0 (current version) 6 8/22/2026