SophosFirewall.Diagnostics.psd1
|
@{ RootModule = 'SophosFirewall.Diagnostics.psm1' ModuleVersion = '1.4.1' GUID = '799d548b-6bac-4c7a-931d-bfd62e10bee3' Author = 'Jan Weis' Description = '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 dashboard (service status, firewall health check, system usage graphs), and running commands on the appliance device console. Intended for administrators who need to open a temporary support channel, review recent log or system activity, or reach the device console without a physical or serial connection.' PowerShellVersion = '5.1' CompatiblePSEditions = @('Desktop', 'Core') RequiredModules = @( @{ ModuleName = 'SophosFirewall.Core' ModuleVersion = '1.4.1' } ) FormatsToProcess = @('SophosFirewall.Diagnostics.Format.ps1xml') FunctionsToExport = @( 'Enter-SfosCliConsole', 'Export-SfosLog', 'Get-SfosControlCenter', 'Get-SfosHealthCheck', 'Get-SfosHealthCheckSummary', 'Get-SfosLog', 'Get-SfosLogCategory', 'Get-SfosServiceStatus', 'Get-SfosSupportAccess', 'Get-SfosSystemGraph', 'Import-SfosLog', 'Invoke-SfosCliConsoleCommand', 'Set-SfosHealthCheckOverride', 'Set-SfosSupportAccess' ) CmdletsToExport = @() VariablesToExport = @() AliasesToExport = @() PrivateData = @{ PSData = @{ Tags = @('Sophos', 'Firewall', 'API', 'XGS', 'SFOS', 'Diagnostics', 'SupportAccess', 'LogViewer') LicenseUri = 'https://github.com/janweis/SophosFirewall-PowerShell/blob/main/Modules/SophosFirewall.Diagnostics/LICENSE.txt' ProjectUri = 'https://github.com/janweis/SophosFirewall-PowerShell/tree/main/Modules/SophosFirewall.Diagnostics' ReleaseNotes = '1.4.1: Reads the health assessment and the control center figures that the XML API does not expose. Get-SfosHealthCheck lists the compliance checks of the firewall with severity, standard and status; Get-SfosHealthCheckSummary aggregates them, and Set-SfosHealthCheckOverride marks a single check as accepted, which also hides a real deficit from the summary. Get-SfosServiceStatus lists every system service with its state, or the overall verdict with -Overall. Get-SfosSystemGraph returns the CPU, memory, load average, connection and throughput series of the control center for four time ranges, including current, minimum, maximum and average per series. Get-SfosControlCenter answers the whole dashboard in a single request: uptime, processor cores, live and remote users, wireless access points, Security Heartbeat, firewall rule counts, traffic counters and RED status. Fixed: Enter-SfosCliConsole could wait indefinitely with no output and no error when run in a host that has no real keyboard input, such as redirected input or a non-interactive script call; it now checks for that before opening a session and fails immediately with a clear message. New -DeviceConsole switch on Enter-SfosCliConsole selects the device console automatically after connecting, so the session starts at the console prompt instead of at the main menu.' } } } |