Add port forwarding support, improve XML documentation, and add unit tests

docs/Alias-Management.md

@@ -0,0 +1,120 @@
+# Alias Management
+
+This document describes how to use the alias management cmdlets in the PSOPNSenseAPI module.
+
+## Overview
+
+Aliases in OPNSense are named lists of networks, hosts, ports, or URLs that can be used in firewall rules. Using aliases makes it easier to manage firewall rules, as you can update the alias content without having to modify the rules that use it.
+
+The PSOPNSenseAPI module provides cmdlets for managing aliases:
+
+- `Get-OPNSenseAlias`: Retrieves aliases from an OPNSense firewall
+- `New-OPNSenseAlias`: Creates a new alias on an OPNSense firewall
+- `Set-OPNSenseAlias`: Updates an alias on an OPNSense firewall
+- `Remove-OPNSenseAlias`: Removes an alias from an OPNSense firewall
+
+## Alias Types
+
+OPNSense supports several types of aliases:
+
+- `host`: A list of IP addresses
+- `network`: A list of networks in CIDR notation
+- `port`: A list of port numbers
+- `url`: A URL that points to a list of IPs or networks
+- `urltable`: A URL that points to a table of IPs or networks
+- `geoip`: A list of country codes for GeoIP filtering
+- `networkgroup`: A group of networks
+- `mac`: A list of MAC addresses
+- `interface`: A list of network interfaces
+- `dynipv6host`: A list of dynamic IPv6 hosts
+- `internal`: Special internal aliases
+- `external`: Special external aliases
+
+## Examples
+
+### Getting Aliases
+
+```powershell
+# Get all aliases
+Get-OPNSenseAlias
+
+# Get a specific alias by UUID
+Get-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f"
+
+# Get a specific alias by name
+Get-OPNSenseAlias -Name "WebServers"
+
+# Get all host aliases
+Get-OPNSenseAlias -Type host
+
+# Get all port aliases
+Get-OPNSenseAlias -Type port
+```
+
+### Creating Aliases
+
+```powershell
+# Create a host alias
+New-OPNSenseAlias -Name "WebServers" -Type host -Content "192.168.1.10,192.168.1.11" -Description "Web Servers" -Apply
+
+# Create a network alias
+New-OPNSenseAlias -Name "InternalNetworks" -Type network -Content "192.168.1.0/24,192.168.2.0/24" -Description "Internal Networks" -Apply
+
+# Create a port alias
+New-OPNSenseAlias -Name "WebPorts" -Type port -Content "80,443" -Protocol TCP -Description "Web Ports" -Apply
+
+# Create a URL alias
+New-OPNSenseAlias -Name "BlockList" -Type url -Content "https://example.com/blocklist.txt" -UpdateFrequency 1 -Description "Block List" -Apply
+```
+
+### Updating Aliases
+
+```powershell
+# Update an alias's content
+Set-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Content "192.168.1.10,192.168.1.11,192.168.1.12" -Apply
+
+# Update an alias's description
+Set-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Description "Updated description" -Apply
+
+# Disable an alias
+Set-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Disabled -Apply
+
+# Enable an alias
+Set-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Enabled -Apply
+
+# Enable counters for an alias
+Set-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -EnableCounters -Apply
+```
+
+### Removing Aliases
+
+```powershell
+# Remove an alias by UUID
+Remove-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Apply
+
+# Remove an alias with confirmation
+Remove-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Confirm -Apply
+
+# Remove an alias without confirmation
+Remove-OPNSenseAlias -Uuid "9e4ec4f0-9dd1-4fa3-8c1d-8a8e9d772b0f" -Force -Apply
+
+# Remove aliases by pipeline
+Get-OPNSenseAlias -Type host | Remove-OPNSenseAlias -Force -Apply
+```
+
+## Using Aliases in Firewall Rules
+
+Once you have created aliases, you can use them in firewall rules:
+
+```powershell
+# Create a firewall rule using aliases
+New-OPNSenseFirewallRule -Description "Allow Web Traffic" -Protocol TCP -SourceNet "InternalNetworks" -DestinationPort "WebPorts" -Action pass -Apply
+```
+
+## Best Practices
+
+1. **Use descriptive names**: Choose alias names that clearly indicate their purpose.
+2. **Use aliases for groups of objects**: Aliases are most useful when they group related objects.
+3. **Keep aliases organized**: Use a consistent naming convention for aliases.
+4. **Document aliases**: Use the description field to document the purpose of the alias.
+5. **Apply changes**: Always use the `-Apply` parameter to apply changes immediately, or apply them later using `Apply-OPNSenseFirewallChanges`.

docs/Cron-Job-Management.md

@@ -0,0 +1,326 @@
+# Cron Job Management
+
+This component provides cmdlets for managing cron jobs on OPNSense firewalls.
+
+## Overview
+
+The Cron Job Management component allows you to configure and manage scheduled tasks (cron jobs) on OPNSense firewalls. It provides cmdlets for creating, viewing, modifying, and deleting cron jobs.
+
+## Cmdlets
+
+### Get-OPNSenseCronJob
+
+Retrieves cron jobs from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of a specific cron job to retrieve. If not specified, all cron jobs are returned.
+- **Description** - Filter cron jobs by description.
+- **Command** - Filter cron jobs by command.
+
+#### Examples
+
+```powershell
+# Get all cron jobs
+Get-OPNSenseCronJob
+
+# Get a specific cron job by UUID
+Get-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Get cron jobs with a specific description
+Get-OPNSenseCronJob -Description "Backup"
+
+# Get cron jobs with a specific command
+Get-OPNSenseCronJob -Command "configctl"
+```
+
+### New-OPNSenseCronJob
+
+Creates a new cron job on an OPNSense firewall.
+
+#### Parameters
+
+- **Description** - A description for the cron job.
+- **Command** - The command to execute.
+- **Parameters** - The parameters for the command.
+- **Minute** - The minute(s) when the job should run (0-59, *, */5, etc.).
+- **Hour** - The hour(s) when the job should run (0-23, *, */2, etc.).
+- **Day** - The day(s) of the month when the job should run (1-31, *, */2, etc.).
+- **Month** - The month(s) when the job should run (1-12, *, */2, etc.).
+- **Weekday** - The weekday(s) when the job should run (0-7, *, etc., where 0 and 7 are Sunday).
+- **Enabled** - Whether the cron job is enabled. Default is true.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a daily backup cron job
+New-OPNSenseCronJob -Description "Daily Backup" -Command "configctl" -Parameters "system backup" -Minute "0" -Hour "2" -Day "*" -Month "*" -Weekday "*"
+
+# Create a weekly update cron job
+New-OPNSenseCronJob -Description "Weekly Update" -Command "configctl" -Parameters "firmware update" -Minute "0" -Hour "3" -Day "*" -Month "*" -Weekday "0"
+
+# Create a monthly log rotation cron job
+New-OPNSenseCronJob -Description "Monthly Log Rotation" -Command "configctl" -Parameters "system rotate" -Minute "0" -Hour "4" -Day "1" -Month "*" -Weekday "*"
+
+# Create a disabled cron job
+New-OPNSenseCronJob -Description "Temporary Job" -Command "configctl" -Parameters "system reboot" -Minute "0" -Hour "5" -Day "*" -Month "*" -Weekday "*" -Enabled:$false
+```
+
+### Set-OPNSenseCronJob
+
+Updates an existing cron job on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the cron job to update.
+- **Description** - A description for the cron job.
+- **Command** - The command to execute.
+- **Parameters** - The parameters for the command.
+- **Minute** - The minute(s) when the job should run (0-59, *, */5, etc.).
+- **Hour** - The hour(s) when the job should run (0-23, *, */2, etc.).
+- **Day** - The day(s) of the month when the job should run (1-31, *, */2, etc.).
+- **Month** - The month(s) when the job should run (1-12, *, */2, etc.).
+- **Weekday** - The weekday(s) when the job should run (0-7, *, etc., where 0 and 7 are Sunday).
+- **Enabled** - Whether the cron job is enabled.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated cron job.
+
+#### Examples
+
+```powershell
+# Update a cron job's description
+Set-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated Backup Job"
+
+# Update a cron job's schedule
+Set-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Minute "30" -Hour "3"
+
+# Update a cron job's command and parameters
+Set-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Command "configctl" -Parameters "system backup full"
+
+# Disable a cron job
+Set-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Enabled:$false
+
+# Update multiple properties of a cron job
+Set-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Full Backup" -Command "configctl" -Parameters "system backup full" -Minute "0" -Hour "1" -PassThru
+```
+
+### Remove-OPNSenseCronJob
+
+Removes a cron job from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the cron job to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a cron job
+Remove-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a cron job without confirmation
+Remove-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### Enable-OPNSenseCronJob
+
+Enables a cron job on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the cron job to enable.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated cron job.
+
+#### Examples
+
+```powershell
+# Enable a cron job
+Enable-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Enable a cron job and return the updated job
+Enable-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -PassThru
+```
+
+### Disable-OPNSenseCronJob
+
+Disables a cron job on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the cron job to disable.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated cron job.
+
+#### Examples
+
+```powershell
+# Disable a cron job
+Disable-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Disable a cron job and return the updated job
+Disable-OPNSenseCronJob -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -PassThru
+```
+
+### Apply-OPNSenseCronJobChanges
+
+Applies pending cron job changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply cron job changes
+Apply-OPNSenseCronJobChanges
+
+# Apply cron job changes without confirmation
+Apply-OPNSenseCronJobChanges -Force
+```
+
+## Common Scenarios
+
+### Basic Backup Schedule
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a daily backup cron job
+New-OPNSenseCronJob -Description "Daily Configuration Backup" -Command "configctl" -Parameters "system backup" -Minute "0" -Hour "2" -Day "*" -Month "*" -Weekday "*" -Force
+
+# Apply the changes
+Apply-OPNSenseCronJobChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Comprehensive Maintenance Schedule
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define maintenance jobs
+$cronJobs = @(
+    @{ Description = "Daily Backup"; Command = "configctl"; Parameters = "system backup"; Minute = "0"; Hour = "2"; Day = "*"; Month = "*"; Weekday = "*" },
+    @{ Description = "Weekly Full Backup"; Command = "configctl"; Parameters = "system backup full"; Minute = "0"; Hour = "3"; Day = "*"; Month = "*"; Weekday = "0" },
+    @{ Description = "Daily Log Rotation"; Command = "configctl"; Parameters = "system rotate"; Minute = "30"; Hour = "2"; Day = "*"; Month = "*"; Weekday = "*" },
+    @{ Description = "Weekly Update Check"; Command = "configctl"; Parameters = "firmware check"; Minute = "0"; Hour = "4"; Day = "*"; Month = "*"; Weekday = "1" },
+    @{ Description = "Monthly Cleanup"; Command = "configctl"; Parameters = "system cleanup"; Minute = "0"; Hour = "5"; Day = "1"; Month = "*"; Weekday = "*" }
+)
+
+# Create cron jobs
+foreach ($job in $cronJobs) {
+    New-OPNSenseCronJob -Description $job.Description -Command $job.Command -Parameters $job.Parameters -Minute $job.Minute -Hour $job.Hour -Day $job.Day -Month $job.Month -Weekday $job.Weekday -Force
+}
+
+# Apply the changes
+Apply-OPNSenseCronJobChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Existing Cron Jobs
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all cron jobs
+$cronJobs = Get-OPNSenseCronJob
+
+# Update backup jobs to run at a different time
+$backupJobs = $cronJobs | Where-Object { $_.Description -like "*Backup*" }
+foreach ($job in $backupJobs) {
+    Set-OPNSenseCronJob -Uuid $job.Uuid -Hour "4" -Force
+    Write-Output "Updated job: $($job.Description) to run at 4:00 AM"
+}
+
+# Disable temporary jobs
+$tempJobs = $cronJobs | Where-Object { $_.Description -like "*Temporary*" }
+foreach ($job in $tempJobs) {
+    Disable-OPNSenseCronJob -Uuid $job.Uuid -Force
+    Write-Output "Disabled job: $($job.Description)"
+}
+
+# Remove obsolete jobs
+$obsoleteJobs = $cronJobs | Where-Object { $_.Description -like "*Obsolete*" }
+foreach ($job in $obsoleteJobs) {
+    Remove-OPNSenseCronJob -Uuid $job.Uuid -Force
+    Write-Output "Removed job: $($job.Description)"
+}
+
+# Apply the changes
+Apply-OPNSenseCronJobChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Scheduling Network Tests
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define network test jobs
+$testJobs = @(
+    @{ Description = "Hourly Gateway Ping"; Command = "configctl"; Parameters = "gateway pingall"; Minute = "0"; Hour = "*"; Day = "*"; Month = "*"; Weekday = "*" },
+    @{ Description = "Daily DNS Test"; Command = "configctl"; Parameters = "system dns test"; Minute = "15"; Hour = "*/6"; Day = "*"; Month = "*"; Weekday = "*" },
+    @{ Description = "Weekly Network Diagnostics"; Command = "configctl"; Parameters = "system diagnostics"; Minute = "30"; Hour = "5"; Day = "*"; Month = "*"; Weekday = "0" }
+)
+
+# Create cron jobs
+foreach ($job in $testJobs) {
+    New-OPNSenseCronJob -Description $job.Description -Command $job.Command -Parameters $job.Parameters -Minute $job.Minute -Hour $job.Hour -Day $job.Day -Month $job.Month -Weekday $job.Weekday -Force
+}
+
+# Apply the changes
+Apply-OPNSenseCronJobChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Scheduling Firewall Reboots
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a monthly reboot cron job
+New-OPNSenseCronJob -Description "Monthly Maintenance Reboot" -Command "configctl" -Parameters "system reboot" -Minute "0" -Hour "3" -Day "15" -Month "*" -Weekday "*" -Force
+
+# Apply the changes
+Apply-OPNSenseCronJobChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Cron job changes are not applied until you call `Apply-OPNSenseCronJobChanges`.
+- The cron job schedule uses the standard cron format:
+  - **Minute**: 0-59, *, */5 (every 5 minutes), etc.
+  - **Hour**: 0-23, *, */2 (every 2 hours), etc.
+  - **Day**: 1-31, *, */2 (every 2 days), etc.
+  - **Month**: 1-12, *, */2 (every 2 months), etc.
+  - **Weekday**: 0-7, * (where 0 and 7 are Sunday), etc.
+- The `*` character means "every" (e.g., every minute, every hour, etc.).
+- The `*/n` format means "every n" (e.g., every 5 minutes, every 2 hours, etc.).
+- Multiple values can be specified with commas (e.g., "1,3,5" for 1st, 3rd, and 5th).
+- Ranges can be specified with hyphens (e.g., "1-5" for 1st through 5th).
+- The `Command` parameter typically uses `configctl` for OPNSense system commands.
+- Consider using the `-PassThru` parameter when updating cron jobs to verify the changes.
+- Cron job descriptions should be descriptive and follow a consistent naming convention.
+- Be careful when scheduling system reboots, as they will interrupt all services.
+- Cron jobs run with system privileges, so they can execute any command available to the system.
+- For complex schedules, consider using multiple cron jobs instead of a single job with a complex schedule.

docs/DHCP-Management.md

@@ -0,0 +1,393 @@
+# DHCP Management
+
+This component provides cmdlets for managing DHCP servers and leases on OPNSense firewalls.
+
+## Overview
+
+The DHCP Management component allows you to configure and manage DHCP servers on OPNSense firewalls. It provides cmdlets for creating, viewing, modifying, and deleting DHCP servers, as well as managing DHCP leases and static mappings.
+
+## Cmdlets
+
+### Get-OPNSenseDHCPServer
+
+Retrieves DHCP server configurations from an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface to get the DHCP server configuration for. If not specified, all DHCP servers are returned.
+
+#### Examples
+
+```powershell
+# Get all DHCP servers
+Get-OPNSenseDHCPServer
+
+# Get the DHCP server for a specific interface
+Get-OPNSenseDHCPServer -Interface "lan"
+```
+
+### New-OPNSenseDHCPServer
+
+Creates a new DHCP server on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface to create the DHCP server on.
+- **Enabled** - Whether the DHCP server is enabled. Default is true.
+- **RangeFrom** - The starting IP address of the DHCP range.
+- **RangeTo** - The ending IP address of the DHCP range.
+- **Domain** - The domain name to provide to DHCP clients.
+- **DnsServers** - The DNS servers to provide to DHCP clients.
+- **GatewayIP** - The gateway IP address to provide to DHCP clients.
+- **LeaseTime** - The lease time in seconds. Default is 86400 (1 day).
+- **DenyUnknownClients** - Whether to deny unknown clients. Default is false.
+- **IgnoreClientIdentifiers** - Whether to ignore client identifiers. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic DHCP server
+New-OPNSenseDHCPServer -Interface "lan" -RangeFrom "192.168.1.100" -RangeTo "192.168.1.200" -Domain "example.com" -DnsServers "192.168.1.1","8.8.8.8" -GatewayIP "192.168.1.1"
+
+# Create a DHCP server with advanced options
+New-OPNSenseDHCPServer -Interface "opt1" -RangeFrom "10.0.0.100" -RangeTo "10.0.0.200" -Domain "internal.example.com" -DnsServers "10.0.0.1","8.8.4.4" -GatewayIP "10.0.0.1" -LeaseTime 43200 -DenyUnknownClients -Force
+```
+
+### Set-OPNSenseDHCPServer
+
+Updates an existing DHCP server on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface of the DHCP server to update.
+- **Enabled** - Whether the DHCP server is enabled.
+- **RangeFrom** - The starting IP address of the DHCP range.
+- **RangeTo** - The ending IP address of the DHCP range.
+- **Domain** - The domain name to provide to DHCP clients.
+- **DnsServers** - The DNS servers to provide to DHCP clients.
+- **GatewayIP** - The gateway IP address to provide to DHCP clients.
+- **LeaseTime** - The lease time in seconds.
+- **DenyUnknownClients** - Whether to deny unknown clients.
+- **IgnoreClientIdentifiers** - Whether to ignore client identifiers.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated DHCP server.
+
+#### Examples
+
+```powershell
+# Update a DHCP server's range
+Set-OPNSenseDHCPServer -Interface "lan" -RangeFrom "192.168.1.50" -RangeTo "192.168.1.150"
+
+# Update a DHCP server's DNS servers
+Set-OPNSenseDHCPServer -Interface "opt1" -DnsServers "10.0.0.1","1.1.1.1"
+
+# Update multiple properties of a DHCP server
+Set-OPNSenseDHCPServer -Interface "lan" -Domain "updated.example.com" -LeaseTime 43200 -DenyUnknownClients -PassThru
+```
+
+### Remove-OPNSenseDHCPServer
+
+Removes a DHCP server from an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface of the DHCP server to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a DHCP server
+Remove-OPNSenseDHCPServer -Interface "opt1"
+
+# Remove a DHCP server without confirmation
+Remove-OPNSenseDHCPServer -Interface "opt1" -Force
+```
+
+### Get-OPNSenseDHCPLease
+
+Retrieves DHCP leases from an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface to get DHCP leases for. If not specified, leases for all interfaces are returned.
+- **MACAddress** - Filter leases by MAC address.
+- **IPAddress** - Filter leases by IP address.
+- **Hostname** - Filter leases by hostname.
+- **Status** - Filter leases by status (active, expired, etc.).
+
+#### Examples
+
+```powershell
+# Get all DHCP leases
+Get-OPNSenseDHCPLease
+
+# Get DHCP leases for a specific interface
+Get-OPNSenseDHCPLease -Interface "lan"
+
+# Get DHCP leases for a specific MAC address
+Get-OPNSenseDHCPLease -MACAddress "00:11:22:33:44:55"
+
+# Get active DHCP leases
+Get-OPNSenseDHCPLease -Status "active"
+```
+
+### New-OPNSenseDHCPStaticMapping
+
+Creates a new DHCP static mapping on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface to create the static mapping on.
+- **MACAddress** - The MAC address of the client.
+- **IPAddress** - The IP address to assign to the client.
+- **Hostname** - The hostname of the client.
+- **Description** - A description for the static mapping.
+- **Enabled** - Whether the static mapping is enabled. Default is true.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic static mapping
+New-OPNSenseDHCPStaticMapping -Interface "lan" -MACAddress "00:11:22:33:44:55" -IPAddress "192.168.1.50" -Hostname "printer" -Description "Office Printer"
+
+# Create a static mapping without confirmation
+New-OPNSenseDHCPStaticMapping -Interface "opt1" -MACAddress "AA:BB:CC:DD:EE:FF" -IPAddress "10.0.0.10" -Hostname "server" -Description "File Server" -Force
+```
+
+### Set-OPNSenseDHCPStaticMapping
+
+Updates an existing DHCP static mapping on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface of the static mapping to update.
+- **MACAddress** - The MAC address of the static mapping to update.
+- **IPAddress** - The IP address to assign to the client.
+- **Hostname** - The hostname of the client.
+- **Description** - A description for the static mapping.
+- **Enabled** - Whether the static mapping is enabled.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated static mapping.
+
+#### Examples
+
+```powershell
+# Update a static mapping's IP address
+Set-OPNSenseDHCPStaticMapping -Interface "lan" -MACAddress "00:11:22:33:44:55" -IPAddress "192.168.1.60"
+
+# Update a static mapping's description
+Set-OPNSenseDHCPStaticMapping -Interface "opt1" -MACAddress "AA:BB:CC:DD:EE:FF" -Description "Updated File Server"
+
+# Update multiple properties of a static mapping
+Set-OPNSenseDHCPStaticMapping -Interface "lan" -MACAddress "00:11:22:33:44:55" -IPAddress "192.168.1.70" -Hostname "new-printer" -Description "New Office Printer" -PassThru
+```
+
+### Remove-OPNSenseDHCPStaticMapping
+
+Removes a DHCP static mapping from an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface of the static mapping to remove.
+- **MACAddress** - The MAC address of the static mapping to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a static mapping
+Remove-OPNSenseDHCPStaticMapping -Interface "lan" -MACAddress "00:11:22:33:44:55"
+
+# Remove a static mapping without confirmation
+Remove-OPNSenseDHCPStaticMapping -Interface "opt1" -MACAddress "AA:BB:CC:DD:EE:FF" -Force
+```
+
+### Apply-OPNSenseDHCPChanges
+
+Applies pending DHCP changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply DHCP changes
+Apply-OPNSenseDHCPChanges
+
+# Apply DHCP changes without confirmation
+Apply-OPNSenseDHCPChanges -Force
+```
+
+## Common Scenarios
+
+### Basic DHCP Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a DHCP server for the LAN interface
+New-OPNSenseDHCPServer -Interface "lan" -RangeFrom "192.168.1.100" -RangeTo "192.168.1.200" -Domain "example.com" -DnsServers "192.168.1.1","8.8.8.8" -GatewayIP "192.168.1.1" -Force
+
+# Apply the changes
+Apply-OPNSenseDHCPChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Static Mappings
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create static mappings for important devices
+$staticMappings = @(
+    @{ MACAddress = "00:11:22:33:44:55"; IPAddress = "192.168.1.10"; Hostname = "printer"; Description = "Office Printer" },
+    @{ MACAddress = "AA:BB:CC:DD:EE:FF"; IPAddress = "192.168.1.20"; Hostname = "fileserver"; Description = "File Server" },
+    @{ MACAddress = "11:22:33:44:55:66"; IPAddress = "192.168.1.30"; Hostname = "nas"; Description = "Network Storage" }
+)
+
+foreach ($mapping in $staticMappings) {
+    New-OPNSenseDHCPStaticMapping -Interface "lan" -MACAddress $mapping.MACAddress -IPAddress $mapping.IPAddress -Hostname $mapping.Hostname -Description $mapping.Description -Force
+}
+
+# Apply the changes
+Apply-OPNSenseDHCPChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Converting DHCP Leases to Static Mappings
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get active DHCP leases
+$leases = Get-OPNSenseDHCPLease -Interface "lan" -Status "active"
+
+# Convert leases to static mappings
+foreach ($lease in $leases) {
+    New-OPNSenseDHCPStaticMapping -Interface "lan" -MACAddress $lease.MACAddress -IPAddress $lease.IPAddress -Hostname $lease.Hostname -Description "Converted from lease on $(Get-Date -Format 'yyyy-MM-dd')" -Force
+}
+
+# Apply the changes
+Apply-OPNSenseDHCPChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Multiple DHCP Servers
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define DHCP server configurations for different interfaces
+$dhcpConfigs = @(
+    @{
+        Interface = "lan";
+        RangeFrom = "192.168.1.100";
+        RangeTo = "192.168.1.200";
+        Domain = "internal.example.com";
+        DnsServers = @("192.168.1.1", "8.8.8.8");
+        GatewayIP = "192.168.1.1";
+        LeaseTime = 86400;
+    },
+    @{
+        Interface = "opt1";
+        RangeFrom = "10.0.0.100";
+        RangeTo = "10.0.0.200";
+        Domain = "guest.example.com";
+        DnsServers = @("10.0.0.1", "8.8.4.4");
+        GatewayIP = "10.0.0.1";
+        LeaseTime = 3600;
+        DenyUnknownClients = $true;
+    },
+    @{
+        Interface = "opt2";
+        RangeFrom = "172.16.0.100";
+        RangeTo = "172.16.0.200";
+        Domain = "iot.example.com";
+        DnsServers = @("172.16.0.1");
+        GatewayIP = "172.16.0.1";
+        LeaseTime = 86400;
+    }
+)
+
+# Create or update DHCP servers
+foreach ($config in $dhcpConfigs) {
+    $existing = Get-OPNSenseDHCPServer -Interface $config.Interface
+    
+    if ($existing) {
+        # Update existing DHCP server
+        $params = @{
+            Interface = $config.Interface
+            RangeFrom = $config.RangeFrom
+            RangeTo = $config.RangeTo
+            Domain = $config.Domain
+            DnsServers = $config.DnsServers
+            GatewayIP = $config.GatewayIP
+            LeaseTime = $config.LeaseTime
+            Force = $true
+        }
+        
+        if ($config.DenyUnknownClients) {
+            $params.Add("DenyUnknownClients", $true)
+        }
+        
+        Set-OPNSenseDHCPServer @params
+        Write-Output "Updated DHCP server for interface $($config.Interface)"
+    }
+    else {
+        # Create new DHCP server
+        $params = @{
+            Interface = $config.Interface
+            RangeFrom = $config.RangeFrom
+            RangeTo = $config.RangeTo
+            Domain = $config.Domain
+            DnsServers = $config.DnsServers
+            GatewayIP = $config.GatewayIP
+            LeaseTime = $config.LeaseTime
+            Force = $true
+        }
+        
+        if ($config.DenyUnknownClients) {
+            $params.Add("DenyUnknownClients", $true)
+        }
+        
+        New-OPNSenseDHCPServer @params
+        Write-Output "Created DHCP server for interface $($config.Interface)"
+    }
+}
+
+# Apply the changes
+Apply-OPNSenseDHCPChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- DHCP servers are configured per interface on OPNSense firewalls.
+- Changes to DHCP servers and static mappings are not applied until you call `Apply-OPNSenseDHCPChanges`.
+- When creating a DHCP server, ensure that the range is within the subnet of the interface.
+- Static mappings take precedence over dynamic leases.
+- The `DenyUnknownClients` option only allows clients with static mappings to receive DHCP leases.
+- The `IgnoreClientIdentifiers` option can help with clients that change their identifier between requests.
+- DHCP lease times are specified in seconds. Common values are:
+  - 3600 (1 hour)
+  - 43200 (12 hours)
+  - 86400 (1 day)
+  - 604800 (1 week)
+- Consider using the `-PassThru` parameter when updating DHCP servers or static mappings to verify the changes.

docs/DNS-Management.md

@@ -0,0 +1,411 @@
+# DNS Management
+
+This component provides cmdlets for managing DNS settings on OPNSense firewalls.
+
+## Overview
+
+The DNS Management component allows you to configure and manage DNS settings on OPNSense firewalls. It provides cmdlets for configuring DNS servers, DNS forwarders, DNS overrides, and DNS forwarding.
+
+## Cmdlets
+
+### Get-OPNSenseDNSServer
+
+Retrieves DNS server configurations from an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get DNS server configuration
+Get-OPNSenseDNSServer
+```
+
+### Set-OPNSenseDNSServer
+
+Updates the DNS server configuration on an OPNSense firewall.
+
+#### Parameters
+
+- **Enabled** - Whether the DNS server is enabled.
+- **ListenIPs** - The IP addresses to listen on.
+- **Port** - The port to listen on. Default is 53.
+- **DNSSECEnabled** - Whether DNSSEC is enabled.
+- **ForwardingEnabled** - Whether DNS forwarding is enabled.
+- **ForwardingServers** - The DNS servers to forward queries to.
+- **CacheEnabled** - Whether DNS caching is enabled.
+- **CacheSize** - The size of the DNS cache in MB.
+- **PrefetchEnabled** - Whether DNS prefetching is enabled.
+- **PrefetchDomains** - Whether to prefetch domains.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated DNS server configuration.
+
+#### Examples
+
+```powershell
+# Enable the DNS server
+Set-OPNSenseDNSServer -Enabled
+
+# Configure DNS forwarding
+Set-OPNSenseDNSServer -ForwardingEnabled -ForwardingServers "8.8.8.8","8.8.4.4"
+
+# Configure DNS caching
+Set-OPNSenseDNSServer -CacheEnabled -CacheSize 10 -PrefetchEnabled -PrefetchDomains
+
+# Configure DNS server with multiple options
+Set-OPNSenseDNSServer -Enabled -ListenIPs "192.168.1.1" -Port 53 -DNSSECEnabled -ForwardingEnabled -ForwardingServers "1.1.1.1","1.0.0.1" -CacheEnabled -CacheSize 20 -PrefetchEnabled -PassThru
+```
+
+### Get-OPNSenseDNSOverride
+
+Retrieves DNS overrides from an OPNSense firewall.
+
+#### Parameters
+
+- **Host** - Filter overrides by host.
+- **Domain** - Filter overrides by domain.
+- **IP** - Filter overrides by IP address.
+- **Description** - Filter overrides by description.
+
+#### Examples
+
+```powershell
+# Get all DNS overrides
+Get-OPNSenseDNSOverride
+
+# Get DNS overrides for a specific host
+Get-OPNSenseDNSOverride -Host "server"
+
+# Get DNS overrides for a specific domain
+Get-OPNSenseDNSOverride -Domain "example.com"
+```
+
+### New-OPNSenseDNSOverride
+
+Creates a new DNS override on an OPNSense firewall.
+
+#### Parameters
+
+- **Host** - The hostname to override.
+- **Domain** - The domain to override.
+- **IP** - The IP address to resolve to.
+- **Description** - A description for the override.
+- **Enabled** - Whether the override is enabled. Default is true.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a DNS override for a specific host
+New-OPNSenseDNSOverride -Host "server" -Domain "example.com" -IP "192.168.1.10" -Description "Internal Server"
+
+# Create a DNS override for a wildcard domain
+New-OPNSenseDNSOverride -Host "*" -Domain "example.com" -IP "192.168.1.20" -Description "All example.com hosts"
+
+# Create a DNS override without confirmation
+New-OPNSenseDNSOverride -Host "printer" -Domain "example.com" -IP "192.168.1.30" -Description "Office Printer" -Force
+```
+
+### Set-OPNSenseDNSOverride
+
+Updates an existing DNS override on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the DNS override to update.
+- **Host** - The hostname to override.
+- **Domain** - The domain to override.
+- **IP** - The IP address to resolve to.
+- **Description** - A description for the override.
+- **Enabled** - Whether the override is enabled.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated DNS override.
+
+#### Examples
+
+```powershell
+# Update a DNS override's IP address
+Set-OPNSenseDNSOverride -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -IP "192.168.1.15"
+
+# Update a DNS override's description
+Set-OPNSenseDNSOverride -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated Server"
+
+# Update multiple properties of a DNS override
+Set-OPNSenseDNSOverride -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Host "newserver" -Domain "example.com" -IP "192.168.1.20" -Description "New Server" -PassThru
+```
+
+### Remove-OPNSenseDNSOverride
+
+Removes a DNS override from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the DNS override to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a DNS override
+Remove-OPNSenseDNSOverride -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a DNS override without confirmation
+Remove-OPNSenseDNSOverride -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### Get-OPNSenseDNSForwarder
+
+Retrieves DNS forwarder configurations from an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get DNS forwarder configuration
+Get-OPNSenseDNSForwarder
+```
+
+### Set-OPNSenseDNSForwarder
+
+Updates the DNS forwarder configuration on an OPNSense firewall.
+
+#### Parameters
+
+- **Enabled** - Whether the DNS forwarder is enabled.
+- **ListenIPs** - The IP addresses to listen on.
+- **Port** - The port to listen on. Default is 53.
+- **Interfaces** - The interfaces to listen on.
+- **DNSSECEnabled** - Whether DNSSEC is enabled.
+- **RegdhcpStatic** - Whether to register DHCP static mappings.
+- **RegdhcpDynamic** - Whether to register DHCP leases.
+- **StrictBind** - Whether to use strict binding.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated DNS forwarder configuration.
+
+#### Examples
+
+```powershell
+# Enable the DNS forwarder
+Set-OPNSenseDNSForwarder -Enabled
+
+# Configure DNS forwarder interfaces
+Set-OPNSenseDNSForwarder -Interfaces "lan","opt1"
+
+# Configure DNS forwarder with DHCP registration
+Set-OPNSenseDNSForwarder -RegdhcpStatic -RegdhcpDynamic
+
+# Configure DNS forwarder with multiple options
+Set-OPNSenseDNSForwarder -Enabled -ListenIPs "192.168.1.1" -Port 53 -Interfaces "lan","opt1" -DNSSECEnabled -RegdhcpStatic -RegdhcpDynamic -StrictBind -PassThru
+```
+
+### Get-OPNSenseDNSForwarding
+
+Retrieves DNS forwarding configurations from an OPNSense firewall.
+
+#### Parameters
+
+- **Domain** - Filter forwarding by domain.
+- **Server** - Filter forwarding by server.
+- **Description** - Filter forwarding by description.
+
+#### Examples
+
+```powershell
+# Get all DNS forwarding configurations
+Get-OPNSenseDNSForwarding
+
+# Get DNS forwarding for a specific domain
+Get-OPNSenseDNSForwarding -Domain "example.com"
+```
+
+### New-OPNSenseDNSForwarding
+
+Creates a new DNS forwarding configuration on an OPNSense firewall.
+
+#### Parameters
+
+- **Domain** - The domain to forward.
+- **Server** - The server to forward to.
+- **Description** - A description for the forwarding.
+- **Enabled** - Whether the forwarding is enabled. Default is true.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a DNS forwarding for a specific domain
+New-OPNSenseDNSForwarding -Domain "example.com" -Server "192.168.1.10" -Description "Internal DNS"
+
+# Create a DNS forwarding for a domain to multiple servers
+New-OPNSenseDNSForwarding -Domain "example.org" -Server "192.168.1.10,192.168.1.11" -Description "Redundant DNS"
+
+# Create a DNS forwarding without confirmation
+New-OPNSenseDNSForwarding -Domain "example.net" -Server "192.168.1.12" -Description "External DNS" -Force
+```
+
+### Set-OPNSenseDNSForwarding
+
+Updates an existing DNS forwarding configuration on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the DNS forwarding to update.
+- **Domain** - The domain to forward.
+- **Server** - The server to forward to.
+- **Description** - A description for the forwarding.
+- **Enabled** - Whether the forwarding is enabled.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated DNS forwarding.
+
+#### Examples
+
+```powershell
+# Update a DNS forwarding's server
+Set-OPNSenseDNSForwarding -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Server "192.168.1.15"
+
+# Update a DNS forwarding's description
+Set-OPNSenseDNSForwarding -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated DNS"
+
+# Update multiple properties of a DNS forwarding
+Set-OPNSenseDNSForwarding -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Domain "new.example.com" -Server "192.168.1.20" -Description "New DNS" -PassThru
+```
+
+### Remove-OPNSenseDNSForwarding
+
+Removes a DNS forwarding configuration from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the DNS forwarding to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a DNS forwarding
+Remove-OPNSenseDNSForwarding -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a DNS forwarding without confirmation
+Remove-OPNSenseDNSForwarding -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### Apply-OPNSenseDNSChanges
+
+Applies pending DNS changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply DNS changes
+Apply-OPNSenseDNSChanges
+
+# Apply DNS changes without confirmation
+Apply-OPNSenseDNSChanges -Force
+```
+
+## Common Scenarios
+
+### Basic DNS Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Configure the DNS server
+Set-OPNSenseDNSServer -Enabled -ListenIPs "192.168.1.1" -ForwardingEnabled -ForwardingServers "1.1.1.1","1.0.0.1" -CacheEnabled -CacheSize 10 -Force
+
+# Apply the changes
+Apply-OPNSenseDNSChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### DNS Overrides for Internal Services
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create DNS overrides for internal services
+$dnsOverrides = @(
+    @{ Host = "www"; Domain = "example.com"; IP = "192.168.1.10"; Description = "Internal Web Server" },
+    @{ Host = "mail"; Domain = "example.com"; IP = "192.168.1.11"; Description = "Internal Mail Server" },
+    @{ Host = "files"; Domain = "example.com"; IP = "192.168.1.12"; Description = "Internal File Server" },
+    @{ Host = "*"; Domain = "internal.example.com"; IP = "192.168.1.13"; Description = "Internal Services" }
+)
+
+foreach ($override in $dnsOverrides) {
+    New-OPNSenseDNSOverride -Host $override.Host -Domain $override.Domain -IP $override.IP -Description $override.Description -Force
+}
+
+# Apply the changes
+Apply-OPNSenseDNSChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### DNS Forwarding for Specific Domains
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Configure DNS forwarding for specific domains
+$dnsForwarding = @(
+    @{ Domain = "example.com"; Server = "192.168.1.10"; Description = "Internal Domain" },
+    @{ Domain = "partner.com"; Server = "10.0.0.10"; Description = "Partner Domain" },
+    @{ Domain = "vendor.com"; Server = "172.16.0.10"; Description = "Vendor Domain" }
+)
+
+foreach ($forwarding in $dnsForwarding) {
+    New-OPNSenseDNSForwarding -Domain $forwarding.Domain -Server $forwarding.Server -Description $forwarding.Description -Force
+}
+
+# Apply the changes
+Apply-OPNSenseDNSChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing DNS Overrides
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all DNS overrides
+$overrides = Get-OPNSenseDNSOverride
+
+# Update all overrides for a specific domain
+$overrides | Where-Object { $_.Domain -eq "example.com" } | ForEach-Object {
+    Set-OPNSenseDNSOverride -Uuid $_.Uuid -IP "192.168.2.$($_.IP.Split('.')[-1])" -Description "$($_.Description) (Migrated)" -Force
+    Write-Output "Updated override: $($_.Host).$($_.Domain)"
+}
+
+# Remove all overrides with "Temporary" in the description
+$overrides | Where-Object { $_.Description -like "*Temporary*" } | ForEach-Object {
+    Remove-OPNSenseDNSOverride -Uuid $_.Uuid -Force
+    Write-Output "Removed override: $($_.Host).$($_.Domain)"
+}
+
+# Apply the changes
+Apply-OPNSenseDNSChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- DNS changes are not applied until you call `Apply-OPNSenseDNSChanges`.
+- DNS overrides take precedence over DNS forwarding.
+- When using DNS forwarding, ensure that the forwarded domains are accessible from the OPNSense firewall.
+- DNS caching can improve performance by reducing the number of external DNS queries.
+- DNSSEC provides additional security by validating DNS responses.
+- Consider using the `-PassThru` parameter when updating DNS configurations to verify the changes.
+- Wildcard DNS overrides (using "*" as the host) can be used to override all subdomains of a domain.
+- DNS forwarding can be used to direct queries for specific domains to internal or external DNS servers.

docs/Development-Guidelines.md

@@ -0,0 +1,238 @@
+# Development and Contribution Guidelines
+
+This document provides guidelines for developing and contributing to the PSOPNSenseAPI module.
+
+## Development Environment Setup
+
+### Prerequisites
+
+- Visual Studio 2019 or later
+- PowerShell 5.1 or PowerShell 7+
+- .NET Framework 4.7.2 SDK (for Windows PowerShell 5.1 compatibility)
+- .NET Core 3.1 SDK or later (for PowerShell 7+ compatibility)
+- Git
+
+### Setting Up the Development Environment
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/freedbygrace/PSOPNSenseAPI.git
+   cd PSOPNSenseAPI
+   ```
+
+2. Open the solution in Visual Studio:
+   ```
+   start PSOPNSenseAPI.sln
+   ```
+
+3. Restore NuGet packages:
+   ```
+   dotnet restore
+   ```
+
+4. Build the solution:
+   ```
+   dotnet build
+   ```
+
+## Coding Standards
+
+### C# Code Style
+
+- Follow Microsoft's C# coding conventions
+- Use meaningful names for classes, methods, and variables
+- Add XML documentation comments to all public members
+- Use proper exception handling
+- Write unit tests for all functionality
+- Keep methods small and focused on a single responsibility
+- Use dependency injection where appropriate
+- Avoid static methods except for utility functions
+
+### PowerShell Cmdlet Design
+
+- Follow the PowerShell Verb-Noun naming convention
+- Use approved PowerShell verbs (Get, Set, New, Remove, etc.)
+- Implement proper parameter validation
+- Support pipeline input where appropriate
+- Implement ShouldProcess for cmdlets that make changes
+- Provide meaningful error messages
+- Write detailed help content
+- Support common parameters (-Verbose, -Debug, etc.)
+- Return appropriate objects, not strings
+
+### Documentation
+
+- Document all public APIs with XML comments
+- Include examples in cmdlet help
+- Update README.md and other documentation when adding features
+- Document breaking changes in CHANGELOG.md
+
+## Project Structure
+
+The project follows this structure:
+
+- **src/PSOPNSenseAPI**: Main source code
+  - **Cmdlets**: PowerShell cmdlets
+  - **Models**: Data models
+  - **Services**: Service classes for API communication
+  - **Utilities**: Utility classes
+  - **Logging**: Logging infrastructure
+- **tests**: Unit and integration tests
+- **docs**: Documentation
+- **build**: Build scripts
+- **output**: Build output (not in source control)
+
+## Development Workflow
+
+### Feature Development
+
+1. Create a new branch from `main`:
+   ```
+   git checkout -b feature/my-feature
+   ```
+
+2. Implement the feature:
+   - Add model classes if needed
+   - Implement service classes
+   - Create PowerShell cmdlets
+   - Add unit tests
+   - Update documentation
+
+3. Build and test locally:
+   ```
+   .\build\build.ps1
+   .\build\test.ps1
+   ```
+
+4. Commit your changes with meaningful commit messages:
+   ```
+   git commit -m "Add feature: description of the feature"
+   ```
+
+5. Push your branch and create a pull request:
+   ```
+   git push origin feature/my-feature
+   ```
+
+### Bug Fixes
+
+1. Create a new branch from `main`:
+   ```
+   git checkout -b fix/bug-description
+   ```
+
+2. Fix the bug:
+   - Add a test that reproduces the bug
+   - Fix the bug
+   - Verify that the test passes
+
+3. Commit your changes:
+   ```
+   git commit -m "Fix: description of the bug fix"
+   ```
+
+4. Push your branch and create a pull request:
+   ```
+   git push origin fix/bug-description
+   ```
+
+## Testing
+
+### Unit Testing
+
+- Write unit tests for all functionality
+- Use xUnit for testing
+- Mock external dependencies
+- Aim for high code coverage
+- Run tests before submitting pull requests
+
+### Integration Testing
+
+- Write integration tests for API interactions
+- Use a test OPNSense instance if possible
+- Skip integration tests if no test instance is available
+
+### Running Tests
+
+```powershell
+# Run all tests
+.\build\test.ps1
+
+# Run specific tests
+dotnet test --filter "FullyQualifiedName~PSOPNSenseAPI.Tests.NetworkUtilityTests"
+```
+
+## Building and Packaging
+
+### Building the Module
+
+```powershell
+# Build the module
+.\build\build.ps1
+
+# Build a release version with automatic versioning
+.\build\build-release.ps1 -Clean -Test -Package
+```
+
+### Versioning
+
+The module uses a versioning scheme of `yyyy.MM.dd.HHmm` for releases, which is automatically generated during the build process.
+
+### Creating a Release
+
+1. Update the CHANGELOG.md file
+2. Build a release package:
+   ```
+   .\build\build-release.ps1 -Clean -Test -Package
+   ```
+3. Create a new release on GitHub with the generated package
+
+## Continuous Integration
+
+The project uses GitHub Actions for continuous integration:
+
+- Builds and tests are run on every push to the main branch
+- Release packages are automatically created with the versioning scheme
+- Release artifacts are uploaded to GitHub Releases
+
+## Pull Request Guidelines
+
+When submitting a pull request:
+
+1. Ensure all tests pass
+2. Update documentation if needed
+3. Add entries to CHANGELOG.md for new features or bug fixes
+4. Follow the coding standards
+5. Keep pull requests focused on a single change
+6. Provide a clear description of the changes
+7. Link to any related issues
+
+## Code Review Process
+
+All pull requests will be reviewed for:
+
+- Code quality and style
+- Test coverage
+- Documentation
+- Performance considerations
+- Security implications
+
+## Release Process
+
+1. Merge approved pull requests into the main branch
+2. Update the version in the module manifest
+3. Update CHANGELOG.md
+4. Create a new release on GitHub
+5. Publish the module to PowerShell Gallery (if applicable)
+
+## Support
+
+If you need help with development:
+
+- Open an issue on GitHub
+- Reach out to the maintainers
+- Check the documentation and existing issues
+
+## License
+
+All contributions to this project are subject to the terms of the MIT License.

docs/Firewall-Rules.md

@@ -0,0 +1,268 @@
+# Firewall Rules Management
+
+This component provides cmdlets for managing firewall rules on OPNSense firewalls.
+
+## Overview
+
+The Firewall Rules Management component allows you to create, view, modify, and delete firewall rules on OPNSense firewalls. It provides a comprehensive set of cmdlets to manage all aspects of firewall rules, including enabling, disabling, and applying changes.
+
+## Cmdlets
+
+### Get-OPNSenseFirewallRule
+
+Retrieves firewall rules from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of a specific firewall rule to retrieve. If not specified, all rules are returned.
+- **Interface** - Filter rules by interface.
+- **Direction** - Filter rules by direction (in, out).
+- **Protocol** - Filter rules by protocol.
+- **Action** - Filter rules by action (pass, block, reject).
+
+#### Examples
+
+```powershell
+# Get all firewall rules
+Get-OPNSenseFirewallRule
+
+# Get a specific firewall rule by UUID
+Get-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Get all rules for a specific interface
+Get-OPNSenseFirewallRule -Interface "lan"
+
+# Get all block rules
+Get-OPNSenseFirewallRule -Action "block"
+```
+
+### New-OPNSenseFirewallRule
+
+Creates a new firewall rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Enabled** - Whether the rule is enabled. Default is true.
+- **Action** - The action to take (pass, block, reject). Default is "pass".
+- **Interface** - The interface for the rule.
+- **Direction** - The direction for the rule (in, out). Default is "in".
+- **Protocol** - The protocol for the rule (tcp, udp, icmp, etc.).
+- **Source** - The source address for the rule. Default is "any".
+- **SourcePort** - The source port for the rule. Default is "any".
+- **Destination** - The destination address for the rule. Default is "any".
+- **DestinationPort** - The destination port for the rule.
+- **Description** - A description for the rule.
+- **Log** - Whether to log matches for this rule. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a rule to allow HTTP traffic
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "tcp" -Destination "any" -DestinationPort "80" -Description "Allow HTTP"
+
+# Create a rule to block outgoing SMTP traffic
+New-OPNSenseFirewallRule -Interface "lan" -Direction "out" -Protocol "tcp" -DestinationPort "25" -Action "block" -Description "Block outgoing SMTP" -Log
+
+# Create a rule to allow traffic from a specific subnet to a specific server
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "tcp" -Source "192.168.1.0/24" -Destination "192.168.2.10" -DestinationPort "443" -Description "Allow subnet to server"
+```
+
+### Set-OPNSenseFirewallRule
+
+Updates an existing firewall rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the firewall rule to update.
+- **Enabled** - Whether the rule is enabled.
+- **Action** - The action to take (pass, block, reject).
+- **Interface** - The interface for the rule.
+- **Direction** - The direction for the rule (in, out).
+- **Protocol** - The protocol for the rule.
+- **Source** - The source address for the rule.
+- **SourcePort** - The source port for the rule.
+- **Destination** - The destination address for the rule.
+- **DestinationPort** - The destination port for the rule.
+- **Description** - A description for the rule.
+- **Log** - Whether to log matches for this rule.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Update a firewall rule's description
+Set-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated HTTP rule"
+
+# Update a firewall rule's destination port
+Set-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -DestinationPort "8080"
+
+# Update multiple properties of a firewall rule
+Set-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Action "block" -Log -Description "Block traffic" -PassThru
+```
+
+### Remove-OPNSenseFirewallRule
+
+Removes a firewall rule from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the firewall rule to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a firewall rule
+Remove-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a firewall rule without confirmation
+Remove-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### Enable-OPNSenseFirewallRule
+
+Enables a firewall rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the firewall rule to enable.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Enable a firewall rule
+Enable-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Enable a firewall rule and return the updated rule
+Enable-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -PassThru
+```
+
+### Disable-OPNSenseFirewallRule
+
+Disables a firewall rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the firewall rule to disable.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Disable a firewall rule
+Disable-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Disable a firewall rule and return the updated rule
+Disable-OPNSenseFirewallRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -PassThru
+```
+
+### Apply-OPNSenseFirewallChanges
+
+Applies pending firewall changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply firewall changes
+Apply-OPNSenseFirewallChanges
+
+# Apply firewall changes without confirmation
+Apply-OPNSenseFirewallChanges -Force
+```
+
+## Common Scenarios
+
+### Basic Firewall Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create rules for basic web access
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "tcp" -DestinationPort "80" -Description "Allow HTTP" -Force
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "tcp" -DestinationPort "443" -Description "Allow HTTPS" -Force
+
+# Create a rule to allow DNS
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "udp" -DestinationPort "53" -Description "Allow DNS" -Force
+
+# Apply the changes
+Apply-OPNSenseFirewallChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Securing a Network
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Block outgoing SMTP to prevent spam
+New-OPNSenseFirewallRule -Interface "lan" -Direction "out" -Protocol "tcp" -DestinationPort "25" -Action "block" -Description "Block outgoing SMTP" -Log -Force
+
+# Allow only specific hosts to access the management interface
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "tcp" -Source "192.168.1.10,192.168.1.11" -Destination "192.168.1.1" -DestinationPort "443" -Description "Allow management access" -Force
+
+# Block all other access to the management interface
+New-OPNSenseFirewallRule -Interface "lan" -Protocol "tcp" -Destination "192.168.1.1" -DestinationPort "443" -Action "block" -Description "Block management access" -Log -Force
+
+# Apply the changes
+Apply-OPNSenseFirewallChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Existing Rules
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all firewall rules
+$rules = Get-OPNSenseFirewallRule
+
+# Disable all rules with "Temporary" in the description
+$rules | Where-Object { $_.Description -like "*Temporary*" } | ForEach-Object {
+    Disable-OPNSenseFirewallRule -Uuid $_.Uuid -Force
+    Write-Output "Disabled rule: $($_.Description)"
+}
+
+# Update all rules with "HTTP" in the description to use port 8080 instead of 80
+$rules | Where-Object { $_.Description -like "*HTTP*" -and $_.DestinationPort -eq "80" } | ForEach-Object {
+    Set-OPNSenseFirewallRule -Uuid $_.Uuid -DestinationPort "8080" -Description "$($_.Description) (Updated Port)" -Force
+    Write-Output "Updated rule: $($_.Description)"
+}
+
+# Remove all rules with "Obsolete" in the description
+$rules | Where-Object { $_.Description -like "*Obsolete*" } | ForEach-Object {
+    Remove-OPNSenseFirewallRule -Uuid $_.Uuid -Force
+    Write-Output "Removed rule: $($_.Description)"
+}
+
+# Apply the changes
+Apply-OPNSenseFirewallChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Firewall rules are processed in order, with the first matching rule being applied.
+- Changes to firewall rules are not applied until you call `Apply-OPNSenseFirewallChanges`.
+- When creating or updating rules, consider the rule order and potential security implications.
+- Use the `-Log` parameter for rules that you want to monitor for security purposes.
+- Use aliases for frequently used IP addresses or networks to make rules more maintainable.
+- Consider using the `-PassThru` parameter when updating rules to verify the changes.
+- Always apply the principle of least privilege when creating firewall rules.

docs/Firmware-Management.md

@@ -0,0 +1,295 @@
+# Firmware Management
+
+This component provides cmdlets for managing firmware on OPNSense firewalls.
+
+## Overview
+
+The Firmware Management component allows you to check for updates, install updates, and manage firmware settings on OPNSense firewalls. It provides cmdlets for checking firmware status, upgrading firmware, and managing firmware settings.
+
+## Cmdlets
+
+### Get-OPNSenseFirmwareStatus
+
+Retrieves the current firmware status of an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get firmware status
+Get-OPNSenseFirmwareStatus
+```
+
+### Get-OPNSenseFirmwareUpdate
+
+Checks for available firmware updates for an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Forces a check for updates even if the update cache is current.
+
+#### Examples
+
+```powershell
+# Check for updates
+Get-OPNSenseFirmwareUpdate
+
+# Force a check for updates
+Get-OPNSenseFirmwareUpdate -Force
+```
+
+### Install-OPNSenseFirmwareUpdate
+
+Installs available firmware updates on an OPNSense firewall.
+
+#### Parameters
+
+- **RebootAfterUpdate** - Whether to reboot the firewall after updating. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Install updates
+Install-OPNSenseFirmwareUpdate
+
+# Install updates and reboot
+Install-OPNSenseFirmwareUpdate -RebootAfterUpdate
+
+# Install updates without confirmation
+Install-OPNSenseFirmwareUpdate -Force
+```
+
+### Invoke-OPNSenseFirmwareUpgrade
+
+Performs a firmware upgrade on an OPNSense firewall.
+
+#### Parameters
+
+- **MajorVersion** - The major version to upgrade to.
+- **RebootAfterUpgrade** - Whether to reboot the firewall after upgrading. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Upgrade to the latest version
+Invoke-OPNSenseFirmwareUpgrade
+
+# Upgrade to a specific major version
+Invoke-OPNSenseFirmwareUpgrade -MajorVersion "23.1"
+
+# Upgrade and reboot
+Invoke-OPNSenseFirmwareUpgrade -RebootAfterUpgrade
+
+# Upgrade without confirmation
+Invoke-OPNSenseFirmwareUpgrade -Force
+```
+
+### Get-OPNSenseFirmwareSettings
+
+Retrieves the firmware settings of an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get firmware settings
+Get-OPNSenseFirmwareSettings
+```
+
+### Set-OPNSenseFirmwareSettings
+
+Updates the firmware settings of an OPNSense firewall.
+
+#### Parameters
+
+- **Mirror** - The firmware mirror to use.
+- **Flavour** - The firmware flavour to use (e.g., OpenSSL, LibreSSL).
+- **Subscription** - The firmware subscription to use.
+- **AutomaticUpdates** - Whether to enable automatic updates.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Set firmware mirror
+Set-OPNSenseFirmwareSettings -Mirror "https://opnsense.c0urier.net"
+
+# Enable automatic updates
+Set-OPNSenseFirmwareSettings -AutomaticUpdates $true
+
+# Set multiple firmware settings
+Set-OPNSenseFirmwareSettings -Mirror "https://opnsense.c0urier.net" -Flavour "OpenSSL" -AutomaticUpdates $true
+
+# Set firmware settings without confirmation
+Set-OPNSenseFirmwareSettings -Mirror "https://opnsense.c0urier.net" -Force
+```
+
+### Get-OPNSenseFirmwareAudit
+
+Retrieves the firmware audit log of an OPNSense firewall.
+
+#### Parameters
+
+- **Limit** - The maximum number of entries to retrieve. Default is 50.
+
+#### Examples
+
+```powershell
+# Get firmware audit log
+Get-OPNSenseFirmwareAudit
+
+# Get the last 100 entries from the firmware audit log
+Get-OPNSenseFirmwareAudit -Limit 100
+```
+
+### Invoke-OPNSenseReboot
+
+Reboots an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+- **Wait** - Whether to wait for the firewall to come back online. Default is false.
+- **Timeout** - The timeout in seconds to wait for the firewall to come back online. Default is 300.
+
+#### Examples
+
+```powershell
+# Reboot the firewall
+Invoke-OPNSenseReboot
+
+# Reboot the firewall without confirmation
+Invoke-OPNSenseReboot -Force
+
+# Reboot the firewall and wait for it to come back online
+Invoke-OPNSenseReboot -Wait
+
+# Reboot the firewall and wait with a custom timeout
+Invoke-OPNSenseReboot -Wait -Timeout 600
+```
+
+## Common Scenarios
+
+### Checking and Installing Updates
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Check firmware status
+$status = Get-OPNSenseFirmwareStatus
+Write-Output "Current firmware version: $($status.Version)"
+Write-Output "Current firmware status: $($status.Status)"
+
+# Check for updates
+$updates = Get-OPNSenseFirmwareUpdate -Force
+if ($updates.Count -gt 0) {
+    Write-Output "Updates available:"
+    $updates | Format-Table -Property Name, Version, Size, Description
+    
+    # Install updates
+    Install-OPNSenseFirmwareUpdate -Force
+    
+    # Reboot if necessary
+    if ($updates | Where-Object { $_.RebootRequired -eq $true }) {
+        Write-Output "Rebooting to apply updates..."
+        Invoke-OPNSenseReboot -Force -Wait
+    }
+} else {
+    Write-Output "No updates available."
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Upgrading to a New Major Version
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Check current version
+$status = Get-OPNSenseFirmwareStatus
+Write-Output "Current firmware version: $($status.Version)"
+
+# Perform a backup before upgrading
+New-OPNSenseBackup -IncludeRRD -IncludeInstalled -Force
+$backups = Get-OPNSenseBackup
+$latestBackup = $backups | Sort-Object -Property Date -Descending | Select-Object -First 1
+$backupPath = "C:\Backups\opnsense-pre-upgrade-$(Get-Date -Format 'yyyyMMdd').xml"
+Save-OPNSenseBackup -BackupId $latestBackup.Id -Path $backupPath -Force
+Write-Output "Backup saved to: $backupPath"
+
+# Upgrade to the latest version
+Write-Output "Upgrading firmware..."
+Invoke-OPNSenseFirmwareUpgrade -RebootAfterUpgrade -Force
+
+# Wait for the firewall to come back online
+Write-Output "Waiting for the firewall to come back online..."
+Start-Sleep -Seconds 300
+
+# Reconnect to the firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Check new version
+$newStatus = Get-OPNSenseFirmwareStatus
+Write-Output "New firmware version: $($newStatus.Version)"
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Configuring Firmware Settings
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get current firmware settings
+$settings = Get-OPNSenseFirmwareSettings
+Write-Output "Current firmware settings:"
+$settings | Format-List
+
+# Update firmware settings
+Set-OPNSenseFirmwareSettings -Mirror "https://opnsense.c0urier.net" -Flavour "OpenSSL" -AutomaticUpdates $true -Force
+
+# Get updated firmware settings
+$updatedSettings = Get-OPNSenseFirmwareSettings
+Write-Output "Updated firmware settings:"
+$updatedSettings | Format-List
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Monitoring Firmware Audit Log
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get firmware audit log
+$auditLog = Get-OPNSenseFirmwareAudit -Limit 20
+Write-Output "Recent firmware changes:"
+$auditLog | Format-Table -Property Date, User, Action, Package
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Firmware updates and upgrades can take some time to complete.
+- Always create a backup before performing firmware updates or upgrades.
+- Some updates may require a reboot to take effect.
+- Major version upgrades should be performed with caution and only after thorough testing.
+- Automatic updates can be configured to run at specific times.
+- Firmware mirrors can affect the download speed and availability of updates.
+- The firmware audit log provides a history of firmware changes.
+- Consider using the `-Force` parameter when performing firmware operations in scripts to avoid confirmation prompts.
+- The `-Wait` parameter for `Invoke-OPNSenseReboot` can be useful for scripts that need to wait for the firewall to come back online.
+- Firmware settings are typically stored in the OPNSense configuration file.
+- Some firmware operations may require administrative privileges.
+- Firmware updates and upgrades can fail if there is insufficient disk space.
+- Always check the OPNSense release notes before upgrading to a new major version.

docs/Gateway-Management.md

@@ -0,0 +1,289 @@
+# Gateway Management
+
+This component provides cmdlets for managing gateways on OPNSense firewalls.
+
+## Overview
+
+The Gateway Management component allows you to configure and manage gateways on OPNSense firewalls. It provides cmdlets for creating, viewing, modifying, and deleting gateways, as well as monitoring gateway status.
+
+## Cmdlets
+
+### Get-OPNSenseGateway
+
+Retrieves gateway configurations from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of a specific gateway to retrieve. If not specified, all gateways are returned.
+- **Interface** - Filter gateways by interface.
+- **Protocol** - Filter gateways by protocol (IPv4, IPv6).
+
+#### Examples
+
+```powershell
+# Get all gateways
+Get-OPNSenseGateway
+
+# Get a specific gateway by name
+Get-OPNSenseGateway -Name "WAN_GATEWAY"
+
+# Get all gateways for a specific interface
+Get-OPNSenseGateway -Interface "wan"
+
+# Get all IPv4 gateways
+Get-OPNSenseGateway -Protocol "IPv4"
+```
+
+### New-OPNSenseGateway
+
+Creates a new gateway on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the gateway.
+- **Interface** - The interface for the gateway.
+- **IPAddress** - The IP address of the gateway.
+- **Description** - A description for the gateway.
+- **Enabled** - Whether the gateway is enabled. Default is true.
+- **Monitor** - The IP address to monitor for gateway status.
+- **MonitorDisable** - Whether to disable monitoring for this gateway. Default is false.
+- **Weight** - The weight of the gateway for load balancing. Default is 1.
+- **Protocol** - The protocol for the gateway (IPv4, IPv6). Default is IPv4.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic gateway
+New-OPNSenseGateway -Name "WAN2_GATEWAY" -Interface "opt1" -IPAddress "203.0.113.1" -Description "Secondary WAN Gateway"
+
+# Create a gateway with monitoring
+New-OPNSenseGateway -Name "WAN3_GATEWAY" -Interface "opt2" -IPAddress "198.51.100.1" -Description "Tertiary WAN Gateway" -Monitor "198.51.100.254"
+
+# Create a gateway with load balancing weight
+New-OPNSenseGateway -Name "LB_GATEWAY" -Interface "opt3" -IPAddress "192.0.2.1" -Description "Load Balanced Gateway" -Weight 2
+
+# Create an IPv6 gateway
+New-OPNSenseGateway -Name "WAN_IPv6_GATEWAY" -Interface "wan" -IPAddress "2001:db8::1" -Description "IPv6 WAN Gateway" -Protocol "IPv6"
+```
+
+### Set-OPNSenseGateway
+
+Updates an existing gateway on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the gateway to update.
+- **Interface** - The interface for the gateway.
+- **IPAddress** - The IP address of the gateway.
+- **Description** - A description for the gateway.
+- **Enabled** - Whether the gateway is enabled.
+- **Monitor** - The IP address to monitor for gateway status.
+- **MonitorDisable** - Whether to disable monitoring for this gateway.
+- **Weight** - The weight of the gateway for load balancing.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated gateway.
+
+#### Examples
+
+```powershell
+# Update a gateway's IP address
+Set-OPNSenseGateway -Name "WAN_GATEWAY" -IPAddress "203.0.113.2"
+
+# Update a gateway's description
+Set-OPNSenseGateway -Name "WAN2_GATEWAY" -Description "Updated Secondary WAN Gateway"
+
+# Update a gateway's monitoring settings
+Set-OPNSenseGateway -Name "WAN3_GATEWAY" -Monitor "198.51.100.253"
+
+# Disable a gateway
+Set-OPNSenseGateway -Name "LB_GATEWAY" -Enabled:$false
+
+# Update multiple properties of a gateway
+Set-OPNSenseGateway -Name "WAN_GATEWAY" -IPAddress "203.0.113.3" -Description "Updated WAN Gateway" -Weight 3 -PassThru
+```
+
+### Remove-OPNSenseGateway
+
+Removes a gateway from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the gateway to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a gateway
+Remove-OPNSenseGateway -Name "WAN2_GATEWAY"
+
+# Remove a gateway without confirmation
+Remove-OPNSenseGateway -Name "WAN3_GATEWAY" -Force
+```
+
+### Get-OPNSenseGatewayStatus
+
+Retrieves the status of gateways on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of a specific gateway to get the status for. If not specified, the status of all gateways is returned.
+
+#### Examples
+
+```powershell
+# Get the status of all gateways
+Get-OPNSenseGatewayStatus
+
+# Get the status of a specific gateway
+Get-OPNSenseGatewayStatus -Name "WAN_GATEWAY"
+```
+
+### Apply-OPNSenseGatewayChanges
+
+Applies pending gateway changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply gateway changes
+Apply-OPNSenseGatewayChanges
+
+# Apply gateway changes without confirmation
+Apply-OPNSenseGatewayChanges -Force
+```
+
+## Common Scenarios
+
+### Basic Gateway Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a primary WAN gateway
+New-OPNSenseGateway -Name "WAN_GATEWAY" -Interface "wan" -IPAddress "203.0.113.1" -Description "Primary WAN Gateway" -Monitor "8.8.8.8" -Force
+
+# Apply the changes
+Apply-OPNSenseGatewayChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Multi-WAN Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create gateways for multiple WAN connections
+$wanGateways = @(
+    @{ Name = "WAN1_GATEWAY"; Interface = "wan"; IPAddress = "203.0.113.1"; Description = "Primary WAN Gateway"; Monitor = "8.8.8.8"; Weight = 1 },
+    @{ Name = "WAN2_GATEWAY"; Interface = "opt1"; IPAddress = "198.51.100.1"; Description = "Secondary WAN Gateway"; Monitor = "8.8.4.4"; Weight = 2 },
+    @{ Name = "WAN3_GATEWAY"; Interface = "opt2"; IPAddress = "192.0.2.1"; Description = "Tertiary WAN Gateway"; Monitor = "1.1.1.1"; Weight = 3 }
+)
+
+foreach ($gateway in $wanGateways) {
+    New-OPNSenseGateway -Name $gateway.Name -Interface $gateway.Interface -IPAddress $gateway.IPAddress -Description $gateway.Description -Monitor $gateway.Monitor -Weight $gateway.Weight -Force
+}
+
+# Apply the changes
+Apply-OPNSenseGatewayChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Monitoring Gateway Status
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get the status of all gateways
+$gatewayStatus = Get-OPNSenseGatewayStatus
+
+# Display gateway status
+$gatewayStatus | Format-Table -Property Name, Status, RTT, Loss
+
+# Check for down gateways
+$downGateways = $gatewayStatus | Where-Object { $_.Status -ne "online" }
+if ($downGateways) {
+    Write-Output "The following gateways are not online:"
+    $downGateways | Format-Table -Property Name, Status, RTT, Loss
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Updating Gateway Monitoring
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all gateways
+$gateways = Get-OPNSenseGateway
+
+# Update monitoring settings for all gateways
+foreach ($gateway in $gateways) {
+    # Use different monitoring IPs based on the gateway name
+    $monitorIP = switch ($gateway.Name) {
+        "WAN1_GATEWAY" { "8.8.8.8" }
+        "WAN2_GATEWAY" { "8.8.4.4" }
+        "WAN3_GATEWAY" { "1.1.1.1" }
+        default { "9.9.9.9" }
+    }
+    
+    Set-OPNSenseGateway -Name $gateway.Name -Monitor $monitorIP -Force
+    Write-Output "Updated monitoring for gateway $($gateway.Name) to $monitorIP"
+}
+
+# Apply the changes
+Apply-OPNSenseGatewayChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Failover Gateway Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create primary and backup gateways
+New-OPNSenseGateway -Name "PRIMARY_GW" -Interface "wan" -IPAddress "203.0.113.1" -Description "Primary Gateway" -Monitor "8.8.8.8" -Weight 1 -Force
+New-OPNSenseGateway -Name "BACKUP_GW" -Interface "opt1" -IPAddress "198.51.100.1" -Description "Backup Gateway" -Monitor "8.8.4.4" -Weight 2 -Force
+
+# Apply the changes
+Apply-OPNSenseGatewayChanges -Force
+
+# Create a gateway group for failover
+New-OPNSenseGatewayGroup -Name "FAILOVER_GROUP" -Description "Failover Gateway Group" -Gateways "PRIMARY_GW,BACKUP_GW" -Trigger "1" -Force
+
+# Apply the changes
+Apply-OPNSenseGatewayGroupChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Gateway changes are not applied until you call `Apply-OPNSenseGatewayChanges`.
+- When creating a gateway, ensure that the IP address is reachable from the specified interface.
+- The `Monitor` parameter specifies an IP address to ping to determine the gateway status.
+- The `Weight` parameter is used for load balancing when multiple gateways are used in a gateway group.
+- Gateway names should be descriptive and follow a consistent naming convention.
+- Consider using the `-PassThru` parameter when updating gateways to verify the changes.
+- Gateway monitoring can impact performance if too many gateways are monitored with a high frequency.
+- The default gateway is typically named "WAN_GATEWAY" for IPv4 and "WAN_GATEWAY_V6" for IPv6.
+- Gateway groups can be used for failover or load balancing between multiple gateways.

docs/IPNetwork2-Integration.md

@@ -0,0 +1,166 @@
+# IPNetwork2 Integration
+
+This document provides information about the integration of the IPNetwork2 library in the PSOPNSenseAPI module.
+
+## Overview
+
+The PSOPNSenseAPI module uses the IPNetwork2 library for IP network calculations and manipulations. This library provides functionality for working with IP networks, subnets, CIDR notation, and other network-related operations.
+
+## IPNetwork2 Library
+
+The IPNetwork2 library is a .NET library that provides classes and methods for working with IP networks. It supports both IPv4 and IPv6 networks and provides functionality for:
+
+- Parsing CIDR notation
+- Subnetting
+- Supernetting
+- Network calculations
+- IP address manipulation
+- Network containment and overlap checks
+
+## Integration in PSOPNSenseAPI
+
+The IPNetwork2 library is integrated into the PSOPNSenseAPI module in the following ways:
+
+1. **NetworkUtility Class**: The `NetworkUtility` class in the `PSOPNSenseAPI.Utilities` namespace provides wrapper methods for the IPNetwork2 functionality.
+
+2. **Network Calculation Cmdlets**: The `Invoke-OPNSenseNetworkCalculation` cmdlet exposes the IPNetwork2 functionality to PowerShell users.
+
+3. **VLAN and Subnet Management**: The `New-OPNSenseSubnetVLANs` cmdlet uses IPNetwork2 for subnet calculations when creating VLANs from subnet divisions.
+
+## Using IPNetwork2 in the Code
+
+When using IPNetwork2 in the code, it's important to use the correct namespace and class name:
+
+```csharp
+using System.Net;
+
+// Parse a CIDR notation string
+IPNetwork2 network = IPNetwork2.Parse("192.168.1.0/24");
+
+// Get network properties
+IPAddress networkAddress = network.Network;
+IPAddress broadcastAddress = network.Broadcast;
+int cidrPrefix = network.Cidr;
+BigInteger totalHosts = network.Total;
+
+// Subnet a network
+IEnumerable<IPNetwork2> subnets = IPNetwork2.Subnet(network, 27);
+
+// Check if an IP address is in a network
+bool contains = network.Contains(IPAddress.Parse("192.168.1.100"));
+
+// Check if networks overlap
+bool overlaps = network1.Overlap(network2);
+
+// Create a supernet
+IPNetwork2[] supernet = IPNetwork2.Supernet(new[] { network1, network2 });
+```
+
+## Common Issues and Solutions
+
+### Namespace and Class Name
+
+The most common issue when working with IPNetwork2 is using the incorrect namespace or class name. The correct usage is:
+
+```csharp
+using System.Net;
+
+// Use the class name directly
+IPNetwork2 network = IPNetwork2.Parse("192.168.1.0/24");
+
+// Or use the fully qualified name for clarity
+System.Net.IPNetwork2 network = System.Net.IPNetwork2.Parse("192.168.1.0/24");
+```
+
+### Version Compatibility
+
+Ensure that you're using a compatible version of IPNetwork2. The PSOPNSenseAPI module uses version 3.1.764, which is the latest version as of April 2025.
+
+```xml
+<PackageReference Include="IPNetwork2" Version="3.1.764" />
+```
+
+This version supports .NET 8.0, .NET 9.0, .NET Standard 2.0, and .NET Standard 2.1.
+
+### Method Signatures
+
+Be aware of the method signatures when using IPNetwork2. For example, the `Subnet` method has multiple overloads:
+
+```csharp
+// Subnet by prefix length
+IEnumerable<IPNetwork2> Subnet(IPNetwork2 network, int prefixLength);
+
+// Subnet by subnet count
+IEnumerable<IPNetwork2> Subnet(IPNetwork2 network, BigInteger subnetCount);
+
+// Subnet by target network
+IEnumerable<IPNetwork2> Subnet(IPNetwork2 network, IPNetwork2 targetNetwork);
+```
+
+### Memory Usage
+
+When working with large networks (e.g., /8 networks) and small subnets (e.g., /30), be aware that operations like subnetting can generate a large number of results and consume significant memory.
+
+## Exposing IPNetwork2 Functionality to PowerShell
+
+The PSOPNSenseAPI module exposes IPNetwork2 functionality to PowerShell users through the `Invoke-OPNSenseNetworkCalculation` cmdlet:
+
+```powershell
+# Show network information
+Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Info
+
+# Subnet a network
+Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/24" -Operation Subnet -PrefixLength 27
+
+# Check if networks overlap
+Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/16" -Operation Overlaps -AdditionalNetworks "10.0.1.0/24"
+```
+
+## Advanced Usage
+
+### Custom Network Utility Methods
+
+The `NetworkUtility` class provides additional methods that extend the functionality of IPNetwork2:
+
+```csharp
+// Get the first usable host address in a network
+IPAddress firstHost = NetworkUtility.GetFirstUsableHost(network);
+
+// Get the last usable host address in a network
+IPAddress lastHost = NetworkUtility.GetLastUsableHost(network);
+
+// Get the number of usable host addresses in a network
+BigInteger usableHosts = NetworkUtility.GetUsableHostCount(network);
+
+// Convert between CIDR and subnet mask
+int cidr = NetworkUtility.GetCIDRFromSubnetMask("255.255.255.0");
+string subnetMask = NetworkUtility.GetSubnetMaskFromCIDR(24);
+```
+
+### Network Summarization
+
+The `SupernetSummarize` method provides advanced network summarization:
+
+```csharp
+// Summarize multiple networks into the smallest possible set
+List<IPNetwork2> networks = new List<IPNetwork2>
+{
+    IPNetwork2.Parse("192.168.1.0/24"),
+    IPNetwork2.Parse("192.168.2.0/24"),
+    IPNetwork2.Parse("192.168.3.0/24"),
+    IPNetwork2.Parse("192.168.4.0/24")
+};
+
+List<IPNetwork2> summarized = NetworkUtility.SupernetSummarize(networks);
+// Result: 192.168.0.0/22
+```
+
+## Notes
+
+- The IPNetwork2 library is a third-party library and is subject to its own licensing terms.
+- The PSOPNSenseAPI module includes the IPNetwork2 library as a NuGet package dependency.
+- The IPNetwork2 library is used for local network calculations and does not require communication with the OPNSense firewall.
+- Version 3.1.764 of IPNetwork2 has moved the `IPNetwork2` class to the `System.Net` namespace, which is different from earlier versions that used the `System.Net.IPNetwork` namespace.
+- When upgrading the IPNetwork2 library, ensure that all code is updated to use the correct namespace and class names.
+- Version 3.1.764 supports .NET 8.0, .NET 9.0, .NET Standard 2.0, and .NET Standard 2.1.
+- For .NET Standard 2.0 and 2.1, IPNetwork2 has a dependency on System.Memory (>= 4.5.5).

docs/Installation-Setup.md

@@ -0,0 +1,217 @@
+# Installation and Setup
+
+This document provides instructions for installing and setting up the PSOPNSenseAPI PowerShell module.
+
+## Overview
+
+The PSOPNSenseAPI module is a PowerShell module that provides cmdlets for managing OPNSense firewalls through the OPNSense API. This document covers the installation of the module, setting up API access on the OPNSense firewall, and establishing a connection to the firewall.
+
+## Prerequisites
+
+Before installing the PSOPNSenseAPI module, ensure that you have the following:
+
+- PowerShell 5.1 or later (Windows PowerShell or PowerShell Core)
+- .NET Framework 4.7.2 or later (for Windows PowerShell)
+- .NET Core 3.1 or later (for PowerShell Core)
+- OPNSense 21.1 or later with API access configured
+
+## Installation Methods
+
+### Installing from PowerShell Gallery
+
+The recommended way to install the PSOPNSenseAPI module is from the PowerShell Gallery:
+
+```powershell
+# Install the module for the current user
+Install-Module -Name PSOPNSenseAPI -Scope CurrentUser
+
+# Install the module for all users (requires administrator privileges)
+Install-Module -Name PSOPNSenseAPI -Scope AllUsers
+```
+
+### Installing from GitHub
+
+You can also install the module directly from the GitHub repository:
+
+```powershell
+# Clone the repository
+git clone https://github.com/freedbygrace/PSOPNSenseAPI.git
+
+# Navigate to the repository directory
+cd PSOPNSenseAPI
+
+# Build the module
+.\build\build.ps1
+
+# Import the module
+Import-Module .\output\PSOPNSenseAPI
+```
+
+### Manual Installation
+
+To install the module manually:
+
+1. Download the latest release from the [GitHub releases page](https://github.com/freedbygrace/PSOPNSenseAPI/releases)
+2. Extract the archive to a module directory:
+   - For the current user: `$env:USERPROFILE\Documents\WindowsPowerShell\Modules\PSOPNSenseAPI`
+   - For all users: `$env:ProgramFiles\WindowsPowerShell\Modules\PSOPNSenseAPI`
+3. Import the module:
+
+```powershell
+Import-Module PSOPNSenseAPI
+```
+
+## Setting Up API Access on OPNSense
+
+Before you can use the PSOPNSenseAPI module, you need to set up API access on your OPNSense firewall:
+
+1. Log in to the OPNSense web interface
+2. Navigate to **System > Access > Users**
+3. Select the user you want to use for API access or create a new user
+4. Ensure the user has the necessary privileges for the operations you want to perform
+5. Click on the **API keys** tab
+6. Click **+** to add a new API key
+7. Note the **Key** and **Secret** values, as you will need them to connect to the firewall
+
+## Connecting to an OPNSense Firewall
+
+Once you have installed the module and set up API access, you can connect to an OPNSense firewall:
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret"
+
+# Connect to the OPNSense firewall with certificate validation disabled (for self-signed certificates)
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+```
+
+## Verifying the Installation
+
+To verify that the module is installed and working correctly:
+
+```powershell
+# Check the module version
+Get-Module -Name PSOPNSenseAPI
+
+# List available cmdlets
+Get-Command -Module PSOPNSenseAPI
+
+# Get help for a specific cmdlet
+Get-Help -Name Connect-OPNSense -Full
+```
+
+## Updating the Module
+
+To update the module to the latest version:
+
+```powershell
+# Update the module from PowerShell Gallery
+Update-Module -Name PSOPNSenseAPI
+```
+
+## Uninstalling the Module
+
+To uninstall the module:
+
+```powershell
+# Uninstall the module
+Uninstall-Module -Name PSOPNSenseAPI
+```
+
+## Troubleshooting
+
+### Connection Issues
+
+If you encounter connection issues:
+
+1. Verify that the OPNSense firewall is reachable from your computer
+2. Check that the API key and secret are correct
+3. Ensure that the user associated with the API key has the necessary privileges
+4. If using HTTPS with a self-signed certificate, use the `-SkipCertificateCheck` parameter
+5. Check if there are any firewall rules blocking access to the OPNSense web interface
+
+### Module Loading Issues
+
+If you encounter issues loading the module:
+
+1. Verify that you have the required PowerShell and .NET versions
+2. Check that the module is installed in a valid module path:
+
+```powershell
+# List module paths
+$env:PSModulePath -split ';'
+
+# Check if the module is in a valid path
+Get-Module -Name PSOPNSenseAPI -ListAvailable
+```
+
+3. Try importing the module with verbose output:
+
+```powershell
+Import-Module -Name PSOPNSenseAPI -Verbose
+```
+
+### API Access Issues
+
+If you encounter issues with API access:
+
+1. Verify that the API is enabled on the OPNSense firewall
+2. Check that the user has the necessary privileges
+3. Ensure that the API key and secret are valid
+4. Check if there are any firewall rules blocking access to the API
+
+## Common Configuration
+
+### Creating a Profile for Quick Connection
+
+You can create a profile to store your connection information for quick access:
+
+```powershell
+# Create a directory for profiles
+$profilesDir = "$env:USERPROFILE\Documents\PSOPNSenseAPI\Profiles"
+New-Item -Path $profilesDir -ItemType Directory -Force
+
+# Create a profile
+$profile = @{
+    Server = "https://firewall.example.com"
+    ApiKey = "your_api_key"
+    ApiSecret = "your_api_secret"
+    SkipCertificateCheck = $true
+}
+
+# Save the profile
+$profilePath = "$profilesDir\firewall.json"
+$profile | ConvertTo-Json | Set-Content -Path $profilePath
+
+# Load the profile and connect
+$profile = Get-Content -Path $profilePath | ConvertFrom-Json
+Connect-OPNSense -Server $profile.Server -ApiKey $profile.ApiKey -ApiSecret $profile.ApiSecret -SkipCertificateCheck:$profile.SkipCertificateCheck
+```
+
+### Setting Up a Module Import Profile
+
+You can create a PowerShell profile that automatically imports the module:
+
+```powershell
+# Add the following line to your PowerShell profile
+if (-not (Get-Module -Name PSOPNSenseAPI -ErrorAction SilentlyContinue)) {
+    Import-Module -Name PSOPNSenseAPI
+}
+
+# To edit your PowerShell profile
+notepad $PROFILE
+```
+
+## Notes
+
+- Store API keys and secrets securely, as they provide access to your OPNSense firewall.
+- Consider using a dedicated user with limited privileges for API access.
+- Always disconnect from the firewall when you're done:
+
+```powershell
+Disconnect-OPNSense
+```
+
+- For security reasons, avoid storing API keys and secrets in scripts or profiles that are shared or stored in unsecured locations.
+- When using the module in scripts, consider using secure string variables or environment variables for API keys and secrets.
+- The module uses HTTPS for all communication with the OPNSense firewall, ensuring that all data is encrypted in transit.

docs/Interface-Management.md

@@ -0,0 +1,298 @@
+# Interface Management
+
+This component provides cmdlets for managing network interfaces on OPNSense firewalls.
+
+## Overview
+
+The Interface Management component allows you to configure and manage network interfaces on OPNSense firewalls. It provides cmdlets for creating, viewing, modifying, and deleting interfaces, as well as configuring interface settings.
+
+## Cmdlets
+
+### Get-OPNSenseInterface
+
+Retrieves interface configurations from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of a specific interface to retrieve. If not specified, all interfaces are returned.
+- **Type** - Filter interfaces by type (e.g., physical, vlan, bridge).
+- **Enabled** - Filter interfaces by enabled status.
+
+#### Examples
+
+```powershell
+# Get all interfaces
+Get-OPNSenseInterface
+
+# Get a specific interface by name
+Get-OPNSenseInterface -Name "lan"
+
+# Get all VLAN interfaces
+Get-OPNSenseInterface -Type "vlan"
+
+# Get all enabled interfaces
+Get-OPNSenseInterface -Enabled $true
+```
+
+### New-OPNSenseInterface
+
+Creates a new interface on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the interface.
+- **Description** - A description for the interface.
+- **Type** - The type of the interface (e.g., physical, vlan, bridge).
+- **Device** - The physical device for the interface.
+- **IPv4Address** - The IPv4 address for the interface.
+- **IPv4Subnet** - The IPv4 subnet mask for the interface.
+- **IPv6Address** - The IPv6 address for the interface.
+- **IPv6Subnet** - The IPv6 subnet mask for the interface.
+- **Enabled** - Whether the interface is enabled. Default is true.
+- **BlockPrivate** - Whether to block private networks. Default is false.
+- **BlockBogons** - Whether to block bogon networks. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic interface
+New-OPNSenseInterface -Name "opt1" -Description "Optional Interface 1" -Type "physical" -Device "em1" -IPv4Address "192.168.2.1" -IPv4Subnet "24"
+
+# Create a VLAN interface
+New-OPNSenseInterface -Name "vlan10" -Description "VLAN 10" -Type "vlan" -Device "em0.10" -IPv4Address "10.0.10.1" -IPv4Subnet "24"
+
+# Create an interface with IPv6
+New-OPNSenseInterface -Name "opt2" -Description "Optional Interface 2" -Type "physical" -Device "em2" -IPv4Address "192.168.3.1" -IPv4Subnet "24" -IPv6Address "2001:db8:1::1" -IPv6Subnet "64"
+
+# Create an interface with security options
+New-OPNSenseInterface -Name "dmz" -Description "DMZ Interface" -Type "physical" -Device "em3" -IPv4Address "192.168.100.1" -IPv4Subnet "24" -BlockPrivate -BlockBogons
+```
+
+### Set-OPNSenseInterface
+
+Updates an existing interface on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the interface to update.
+- **Description** - A description for the interface.
+- **IPv4Address** - The IPv4 address for the interface.
+- **IPv4Subnet** - The IPv4 subnet mask for the interface.
+- **IPv6Address** - The IPv6 address for the interface.
+- **IPv6Subnet** - The IPv6 subnet mask for the interface.
+- **Enabled** - Whether the interface is enabled.
+- **BlockPrivate** - Whether to block private networks.
+- **BlockBogons** - Whether to block bogon networks.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated interface.
+
+#### Examples
+
+```powershell
+# Update an interface's description
+Set-OPNSenseInterface -Name "lan" -Description "Updated LAN Interface"
+
+# Update an interface's IPv4 address
+Set-OPNSenseInterface -Name "opt1" -IPv4Address "192.168.2.254" -IPv4Subnet "24"
+
+# Update an interface's IPv6 address
+Set-OPNSenseInterface -Name "opt2" -IPv6Address "2001:db8:2::1" -IPv6Subnet "64"
+
+# Enable security options for an interface
+Set-OPNSenseInterface -Name "dmz" -BlockPrivate -BlockBogons
+
+# Disable an interface
+Set-OPNSenseInterface -Name "opt3" -Enabled:$false
+
+# Update multiple properties of an interface
+Set-OPNSenseInterface -Name "lan" -Description "Main LAN Interface" -IPv4Address "192.168.1.254" -IPv4Subnet "24" -BlockBogons -PassThru
+```
+
+### Remove-OPNSenseInterface
+
+Removes an interface from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the interface to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove an interface
+Remove-OPNSenseInterface -Name "opt3"
+
+# Remove an interface without confirmation
+Remove-OPNSenseInterface -Name "vlan20" -Force
+```
+
+### Get-OPNSenseInterfaceStatistics
+
+Retrieves interface statistics from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of a specific interface to get statistics for. If not specified, statistics for all interfaces are returned.
+
+#### Examples
+
+```powershell
+# Get statistics for all interfaces
+Get-OPNSenseInterfaceStatistics
+
+# Get statistics for a specific interface
+Get-OPNSenseInterfaceStatistics -Name "lan"
+```
+
+### Apply-OPNSenseInterfaceChanges
+
+Applies pending interface changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply interface changes
+Apply-OPNSenseInterfaceChanges
+
+# Apply interface changes without confirmation
+Apply-OPNSenseInterfaceChanges -Force
+```
+
+## Common Scenarios
+
+### Basic Interface Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Configure the LAN interface
+Set-OPNSenseInterface -Name "lan" -Description "Main LAN Interface" -IPv4Address "192.168.1.1" -IPv4Subnet "24" -Force
+
+# Configure the WAN interface
+Set-OPNSenseInterface -Name "wan" -Description "WAN Interface" -BlockPrivate -BlockBogons -Force
+
+# Apply the changes
+Apply-OPNSenseInterfaceChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Creating VLAN Interfaces
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define VLAN interfaces
+$vlans = @(
+    @{ Name = "vlan10"; Description = "Management VLAN"; Device = "em0.10"; IPv4Address = "10.0.10.1"; IPv4Subnet = "24" },
+    @{ Name = "vlan20"; Description = "User VLAN"; Device = "em0.20"; IPv4Address = "10.0.20.1"; IPv4Subnet = "24" },
+    @{ Name = "vlan30"; Description = "Guest VLAN"; Device = "em0.30"; IPv4Address = "10.0.30.1"; IPv4Subnet = "24" },
+    @{ Name = "vlan40"; Description = "IoT VLAN"; Device = "em0.40"; IPv4Address = "10.0.40.1"; IPv4Subnet = "24" }
+)
+
+# Create VLAN interfaces
+foreach ($vlan in $vlans) {
+    New-OPNSenseInterface -Name $vlan.Name -Description $vlan.Description -Type "vlan" -Device $vlan.Device -IPv4Address $vlan.IPv4Address -IPv4Subnet $vlan.IPv4Subnet -Force
+}
+
+# Apply the changes
+Apply-OPNSenseInterfaceChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Configuring Dual-Stack IPv4/IPv6 Interfaces
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define dual-stack interfaces
+$interfaces = @(
+    @{ Name = "lan"; Description = "LAN Interface"; IPv4Address = "192.168.1.1"; IPv4Subnet = "24"; IPv6Address = "2001:db8:1::1"; IPv6Subnet = "64" },
+    @{ Name = "opt1"; Description = "Optional Interface 1"; IPv4Address = "192.168.2.1"; IPv4Subnet = "24"; IPv6Address = "2001:db8:2::1"; IPv6Subnet = "64" },
+    @{ Name = "dmz"; Description = "DMZ Interface"; IPv4Address = "192.168.100.1"; IPv4Subnet = "24"; IPv6Address = "2001:db8:100::1"; IPv6Subnet = "64" }
+)
+
+# Configure dual-stack interfaces
+foreach ($interface in $interfaces) {
+    Set-OPNSenseInterface -Name $interface.Name -Description $interface.Description -IPv4Address $interface.IPv4Address -IPv4Subnet $interface.IPv4Subnet -IPv6Address $interface.IPv6Address -IPv6Subnet $interface.IPv6Subnet -Force
+}
+
+# Apply the changes
+Apply-OPNSenseInterfaceChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Monitoring Interface Statistics
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get interface statistics
+$statistics = Get-OPNSenseInterfaceStatistics
+
+# Display interface statistics
+$statistics | Format-Table -Property Name, Status, InBytes, OutBytes, InPackets, OutPackets, Errors
+
+# Check for interfaces with errors
+$interfacesWithErrors = $statistics | Where-Object { $_.Errors -gt 0 }
+if ($interfacesWithErrors) {
+    Write-Output "The following interfaces have errors:"
+    $interfacesWithErrors | Format-Table -Property Name, Status, Errors
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Securing Interfaces
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all interfaces
+$interfaces = Get-OPNSenseInterface
+
+# Enable security options for external interfaces
+foreach ($interface in $interfaces) {
+    if ($interface.Name -eq "wan" -or $interface.Name -like "opt*") {
+        Set-OPNSenseInterface -Name $interface.Name -BlockPrivate -BlockBogons -Force
+        Write-Output "Enabled security options for interface $($interface.Name)"
+    }
+}
+
+# Apply the changes
+Apply-OPNSenseInterfaceChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Interface changes are not applied until you call `Apply-OPNSenseInterfaceChanges`.
+- When creating or updating interfaces, ensure that the IP addresses do not conflict with other interfaces.
+- The `BlockPrivate` option blocks traffic from private networks (RFC 1918) on the interface.
+- The `BlockBogons` option blocks traffic from bogon networks (unallocated or reserved IP space) on the interface.
+- Interface names should follow OPNSense conventions (e.g., "lan", "wan", "opt1", "vlan10").
+- VLAN interfaces require the parent interface to be properly configured.
+- Consider using the `-PassThru` parameter when updating interfaces to verify the changes.
+- Interface statistics can be useful for monitoring network traffic and identifying issues.
+- When removing an interface, ensure that no other configurations (e.g., firewall rules, NAT rules) reference the interface.
+- IPv6 addresses should be specified in the standard format (e.g., "2001:db8::1").
+- IPv4 subnet masks can be specified in CIDR notation (e.g., "24" for "255.255.255.0") or dotted decimal notation (e.g., "255.255.255.0").

docs/NAT-Rules-Management.md

@@ -0,0 +1,378 @@
+# NAT Rules Management
+
+This component provides cmdlets for managing Network Address Translation (NAT) rules on OPNSense firewalls.
+
+## Overview
+
+The NAT Rules Management component allows you to configure and manage NAT rules on OPNSense firewalls. It provides cmdlets for creating, viewing, modifying, and deleting different types of NAT rules, including port forwarding, outbound NAT, and 1:1 NAT.
+
+## Cmdlets
+
+### Get-OPNSenseNatRule
+
+Retrieves NAT rules from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of a specific NAT rule to retrieve. If not specified, all NAT rules are returned.
+- **Type** - Filter rules by type (port_forward, outbound, 1to1).
+- **Interface** - Filter rules by interface.
+- **Description** - Filter rules by description.
+
+#### Examples
+
+```powershell
+# Get all NAT rules
+Get-OPNSenseNatRule
+
+# Get a specific NAT rule by UUID
+Get-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Get all port forwarding rules
+Get-OPNSenseNatRule -Type "port_forward"
+
+# Get all NAT rules for a specific interface
+Get-OPNSenseNatRule -Interface "wan"
+```
+
+### New-OPNSensePortForwardRule
+
+Creates a new port forwarding rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface for the rule.
+- **Protocol** - The protocol for the rule (tcp, udp, tcp/udp).
+- **Source** - The source address for the rule. Default is "any".
+- **SourcePort** - The source port for the rule. Default is "any".
+- **Destination** - The destination address for the rule. Default is "wanip".
+- **DestinationPort** - The destination port for the rule.
+- **TargetIP** - The target IP address for the rule.
+- **TargetPort** - The target port for the rule.
+- **Description** - A description for the rule.
+- **NatReflection** - The NAT reflection mode (enable, disable, purenat). Default is "enable".
+- **FilterRuleAssociation** - Whether to create an associated filter rule. Default is true.
+- **Enabled** - Whether the rule is enabled. Default is true.
+- **Log** - Whether to log matches for this rule. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic port forwarding rule
+New-OPNSensePortForwardRule -Interface "wan" -Protocol "tcp" -DestinationPort "80" -TargetIP "192.168.1.100" -TargetPort "80" -Description "Web Server"
+
+# Create a port forwarding rule with custom source and destination
+New-OPNSensePortForwardRule -Interface "wan" -Protocol "tcp" -Source "203.0.113.0/24" -DestinationPort "443" -TargetIP "192.168.1.100" -TargetPort "443" -Description "Secure Web Server"
+
+# Create a port forwarding rule with NAT reflection disabled
+New-OPNSensePortForwardRule -Interface "wan" -Protocol "tcp" -DestinationPort "3389" -TargetIP "192.168.1.200" -TargetPort "3389" -Description "RDP Server" -NatReflection "disable"
+
+# Create a port forwarding rule without an associated filter rule
+New-OPNSensePortForwardRule -Interface "wan" -Protocol "tcp" -DestinationPort "22" -TargetIP "192.168.1.200" -TargetPort "22" -Description "SSH Server" -FilterRuleAssociation:$false
+```
+
+### New-OPNSenseOutboundNatRule
+
+Creates a new outbound NAT rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface for the rule.
+- **Source** - The source address for the rule.
+- **Destination** - The destination address for the rule. Default is "any".
+- **TranslationAddress** - The translation address for the rule.
+- **Description** - A description for the rule.
+- **Enabled** - Whether the rule is enabled. Default is true.
+- **Log** - Whether to log matches for this rule. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic outbound NAT rule
+New-OPNSenseOutboundNatRule -Interface "wan" -Source "192.168.1.0/24" -TranslationAddress "203.0.113.1" -Description "Outbound NAT for LAN"
+
+# Create an outbound NAT rule with a specific destination
+New-OPNSenseOutboundNatRule -Interface "wan" -Source "192.168.1.0/24" -Destination "198.51.100.0/24" -TranslationAddress "203.0.113.1" -Description "Outbound NAT for specific destination"
+
+# Create an outbound NAT rule with logging enabled
+New-OPNSenseOutboundNatRule -Interface "wan" -Source "192.168.1.0/24" -TranslationAddress "203.0.113.1" -Description "Logged Outbound NAT" -Log
+```
+
+### New-OPNSense1to1NatRule
+
+Creates a new 1:1 NAT rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The interface for the rule.
+- **ExternalNetwork** - The external network for the rule.
+- **InternalIP** - The internal IP address for the rule.
+- **Description** - A description for the rule.
+- **NatReflection** - The NAT reflection mode (enable, disable, purenat). Default is "enable".
+- **Enabled** - Whether the rule is enabled. Default is true.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic 1:1 NAT rule
+New-OPNSense1to1NatRule -Interface "wan" -ExternalNetwork "203.0.113.10" -InternalIP "192.168.1.10" -Description "1:1 NAT for Server"
+
+# Create a 1:1 NAT rule with NAT reflection disabled
+New-OPNSense1to1NatRule -Interface "wan" -ExternalNetwork "203.0.113.11" -InternalIP "192.168.1.11" -Description "1:1 NAT without reflection" -NatReflection "disable"
+
+# Create a 1:1 NAT rule for a network
+New-OPNSense1to1NatRule -Interface "wan" -ExternalNetwork "203.0.113.0/29" -InternalIP "192.168.1.0/29" -Description "1:1 NAT for Network"
+```
+
+### Set-OPNSenseNatRule
+
+Updates an existing NAT rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the NAT rule to update.
+- **Interface** - The interface for the rule.
+- **Protocol** - The protocol for the rule (tcp, udp, tcp/udp).
+- **Source** - The source address for the rule.
+- **SourcePort** - The source port for the rule.
+- **Destination** - The destination address for the rule.
+- **DestinationPort** - The destination port for the rule.
+- **TargetIP** - The target IP address for the rule.
+- **TargetPort** - The target port for the rule.
+- **TranslationAddress** - The translation address for the rule.
+- **ExternalNetwork** - The external network for the rule.
+- **InternalIP** - The internal IP address for the rule.
+- **Description** - A description for the rule.
+- **NatReflection** - The NAT reflection mode (enable, disable, purenat).
+- **FilterRuleAssociation** - Whether to create an associated filter rule.
+- **Enabled** - Whether the rule is enabled.
+- **Log** - Whether to log matches for this rule.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Update a port forwarding rule's target IP
+Set-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -TargetIP "192.168.1.101"
+
+# Update a port forwarding rule's description
+Set-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated Web Server"
+
+# Update an outbound NAT rule's translation address
+Set-OPNSenseNatRule -Uuid "b2c3d4e5-f6g7-h8i9-j0k1-l2m3n4o5p6q7" -TranslationAddress "203.0.113.2"
+
+# Update a 1:1 NAT rule's internal IP
+Set-OPNSenseNatRule -Uuid "c3d4e5f6-g7h8-i9j0-k1l2-m3n4o5p6q7r8" -InternalIP "192.168.1.12"
+
+# Disable a NAT rule
+Set-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Enabled:$false
+
+# Update multiple properties of a NAT rule
+Set-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -TargetIP "192.168.1.101" -TargetPort "8080" -Description "Updated Web Server" -PassThru
+```
+
+### Remove-OPNSenseNatRule
+
+Removes a NAT rule from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the NAT rule to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a NAT rule
+Remove-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a NAT rule without confirmation
+Remove-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### Enable-OPNSenseNatRule
+
+Enables a NAT rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the NAT rule to enable.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Enable a NAT rule
+Enable-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Enable a NAT rule and return the updated rule
+Enable-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -PassThru
+```
+
+### Disable-OPNSenseNatRule
+
+Disables a NAT rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the NAT rule to disable.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Disable a NAT rule
+Disable-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Disable a NAT rule and return the updated rule
+Disable-OPNSenseNatRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -PassThru
+```
+
+### Apply-OPNSenseNatChanges
+
+Applies pending NAT changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply NAT changes
+Apply-OPNSenseNatChanges
+
+# Apply NAT changes without confirmation
+Apply-OPNSenseNatChanges -Force
+```
+
+## Common Scenarios
+
+### Setting Up Port Forwarding for a Web Server
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create port forwarding rules for HTTP and HTTPS
+New-OPNSensePortForwardRule -Interface "wan" -Protocol "tcp" -DestinationPort "80" -TargetIP "192.168.1.100" -TargetPort "80" -Description "Web Server HTTP" -Force
+New-OPNSensePortForwardRule -Interface "wan" -Protocol "tcp" -DestinationPort "443" -TargetIP "192.168.1.100" -TargetPort "443" -Description "Web Server HTTPS" -Force
+
+# Apply the changes
+Apply-OPNSenseNatChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Configuring Outbound NAT for Multiple Networks
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define networks and their translation addresses
+$networks = @(
+    @{ Source = "192.168.1.0/24"; Translation = "203.0.113.1"; Description = "LAN Outbound NAT" },
+    @{ Source = "192.168.2.0/24"; Translation = "203.0.113.2"; Description = "Guest Outbound NAT" },
+    @{ Source = "192.168.3.0/24"; Translation = "203.0.113.3"; Description = "DMZ Outbound NAT" }
+)
+
+# Create outbound NAT rules
+foreach ($network in $networks) {
+    New-OPNSenseOutboundNatRule -Interface "wan" -Source $network.Source -TranslationAddress $network.Translation -Description $network.Description -Force
+}
+
+# Apply the changes
+Apply-OPNSenseNatChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Setting Up 1:1 NAT for a Server Farm
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define server mappings
+$servers = @(
+    @{ External = "203.0.113.10"; Internal = "192.168.1.10"; Description = "Web Server 1" },
+    @{ External = "203.0.113.11"; Internal = "192.168.1.11"; Description = "Web Server 2" },
+    @{ External = "203.0.113.12"; Internal = "192.168.1.12"; Description = "Database Server" },
+    @{ External = "203.0.113.13"; Internal = "192.168.1.13"; Description = "Mail Server" }
+)
+
+# Create 1:1 NAT rules
+foreach ($server in $servers) {
+    New-OPNSense1to1NatRule -Interface "wan" -ExternalNetwork $server.External -InternalIP $server.Internal -Description $server.Description -Force
+}
+
+# Apply the changes
+Apply-OPNSenseNatChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Existing NAT Rules
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all NAT rules
+$natRules = Get-OPNSenseNatRule
+
+# Update port forwarding rules to use a new target IP
+$portForwardRules = $natRules | Where-Object { $_.Type -eq "port_forward" -and $_.TargetIP -eq "192.168.1.100" }
+foreach ($rule in $portForwardRules) {
+    Set-OPNSenseNatRule -Uuid $rule.Uuid -TargetIP "192.168.1.101" -Description "$($rule.Description) (Updated)" -Force
+    Write-Output "Updated rule: $($rule.Description)"
+}
+
+# Disable temporary NAT rules
+$tempRules = $natRules | Where-Object { $_.Description -like "*Temporary*" }
+foreach ($rule in $tempRules) {
+    Disable-OPNSenseNatRule -Uuid $rule.Uuid -Force
+    Write-Output "Disabled rule: $($rule.Description)"
+}
+
+# Remove obsolete NAT rules
+$obsoleteRules = $natRules | Where-Object { $_.Description -like "*Obsolete*" }
+foreach ($rule in $obsoleteRules) {
+    Remove-OPNSenseNatRule -Uuid $rule.Uuid -Force
+    Write-Output "Removed rule: $($rule.Description)"
+}
+
+# Apply the changes
+Apply-OPNSenseNatChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- NAT rules are processed in order, with the first matching rule being applied.
+- Changes to NAT rules are not applied until you call `Apply-OPNSenseNatChanges`.
+- Port forwarding rules create a mapping from an external port to an internal IP address and port.
+- Outbound NAT rules control how internal addresses are translated when accessing external networks.
+- 1:1 NAT rules create a one-to-one mapping between an external IP address and an internal IP address.
+- NAT reflection allows internal clients to access forwarded services using the external IP address.
+- The `FilterRuleAssociation` parameter for port forwarding rules determines whether a corresponding firewall rule is created.
+- When creating or updating NAT rules, consider the rule order and potential security implications.
+- Use the `-Log` parameter for rules that you want to monitor for security purposes.
+- Consider using the `-PassThru` parameter when updating NAT rules to verify the changes.
+- NAT rules can reference aliases for source, destination, and port fields.
+- The `NatReflection` parameter can be set to "enable", "disable", or "purenat".
+- The `Source` parameter can be set to "any" to match any source address.
+- The `Destination` parameter for port forwarding rules can be set to "wanip" to use the WAN IP address.
+- The `TranslationAddress` parameter for outbound NAT rules can be set to "wanip" to use the WAN IP address.

docs/Network-Utilities.md

@@ -0,0 +1,155 @@
+# Network Utilities
+
+This component provides cmdlets for performing network calculations and conversions.
+
+## Overview
+
+The Network Utilities component includes cmdlets for working with IP networks, subnets, CIDR notation, and other network-related calculations. These utilities help with planning and managing network configurations on OPNSense firewalls.
+
+## Cmdlets
+
+### Invoke-OPNSenseNetworkCalculation
+
+Performs various network calculations on IP networks.
+
+#### Parameters
+
+- **Network** - The network in CIDR notation to perform calculations on.
+- **Operation** - The operation to perform. Valid values are:
+  - **Info** - Shows detailed information about the network.
+  - **Subnet** - Divides the network into subnets of a specified prefix length.
+  - **SubnetByCount** - Divides the network into a specified number of subnets.
+  - **Contains** - Checks if an IP address or network is contained within the specified network.
+  - **Overlaps** - Checks if the network overlaps with other networks.
+  - **Supernet** - Combines the network with other networks into a supernet.
+  - **SupernetSummarize** - Summarizes multiple networks into the smallest possible set of networks.
+- **PrefixLength** - The prefix length to use for subnetting.
+- **SubnetCount** - The number of subnets to create when using SubnetByCount.
+- **IpAddress** - The IP address to check when using Contains.
+- **AdditionalNetworks** - Additional networks to use with Overlaps, Supernet, or SupernetSummarize.
+
+#### Examples
+
+```powershell
+# Show network information
+Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Info
+
+# Subnet a network into /27 networks
+Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/24" -Operation Subnet -PrefixLength 27
+
+# Create 4 equal-sized subnets
+Invoke-OPNSenseNetworkCalculation -Network "172.16.0.0/24" -Operation SubnetByCount -SubnetCount 4
+
+# Check if an IP is within a network
+Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Contains -IpAddress "192.168.1.100"
+
+# Check if networks overlap
+Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/16" -Operation Overlaps -AdditionalNetworks "10.0.1.0/24","10.0.2.0/24"
+
+# Combine networks into a supernet
+Invoke-OPNSenseNetworkCalculation -Network "192.168.0.0/24" -Operation Supernet -AdditionalNetworks "192.168.1.0/24"
+
+# Summarize multiple networks
+Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/24" -Operation SupernetSummarize -AdditionalNetworks "10.0.1.0/24","10.0.2.0/24"
+```
+
+### ConvertTo-OPNSenseNetworkNotation
+
+Converts between different network notation formats.
+
+#### Parameters
+
+- **CIDR** - The CIDR prefix length to convert to a subnet mask.
+- **SubnetMask** - The subnet mask to convert to a CIDR prefix length.
+
+#### Examples
+
+```powershell
+# Convert CIDR to subnet mask
+ConvertTo-OPNSenseNetworkNotation -CIDR 24  # Returns "255.255.255.0"
+
+# Convert subnet mask to CIDR
+ConvertTo-OPNSenseNetworkNotation -SubnetMask "255.255.255.0"  # Returns 24
+```
+
+## Common Scenarios
+
+### Network Planning
+
+```powershell
+# Plan a network subdivision
+$network = "10.0.0.0/16"
+$subnets = Invoke-OPNSenseNetworkCalculation -Network $network -Operation Subnet -PrefixLength 24
+$subnets | Format-Table -Property CIDR, Network, Broadcast, FirstUsableHost, LastUsableHost, UsableHostCount
+
+# Create equal-sized subnets
+$departmentCount = 8
+$subnets = Invoke-OPNSenseNetworkCalculation -Network "172.16.0.0/20" -Operation SubnetByCount -SubnetCount $departmentCount
+$subnets | Format-Table -Property CIDR, Network, Broadcast, UsableHostCount
+```
+
+### Network Verification
+
+```powershell
+# Verify if an IP address is within a network
+$serverIP = "192.168.1.50"
+$network = "192.168.1.0/24"
+$isInNetwork = Invoke-OPNSenseNetworkCalculation -Network $network -Operation Contains -IpAddress $serverIP
+
+# Check if networks overlap
+$network1 = "10.0.0.0/16"
+$network2 = "10.0.5.0/24"
+$overlaps = Invoke-OPNSenseNetworkCalculation -Network $network1 -Operation Overlaps -AdditionalNetworks $network2
+```
+
+### Network Optimization
+
+```powershell
+# Optimize a list of networks by summarizing them
+$networks = @(
+    "192.168.1.0/24",
+    "192.168.2.0/24",
+    "192.168.3.0/24",
+    "192.168.4.0/24"
+)
+$optimized = Invoke-OPNSenseNetworkCalculation -Network $networks[0] -Operation SupernetSummarize -AdditionalNetworks $networks[1..($networks.Length-1)]
+$optimized | Format-Table -Property CIDR, Network, Broadcast
+```
+
+### VLAN Planning
+
+```powershell
+# Plan VLANs with appropriate subnet sizes
+$corporateNetwork = "10.0.0.0/16"
+$vlans = @{
+    "Management" = 10
+    "Servers" = 20
+    "Users" = 30
+    "Guest" = 40
+    "IoT" = 50
+}
+
+foreach ($vlan in $vlans.GetEnumerator()) {
+    $vlanName = $vlan.Key
+    $vlanId = $vlan.Value
+    $prefix = switch ($vlanName) {
+        "Management" { 24 }  # 254 hosts
+        "Servers" { 23 }     # 510 hosts
+        "Users" { 22 }       # 1022 hosts
+        "Guest" { 24 }       # 254 hosts
+        "IoT" { 23 }         # 510 hosts
+    }
+    
+    # Calculate network details
+    $subnet = Invoke-OPNSenseNetworkCalculation -Network $corporateNetwork -Operation Subnet -PrefixLength $prefix | Select-Object -First 1
+    
+    Write-Output "VLAN $vlanId ($vlanName): $($subnet.CIDR) - $($subnet.UsableHostCount) usable hosts"
+}
+```
+
+## Notes
+
+- The Network Utilities component uses the IPNetwork2 library for network calculations.
+- All operations are performed locally and do not require communication with the OPNSense firewall.
+- These utilities can be used for planning network configurations before implementing them on the firewall.
+- When working with large networks, be aware that some operations (like subnetting a /8 network into /30 networks) may generate a large number of results.

docs/Plugin-Management.md

@@ -0,0 +1,296 @@
+# Plugin Management
+
+This component provides cmdlets for managing plugins on OPNSense firewalls.
+
+## Overview
+
+The Plugin Management component allows you to install, configure, and manage plugins on OPNSense firewalls. It provides cmdlets for listing available plugins, installing and uninstalling plugins, and managing plugin configurations.
+
+## Cmdlets
+
+### Get-OPNSensePlugin
+
+Retrieves a list of available and installed plugins on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of a specific plugin to retrieve. If not specified, all plugins are returned.
+- **Category** - Filter plugins by category.
+- **Installed** - Filter plugins by installation status.
+
+#### Examples
+
+```powershell
+# Get all plugins
+Get-OPNSensePlugin
+
+# Get a specific plugin by name
+Get-OPNSensePlugin -Name "os-tailscale"
+
+# Get all installed plugins
+Get-OPNSensePlugin -Installed $true
+
+# Get all plugins in a specific category
+Get-OPNSensePlugin -Category "security"
+```
+
+### Install-OPNSensePlugin
+
+Installs a plugin on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to install.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Install a plugin
+Install-OPNSensePlugin -Name "os-tailscale"
+
+# Install a plugin without confirmation
+Install-OPNSensePlugin -Name "os-wireguard" -Force
+```
+
+### Uninstall-OPNSensePlugin
+
+Uninstalls a plugin from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to uninstall.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Uninstall a plugin
+Uninstall-OPNSensePlugin -Name "os-tailscale"
+
+# Uninstall a plugin without confirmation
+Uninstall-OPNSensePlugin -Name "os-wireguard" -Force
+```
+
+### Enable-OPNSensePlugin
+
+Enables a plugin on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to enable.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Enable a plugin
+Enable-OPNSensePlugin -Name "os-tailscale"
+
+# Enable a plugin without confirmation
+Enable-OPNSensePlugin -Name "os-wireguard" -Force
+```
+
+### Disable-OPNSensePlugin
+
+Disables a plugin on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to disable.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Disable a plugin
+Disable-OPNSensePlugin -Name "os-tailscale"
+
+# Disable a plugin without confirmation
+Disable-OPNSensePlugin -Name "os-wireguard" -Force
+```
+
+### Get-OPNSensePluginConfiguration
+
+Retrieves the configuration of a plugin on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to get the configuration for.
+
+#### Examples
+
+```powershell
+# Get the configuration of a plugin
+Get-OPNSensePluginConfiguration -Name "os-tailscale"
+```
+
+### Set-OPNSensePluginConfiguration
+
+Updates the configuration of a plugin on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to update the configuration for.
+- **Configuration** - The configuration to set.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Update the configuration of a plugin
+$config = @{
+    enabled = "1"
+    settings = @{
+        hostname = "opnsense-tailscale"
+        acceptDns = "1"
+    }
+}
+Set-OPNSensePluginConfiguration -Name "os-tailscale" -Configuration $config
+
+# Update the configuration of a plugin without confirmation
+Set-OPNSensePluginConfiguration -Name "os-tailscale" -Configuration $config -Force
+```
+
+### Apply-OPNSensePluginChanges
+
+Applies pending plugin changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the plugin to apply changes for.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply changes for a plugin
+Apply-OPNSensePluginChanges -Name "os-tailscale"
+
+# Apply changes for a plugin without confirmation
+Apply-OPNSensePluginChanges -Name "os-tailscale" -Force
+```
+
+## Common Scenarios
+
+### Installing and Configuring a Plugin
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Install the Tailscale plugin
+Install-OPNSensePlugin -Name "os-tailscale" -Force
+
+# Configure the plugin
+$config = @{
+    enabled = "1"
+    settings = @{
+        hostname = "opnsense-tailscale"
+        acceptDns = "1"
+        acceptRoutes = "1"
+        advertiseRoutes = "192.168.1.0/24,10.0.0.0/8"
+    }
+}
+Set-OPNSensePluginConfiguration -Name "os-tailscale" -Configuration $config -Force
+
+# Apply the changes
+Apply-OPNSensePluginChanges -Name "os-tailscale" -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Multiple Plugins
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define plugins to install
+$plugins = @(
+    "os-tailscale",
+    "os-wireguard",
+    "os-acme-client",
+    "os-theme-vicuna"
+)
+
+# Install plugins
+foreach ($plugin in $plugins) {
+    Install-OPNSensePlugin -Name $plugin -Force
+    Write-Output "Installed plugin: $plugin"
+}
+
+# Get all installed plugins
+$installedPlugins = Get-OPNSensePlugin -Installed $true
+Write-Output "Installed plugins:"
+$installedPlugins | Format-Table -Property Name, Version, Description
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Updating Plugin Configurations
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get the current configuration of a plugin
+$currentConfig = Get-OPNSensePluginConfiguration -Name "os-wireguard"
+
+# Update the configuration
+$currentConfig.server.enabled = "1"
+$currentConfig.server.port = "51820"
+$currentConfig.server.dns = "192.168.1.1"
+
+# Set the updated configuration
+Set-OPNSensePluginConfiguration -Name "os-wireguard" -Configuration $currentConfig -Force
+
+# Apply the changes
+Apply-OPNSensePluginChanges -Name "os-wireguard" -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Cleaning Up Unused Plugins
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all installed plugins
+$installedPlugins = Get-OPNSensePlugin -Installed $true
+
+# Define plugins to keep
+$pluginsToKeep = @(
+    "os-tailscale",
+    "os-wireguard",
+    "os-acme-client"
+)
+
+# Uninstall unused plugins
+foreach ($plugin in $installedPlugins) {
+    if ($pluginsToKeep -notcontains $plugin.Name) {
+        Uninstall-OPNSensePlugin -Name $plugin.Name -Force
+        Write-Output "Uninstalled plugin: $($plugin.Name)"
+    }
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Plugin installation and uninstallation may require a firewall reboot to take effect.
+- Some plugins may have dependencies that need to be installed first.
+- Plugin configurations vary widely depending on the plugin.
+- Always check the OPNSense documentation for specific plugin requirements and configuration options.
+- Plugin management requires administrative privileges.
+- Plugin installation and uninstallation can take some time, especially for larger plugins.
+- Some plugins may not be available for all OPNSense versions.
+- Plugin configurations are typically stored in XML format.
+- Changes to plugin configurations may not take effect until the plugin service is restarted or the firewall is rebooted.
+- Consider using the `-Force` parameter when installing or uninstalling plugins in scripts to avoid confirmation prompts.

docs/Port-Forwarding.md

@@ -0,0 +1,158 @@
+# Port Forwarding Management
+
+This component provides cmdlets for managing port forwarding rules on OPNSense firewalls.
+
+## Overview
+
+Port forwarding (also known as destination NAT or DNAT) allows external traffic to be redirected to internal servers. This component provides cmdlets to create, view, modify, and delete port forwarding rules on OPNSense firewalls.
+
+## Cmdlets
+
+### Get-OPNSensePortForwardingRule
+
+Retrieves port forwarding rules from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of a specific port forwarding rule to retrieve. If not specified, all rules are returned.
+
+#### Examples
+
+```powershell
+# Get all port forwarding rules
+Get-OPNSensePortForwardingRule
+
+# Get a specific port forwarding rule by UUID
+Get-OPNSensePortForwardingRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+```
+
+### New-OPNSensePortForwardingRule
+
+Creates a new port forwarding rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Enabled** - Whether the rule is enabled. Default is true.
+- **Description** - A description for the rule.
+- **Interface** - The interface for the rule (e.g., "WAN").
+- **Protocol** - The TCP/IP protocol (tcp, udp, tcp/udp). Default is "tcp".
+- **Source** - The source address for the rule. Default is "any".
+- **SourcePort** - The source port range for the rule. Default is "any".
+- **Destination** - The destination address for the rule. Default is "wanip".
+- **DestinationPort** - The destination port range for the rule.
+- **TargetIP** - The target IP address for the rule.
+- **TargetPort** - The target port for the rule.
+- **NatReflection** - The NAT reflection mode (enable, disable, purenat). Default is "enable".
+- **FilterRuleAssociation** - Whether to create an associated filter rule. Default is true.
+- **Log** - Whether to enable logging for this rule. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a new port forwarding rule for HTTP
+New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "80" -TargetIP "192.168.1.100" -TargetPort "80" -Description "Web Server HTTP"
+
+# Create a new port forwarding rule for HTTPS with logging enabled
+New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "443" -TargetIP "192.168.1.100" -TargetPort "443" -Description "Web Server HTTPS" -Log -Force
+```
+
+### Set-OPNSensePortForwardingRule
+
+Updates an existing port forwarding rule on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the port forwarding rule to update.
+- **Enabled** - Whether the rule is enabled.
+- **Description** - A description for the rule.
+- **Interface** - The interface for the rule.
+- **Protocol** - The TCP/IP protocol (tcp, udp, tcp/udp).
+- **Source** - The source address for the rule.
+- **SourcePort** - The source port range for the rule.
+- **Destination** - The destination address for the rule.
+- **DestinationPort** - The destination port range for the rule.
+- **TargetIP** - The target IP address for the rule.
+- **TargetPort** - The target port for the rule.
+- **NatReflection** - The NAT reflection mode (enable, disable, purenat).
+- **FilterRuleAssociation** - Whether to create an associated filter rule.
+- **Log** - Whether to enable logging for this rule.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated rule.
+
+#### Examples
+
+```powershell
+# Update a port forwarding rule's target IP
+Set-OPNSensePortForwardingRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -TargetIP "192.168.1.200"
+
+# Update a port forwarding rule's description and enable logging
+Set-OPNSensePortForwardingRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated Web Server" -Log -PassThru
+```
+
+### Remove-OPNSensePortForwardingRule
+
+Removes a port forwarding rule from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the port forwarding rule to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a port forwarding rule
+Remove-OPNSensePortForwardingRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a port forwarding rule without confirmation
+Remove-OPNSensePortForwardingRule -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+## Common Scenarios
+
+### Web Server Port Forwarding
+
+```powershell
+# Forward HTTP and HTTPS to an internal web server
+New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "80" -TargetIP "192.168.1.100" -TargetPort "80" -Description "Web Server HTTP"
+New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "443" -TargetIP "192.168.1.100" -TargetPort "443" -Description "Web Server HTTPS"
+```
+
+### Remote Desktop Access
+
+```powershell
+# Forward RDP to an internal server on a non-standard port
+New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "33389" -TargetIP "192.168.1.200" -TargetPort "3389" -Description "Remote Desktop"
+```
+
+### Game Server
+
+```powershell
+# Forward multiple ports for a game server
+New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp/udp" -DestinationPort "27015-27020" -TargetIP "192.168.1.150" -TargetPort "27015-27020" -Description "Game Server"
+```
+
+### Managing Rules
+
+```powershell
+# Get all port forwarding rules
+$rules = Get-OPNSensePortForwardingRule
+
+# Update all rules targeting a specific IP
+$rules | Where-Object { $_.TargetIP -eq "192.168.1.100" } | ForEach-Object {
+    Set-OPNSensePortForwardingRule -Uuid $_.Uuid -TargetIP "192.168.1.101" -Force
+}
+
+# Remove all rules with a specific description
+$rules | Where-Object { $_.Description -like "*Temporary*" } | ForEach-Object {
+    Remove-OPNSensePortForwardingRule -Uuid $_.Uuid -Force
+}
+```
+
+## Notes
+
+- Port forwarding rules are applied immediately after creation, update, or deletion.
+- When creating or updating rules, consider security implications and only forward necessary ports.
+- Use the `FilterRuleAssociation` parameter to automatically create associated firewall rules.
+- NAT reflection allows internal clients to access forwarded services using the external IP address.

docs/Route-Management.md

@@ -0,0 +1,291 @@
+# Route Management
+
+This component provides cmdlets for managing static routes on OPNSense firewalls.
+
+## Overview
+
+The Route Management component allows you to configure and manage static routes on OPNSense firewalls. It provides cmdlets for creating, viewing, modifying, and deleting static routes.
+
+## Cmdlets
+
+### Get-OPNSenseRoute
+
+Retrieves static routes from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of a specific route to retrieve. If not specified, all routes are returned.
+- **Network** - Filter routes by network.
+- **Gateway** - Filter routes by gateway.
+- **Description** - Filter routes by description.
+
+#### Examples
+
+```powershell
+# Get all static routes
+Get-OPNSenseRoute
+
+# Get a specific route by UUID
+Get-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Get routes for a specific network
+Get-OPNSenseRoute -Network "192.168.100.0/24"
+
+# Get routes using a specific gateway
+Get-OPNSenseRoute -Gateway "WAN_GATEWAY"
+```
+
+### New-OPNSenseRoute
+
+Creates a new static route on an OPNSense firewall.
+
+#### Parameters
+
+- **Network** - The network for the route in CIDR notation.
+- **Gateway** - The gateway for the route.
+- **Description** - A description for the route.
+- **Disabled** - Whether the route is disabled. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic static route
+New-OPNSenseRoute -Network "192.168.100.0/24" -Gateway "WAN_GATEWAY" -Description "Remote Office Network"
+
+# Create a disabled static route
+New-OPNSenseRoute -Network "10.0.0.0/8" -Gateway "WAN2_GATEWAY" -Description "Corporate Network" -Disabled
+
+# Create a static route without confirmation
+New-OPNSenseRoute -Network "172.16.0.0/16" -Gateway "WAN3_GATEWAY" -Description "Partner Network" -Force
+```
+
+### Set-OPNSenseRoute
+
+Updates an existing static route on an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the route to update.
+- **Network** - The network for the route in CIDR notation.
+- **Gateway** - The gateway for the route.
+- **Description** - A description for the route.
+- **Disabled** - Whether the route is disabled.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated route.
+
+#### Examples
+
+```powershell
+# Update a route's network
+Set-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Network "192.168.200.0/24"
+
+# Update a route's gateway
+Set-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Gateway "WAN2_GATEWAY"
+
+# Update a route's description
+Set-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Description "Updated Remote Office Network"
+
+# Enable a disabled route
+Set-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Disabled:$false
+
+# Update multiple properties of a route
+Set-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Network "192.168.200.0/24" -Gateway "WAN3_GATEWAY" -Description "Updated Remote Office Network" -PassThru
+```
+
+### Remove-OPNSenseRoute
+
+Removes a static route from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the route to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a route
+Remove-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a route without confirmation
+Remove-OPNSenseRoute -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### Apply-OPNSenseRouteChanges
+
+Applies pending route changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply route changes
+Apply-OPNSenseRouteChanges
+
+# Apply route changes without confirmation
+Apply-OPNSenseRouteChanges -Force
+```
+
+## Common Scenarios
+
+### Basic Route Configuration
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a static route to a remote network
+New-OPNSenseRoute -Network "192.168.100.0/24" -Gateway "WAN_GATEWAY" -Description "Remote Office Network" -Force
+
+# Apply the changes
+Apply-OPNSenseRouteChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Multiple Routes
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define routes for different networks
+$routes = @(
+    @{ Network = "192.168.100.0/24"; Gateway = "WAN_GATEWAY"; Description = "Remote Office 1" },
+    @{ Network = "192.168.200.0/24"; Gateway = "WAN_GATEWAY"; Description = "Remote Office 2" },
+    @{ Network = "10.0.0.0/8"; Gateway = "WAN2_GATEWAY"; Description = "Corporate Network" },
+    @{ Network = "172.16.0.0/16"; Gateway = "WAN3_GATEWAY"; Description = "Partner Network" }
+)
+
+# Create routes
+foreach ($route in $routes) {
+    New-OPNSenseRoute -Network $route.Network -Gateway $route.Gateway -Description $route.Description -Force
+}
+
+# Apply the changes
+Apply-OPNSenseRouteChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Updating Routes for a Gateway Change
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all routes using a specific gateway
+$routes = Get-OPNSenseRoute -Gateway "WAN_GATEWAY"
+
+# Update routes to use a different gateway
+foreach ($route in $routes) {
+    Set-OPNSenseRoute -Uuid $route.Uuid -Gateway "WAN2_GATEWAY" -Description "$($route.Description) (Updated)" -Force
+    Write-Output "Updated route for network $($route.Network) to use gateway WAN2_GATEWAY"
+}
+
+# Apply the changes
+Apply-OPNSenseRouteChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Temporarily Disabling Routes
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all routes
+$routes = Get-OPNSenseRoute
+
+# Disable routes for a specific network range
+foreach ($route in $routes) {
+    if ($route.Network -like "10.*") {
+        Set-OPNSenseRoute -Uuid $route.Uuid -Disabled:$true -Force
+        Write-Output "Disabled route for network $($route.Network)"
+    }
+}
+
+# Apply the changes
+Apply-OPNSenseRouteChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Route Cleanup
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all routes
+$routes = Get-OPNSenseRoute
+
+# Remove routes with "Temporary" in the description
+foreach ($route in $routes) {
+    if ($route.Description -like "*Temporary*") {
+        Remove-OPNSenseRoute -Uuid $route.Uuid -Force
+        Write-Output "Removed route for network $($route.Network) with description '$($route.Description)'"
+    }
+}
+
+# Apply the changes
+Apply-OPNSenseRouteChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Creating Routes from Network Calculations
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Calculate subnets
+$network = "10.0.0.0/16"
+$prefixLength = 24
+$subnets = Invoke-OPNSenseNetworkCalculation -Network $network -Operation Subnet -PrefixLength $prefixLength
+
+# Create routes for each subnet
+foreach ($subnet in $subnets) {
+    # Determine the gateway based on the subnet
+    $gateway = if ($subnet.CIDR -like "10.0.1*") {
+        "WAN_GATEWAY"
+    } elseif ($subnet.CIDR -like "10.0.2*") {
+        "WAN2_GATEWAY"
+    } else {
+        "WAN3_GATEWAY"
+    }
+    
+    New-OPNSenseRoute -Network $subnet.CIDR -Gateway $gateway -Description "Subnet $($subnet.CIDR)" -Force
+    Write-Output "Created route for network $($subnet.CIDR) via gateway $gateway"
+}
+
+# Apply the changes
+Apply-OPNSenseRouteChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Route changes are not applied until you call `Apply-OPNSenseRouteChanges`.
+- When creating a route, ensure that the gateway is properly configured and reachable.
+- Static routes take precedence over dynamic routes.
+- The network should be specified in CIDR notation (e.g., "192.168.1.0/24").
+- Routes can be temporarily disabled without removing them.
+- Consider using the `-PassThru` parameter when updating routes to verify the changes.
+- Route descriptions should be descriptive and follow a consistent naming convention.
+- When managing multiple routes, consider using a CSV file or other structured data source to maintain the route information.
+- Static routes are useful for directing traffic to specific networks through different gateways.
+- For complex routing scenarios, consider using policy-based routing instead of static routes.

docs/System-Backup-Restore.md

@@ -0,0 +1,296 @@
+# System Backup and Restore
+
+This component provides cmdlets for backing up and restoring OPNSense firewall configurations.
+
+## Overview
+
+The System Backup and Restore component allows you to create, download, upload, and restore backups of OPNSense firewall configurations. It provides cmdlets for managing full and partial backups, as well as scheduling automatic backups.
+
+## Cmdlets
+
+### Get-OPNSenseBackup
+
+Retrieves a list of available backups on an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get all available backups
+Get-OPNSenseBackup
+```
+
+### New-OPNSenseBackup
+
+Creates a new backup of an OPNSense firewall configuration.
+
+#### Parameters
+
+- **IncludeRRD** - Whether to include RRD data in the backup. Default is false.
+- **IncludeInstalled** - Whether to include installed packages in the backup. Default is false.
+- **Encrypted** - Whether to encrypt the backup. Default is false.
+- **Password** - The password to use for encryption.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic configuration backup
+New-OPNSenseBackup
+
+# Create a full backup including RRD data and installed packages
+New-OPNSenseBackup -IncludeRRD -IncludeInstalled
+
+# Create an encrypted backup
+New-OPNSenseBackup -Encrypted -Password "SecurePassword123"
+
+# Create a full encrypted backup without confirmation
+New-OPNSenseBackup -IncludeRRD -IncludeInstalled -Encrypted -Password "SecurePassword123" -Force
+```
+
+### Save-OPNSenseBackup
+
+Downloads a backup from an OPNSense firewall to a local file.
+
+#### Parameters
+
+- **BackupId** - The ID of the backup to download.
+- **Path** - The local path to save the backup to.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Download the latest backup
+$backups = Get-OPNSenseBackup
+$latestBackup = $backups | Sort-Object -Property Date -Descending | Select-Object -First 1
+Save-OPNSenseBackup -BackupId $latestBackup.Id -Path "C:\Backups\opnsense-backup.xml"
+
+# Download a specific backup
+Save-OPNSenseBackup -BackupId "config-1234567890.xml" -Path "C:\Backups\opnsense-specific-backup.xml"
+
+# Download a backup and overwrite existing file without confirmation
+Save-OPNSenseBackup -BackupId "config-1234567890.xml" -Path "C:\Backups\opnsense-backup.xml" -Force
+```
+
+### Restore-OPNSenseBackup
+
+Restores an OPNSense firewall configuration from a backup.
+
+#### Parameters
+
+- **BackupId** - The ID of the backup to restore.
+- **Password** - The password for encrypted backups.
+- **RebootAfterRestore** - Whether to reboot the firewall after restoring. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Restore a backup
+Restore-OPNSenseBackup -BackupId "config-1234567890.xml"
+
+# Restore an encrypted backup
+Restore-OPNSenseBackup -BackupId "config-1234567890.xml" -Password "SecurePassword123"
+
+# Restore a backup and reboot the firewall
+Restore-OPNSenseBackup -BackupId "config-1234567890.xml" -RebootAfterRestore
+
+# Restore a backup without confirmation
+Restore-OPNSenseBackup -BackupId "config-1234567890.xml" -Force
+```
+
+### Import-OPNSenseBackup
+
+Uploads and restores a backup file to an OPNSense firewall.
+
+#### Parameters
+
+- **Path** - The local path of the backup file to upload.
+- **Password** - The password for encrypted backups.
+- **RebootAfterRestore** - Whether to reboot the firewall after restoring. Default is false.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Upload and restore a backup
+Import-OPNSenseBackup -Path "C:\Backups\opnsense-backup.xml"
+
+# Upload and restore an encrypted backup
+Import-OPNSenseBackup -Path "C:\Backups\opnsense-encrypted-backup.xml" -Password "SecurePassword123"
+
+# Upload and restore a backup and reboot the firewall
+Import-OPNSenseBackup -Path "C:\Backups\opnsense-backup.xml" -RebootAfterRestore
+
+# Upload and restore a backup without confirmation
+Import-OPNSenseBackup -Path "C:\Backups\opnsense-backup.xml" -Force
+```
+
+### Remove-OPNSenseBackup
+
+Removes a backup from an OPNSense firewall.
+
+#### Parameters
+
+- **BackupId** - The ID of the backup to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a backup
+Remove-OPNSenseBackup -BackupId "config-1234567890.xml"
+
+# Remove a backup without confirmation
+Remove-OPNSenseBackup -BackupId "config-1234567890.xml" -Force
+```
+
+## Common Scenarios
+
+### Creating and Downloading a Backup
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a full backup
+New-OPNSenseBackup -IncludeRRD -IncludeInstalled -Force
+
+# Get the latest backup
+$backups = Get-OPNSenseBackup
+$latestBackup = $backups | Sort-Object -Property Date -Descending | Select-Object -First 1
+
+# Download the backup
+$backupPath = "C:\Backups\opnsense-$(Get-Date -Format 'yyyyMMdd-HHmmss').xml"
+Save-OPNSenseBackup -BackupId $latestBackup.Id -Path $backupPath -Force
+
+Write-Output "Backup saved to: $backupPath"
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Scheduled Backup with Rotation
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a new backup
+New-OPNSenseBackup -IncludeRRD -IncludeInstalled -Force
+
+# Get all backups
+$backups = Get-OPNSenseBackup
+
+# Keep only the 5 most recent backups
+if ($backups.Count -gt 5) {
+    $backupsToRemove = $backups | Sort-Object -Property Date -Descending | Select-Object -Skip 5
+    foreach ($backup in $backupsToRemove) {
+        Remove-OPNSenseBackup -BackupId $backup.Id -Force
+        Write-Output "Removed old backup: $($backup.Id)"
+    }
+}
+
+# Download the latest backup
+$latestBackup = $backups | Sort-Object -Property Date -Descending | Select-Object -First 1
+$backupPath = "C:\Backups\opnsense-$(Get-Date -Format 'yyyyMMdd').xml"
+Save-OPNSenseBackup -BackupId $latestBackup.Id -Path $backupPath -Force
+
+Write-Output "Backup saved to: $backupPath"
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Restoring from a Local Backup
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Upload and restore a backup
+$backupPath = "C:\Backups\opnsense-backup.xml"
+Import-OPNSenseBackup -Path $backupPath -RebootAfterRestore -Force
+
+Write-Output "Backup restored from: $backupPath"
+Write-Output "The firewall will reboot to apply the changes."
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Creating Encrypted Backups
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Generate a secure password
+$password = -join ((65..90) + (97..122) + (48..57) | Get-Random -Count 16 | ForEach-Object { [char]$_ })
+
+# Create an encrypted backup
+New-OPNSenseBackup -IncludeRRD -IncludeInstalled -Encrypted -Password $password -Force
+
+# Get the latest backup
+$backups = Get-OPNSenseBackup
+$latestBackup = $backups | Sort-Object -Property Date -Descending | Select-Object -First 1
+
+# Download the backup
+$backupPath = "C:\Backups\opnsense-encrypted-$(Get-Date -Format 'yyyyMMdd-HHmmss').xml"
+Save-OPNSenseBackup -BackupId $latestBackup.Id -Path $backupPath -Force
+
+# Save the password to a secure file
+$passwordPath = "C:\Backups\opnsense-backup-password.txt"
+$password | Out-File -FilePath $passwordPath -Force
+
+Write-Output "Encrypted backup saved to: $backupPath"
+Write-Output "Password saved to: $passwordPath"
+Write-Output "Keep the password file secure, as it is required to restore the backup."
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing Backup History
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all backups
+$backups = Get-OPNSenseBackup
+
+# Display backup information
+Write-Output "Available backups:"
+$backups | Format-Table -Property Id, Date, Size, Description
+
+# Calculate total backup size
+$totalSize = ($backups | Measure-Object -Property Size -Sum).Sum
+Write-Output "Total backup size: $($totalSize / 1MB) MB"
+
+# Remove backups older than 30 days
+$cutoffDate = (Get-Date).AddDays(-30)
+$oldBackups = $backups | Where-Object { [DateTime]::Parse($_.Date) -lt $cutoffDate }
+foreach ($backup in $oldBackups) {
+    Remove-OPNSenseBackup -BackupId $backup.Id -Force
+    Write-Output "Removed old backup: $($backup.Id) from $($backup.Date)"
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Backups can be large, especially when including RRD data and installed packages.
+- Encrypted backups provide additional security but require the password for restoration.
+- The `RebootAfterRestore` parameter will cause the firewall to reboot immediately after restoring a backup.
+- When restoring a backup, all current configuration settings will be replaced with those from the backup.
+- Consider implementing a backup rotation strategy to manage disk space.
+- Store backup passwords securely, as they are required to restore encrypted backups.
+- Regular backups are essential for disaster recovery.
+- Backup files contain sensitive information, so they should be stored securely.
+- The backup ID is typically in the format "config-timestamp.xml".
+- When scheduling automatic backups, consider using the `New-OPNSenseCronJob` cmdlet to create a scheduled task.
+- Backups can be used to migrate configurations between OPNSense firewalls.
+- Before major configuration changes, create a backup to allow for easy rollback if needed.

docs/Tailscale-Integration.md

@@ -0,0 +1,263 @@
+# Tailscale Integration
+
+This component provides cmdlets for managing Tailscale VPN on OPNSense firewalls.
+
+## Overview
+
+The Tailscale Integration component allows you to install, configure, and manage Tailscale VPN on OPNSense firewalls. It provides cmdlets for enabling Tailscale, configuring subnet routes, and managing the Tailscale connection.
+
+## Cmdlets
+
+### Get-OPNSenseTailscaleStatus
+
+Retrieves the status of Tailscale on an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get Tailscale status
+Get-OPNSenseTailscaleStatus
+```
+
+### Install-OPNSenseTailscale
+
+Installs the Tailscale plugin on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Install Tailscale
+Install-OPNSenseTailscale
+
+# Install Tailscale without confirmation
+Install-OPNSenseTailscale -Force
+```
+
+### Enable-OPNSenseTailscale
+
+Enables Tailscale on an OPNSense firewall.
+
+#### Parameters
+
+- **AuthKey** - The Tailscale authentication key.
+- **Hostname** - The hostname to use for the Tailscale node.
+- **AcceptDNS** - Whether to accept DNS settings from Tailscale.
+- **AcceptRoutes** - Whether to accept routes from Tailscale.
+- **AdvertiseRoutes** - The routes to advertise to Tailscale.
+- **ExitNode** - Whether to use this node as an exit node.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the Tailscale status.
+
+#### Examples
+
+```powershell
+# Enable Tailscale with basic settings
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456"
+
+# Enable Tailscale with a custom hostname
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -Hostname "opnsense-firewall"
+
+# Enable Tailscale with DNS and route acceptance
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -AcceptDNS -AcceptRoutes
+
+# Enable Tailscale with route advertisement
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -AdvertiseRoutes "192.168.1.0/24,10.0.0.0/8"
+
+# Enable Tailscale as an exit node
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -ExitNode
+```
+
+### Disable-OPNSenseTailscale
+
+Disables Tailscale on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Disable Tailscale
+Disable-OPNSenseTailscale
+
+# Disable Tailscale without confirmation
+Disable-OPNSenseTailscale -Force
+```
+
+### Set-OPNSenseTailscaleRoutes
+
+Updates the routes advertised by Tailscale on an OPNSense firewall.
+
+#### Parameters
+
+- **AdvertiseRoutes** - The routes to advertise to Tailscale.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the Tailscale status.
+
+#### Examples
+
+```powershell
+# Set Tailscale routes
+Set-OPNSenseTailscaleRoutes -AdvertiseRoutes "192.168.1.0/24,10.0.0.0/8"
+
+# Set Tailscale routes without confirmation
+Set-OPNSenseTailscaleRoutes -AdvertiseRoutes "192.168.1.0/24,10.0.0.0/8" -Force
+```
+
+### Get-OPNSenseTailscalePeers
+
+Retrieves the Tailscale peers connected to an OPNSense firewall.
+
+#### Examples
+
+```powershell
+# Get Tailscale peers
+Get-OPNSenseTailscalePeers
+```
+
+### Apply-OPNSenseTailscaleChanges
+
+Applies pending Tailscale changes on an OPNSense firewall.
+
+#### Parameters
+
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Apply Tailscale changes
+Apply-OPNSenseTailscaleChanges
+
+# Apply Tailscale changes without confirmation
+Apply-OPNSenseTailscaleChanges -Force
+```
+
+## Common Scenarios
+
+### Installing and Configuring Tailscale
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Install Tailscale
+Install-OPNSenseTailscale -Force
+
+# Enable Tailscale with basic settings
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -Hostname "opnsense-firewall" -Force
+
+# Apply the changes
+Apply-OPNSenseTailscaleChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Configuring Tailscale as a Subnet Router
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get the current network interfaces
+$interfaces = Get-OPNSenseInterface
+
+# Build a list of subnets to advertise
+$subnets = @()
+foreach ($interface in $interfaces) {
+    if ($interface.Name -ne "wan" -and $interface.IPv4Address) {
+        $subnet = "$($interface.IPv4Network)/$($interface.IPv4Subnet)"
+        $subnets += $subnet
+    }
+}
+
+# Join the subnets with commas
+$advertisedRoutes = $subnets -join ","
+
+# Enable Tailscale with route advertisement
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -AdvertiseRoutes $advertisedRoutes -Force
+
+# Apply the changes
+Apply-OPNSenseTailscaleChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Configuring Tailscale as an Exit Node
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Enable Tailscale as an exit node
+Enable-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -ExitNode -Force
+
+# Apply the changes
+Apply-OPNSenseTailscaleChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Updating Tailscale Routes
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get the current Tailscale status
+$status = Get-OPNSenseTailscaleStatus
+
+# Add a new subnet to the advertised routes
+$currentRoutes = $status.AdvertisedRoutes -split ","
+$newSubnet = "172.16.0.0/16"
+if ($currentRoutes -notcontains $newSubnet) {
+    $currentRoutes += $newSubnet
+}
+
+# Update the advertised routes
+$advertisedRoutes = $currentRoutes -join ","
+Set-OPNSenseTailscaleRoutes -AdvertiseRoutes $advertisedRoutes -Force
+
+# Apply the changes
+Apply-OPNSenseTailscaleChanges -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Monitoring Tailscale Peers
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get Tailscale peers
+$peers = Get-OPNSenseTailscalePeers
+
+# Display peer information
+$peers | Format-Table -Property Name, IP, Status, LastSeen
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Tailscale requires the Tailscale plugin to be installed on the OPNSense firewall.
+- The `Install-OPNSenseTailscale` cmdlet will install the plugin if it's not already installed.
+- Tailscale authentication keys can be generated from the Tailscale admin console.
+- Authentication keys are single-use and expire after a short period.
+- When advertising routes, ensure that the routes are valid and do not overlap with Tailscale's internal routes.
+- The `AcceptDNS` option allows Tailscale to configure DNS settings on the OPNSense firewall.
+- The `AcceptRoutes` option allows Tailscale to add routes to the OPNSense firewall.
+- The `ExitNode` option allows other Tailscale nodes to use the OPNSense firewall as an internet gateway.
+- Changes to Tailscale settings are not applied until you call `Apply-OPNSenseTailscaleChanges`.
+- Consider using the `-PassThru` parameter when updating Tailscale settings to verify the changes.

docs/Troubleshooting.md

@@ -0,0 +1,334 @@
+# Troubleshooting Guide
+
+This document provides troubleshooting information for common issues with the PSOPNSenseAPI module.
+
+## Connection Issues
+
+### Unable to Connect to OPNSense Firewall
+
+**Symptoms:**
+- `Connect-OPNSense` fails with connection errors
+- Error messages about unreachable hosts or connection timeouts
+
+**Possible Causes and Solutions:**
+
+1. **Incorrect URL:**
+   - Ensure the URL is correct and includes the protocol (https://)
+   - Verify there are no typos in the domain name or IP address
+
+   ```powershell
+   # Correct format
+   Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret"
+   ```
+
+2. **Network Connectivity:**
+   - Verify that you can reach the OPNSense firewall from your computer
+   - Try pinging the firewall or accessing the web interface in a browser
+
+   ```powershell
+   # Test connectivity
+   Test-NetConnection -ComputerName "firewall.example.com" -Port 443
+   ```
+
+3. **Certificate Issues:**
+   - If the firewall uses a self-signed certificate, use the `-SkipCertificateCheck` parameter
+
+   ```powershell
+   Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+   ```
+
+4. **Firewall Rules:**
+   - Check if there are any firewall rules blocking access to the OPNSense web interface
+   - Ensure that port 443 (HTTPS) is open for your IP address
+
+5. **Proxy Settings:**
+   - If you're behind a proxy, configure PowerShell to use the proxy
+
+   ```powershell
+   # Configure proxy
+   [System.Net.WebRequest]::DefaultWebProxy = New-Object System.Net.WebProxy("http://proxy.example.com:8080")
+   [System.Net.WebRequest]::DefaultWebProxy.Credentials = [System.Net.CredentialCache]::DefaultNetworkCredentials
+   ```
+
+### Authentication Failures
+
+**Symptoms:**
+- `Connect-OPNSense` fails with authentication errors
+- Error messages about invalid credentials or unauthorized access
+
+**Possible Causes and Solutions:**
+
+1. **Incorrect API Key or Secret:**
+   - Verify that the API key and secret are correct
+   - Regenerate the API key and secret if necessary
+
+2. **API Access Not Enabled:**
+   - Ensure that API access is enabled for the user
+   - Check the user's privileges in the OPNSense web interface
+
+3. **User Permissions:**
+   - Verify that the user has the necessary privileges for the operations you're trying to perform
+   - Consider using a user with administrative privileges for testing
+
+4. **API Key Expiration:**
+   - Some OPNSense configurations may have API key expiration
+   - Generate a new API key if the current one has expired
+
+## Module Loading Issues
+
+### Module Not Found
+
+**Symptoms:**
+- `Import-Module PSOPNSenseAPI` fails with module not found errors
+- Commands from the module are not recognized
+
+**Possible Causes and Solutions:**
+
+1. **Module Not Installed:**
+   - Verify that the module is installed
+
+   ```powershell
+   # Check if the module is installed
+   Get-Module -Name PSOPNSenseAPI -ListAvailable
+   ```
+
+2. **Module Not in PSModulePath:**
+   - Check if the module is installed in a valid module path
+
+   ```powershell
+   # List module paths
+   $env:PSModulePath -split ';'
+   ```
+
+3. **Module Version Mismatch:**
+   - Check if you have multiple versions of the module installed
+
+   ```powershell
+   # List all versions of the module
+   Get-Module -Name PSOPNSenseAPI -ListAvailable | Select-Object Name, Version
+   ```
+
+4. **PowerShell Version Compatibility:**
+   - Verify that you're using a compatible PowerShell version
+   - The module requires PowerShell 5.1 or later
+
+   ```powershell
+   # Check PowerShell version
+   $PSVersionTable
+   ```
+
+### Module Loading Errors
+
+**Symptoms:**
+- `Import-Module PSOPNSenseAPI` fails with loading errors
+- Error messages about missing dependencies or assembly loading failures
+
+**Possible Causes and Solutions:**
+
+1. **Missing Dependencies:**
+   - Ensure that all dependencies are installed
+   - The module requires .NET Framework 4.7.2 or later for Windows PowerShell
+
+2. **Assembly Loading Issues:**
+   - Try loading the module with verbose output to identify the specific issue
+
+   ```powershell
+   # Load module with verbose output
+   Import-Module -Name PSOPNSenseAPI -Verbose
+   ```
+
+3. **File Corruption:**
+   - Reinstall the module to ensure all files are intact
+
+   ```powershell
+   # Uninstall and reinstall the module
+   Uninstall-Module -Name PSOPNSenseAPI -Force
+   Install-Module -Name PSOPNSenseAPI -Force
+   ```
+
+## Command Execution Issues
+
+### Command Fails with Error
+
+**Symptoms:**
+- Commands fail with error messages
+- Unexpected results or behavior
+
+**Possible Causes and Solutions:**
+
+1. **Not Connected to Firewall:**
+   - Ensure that you're connected to the firewall before running commands
+
+   ```powershell
+   # Check if connected
+   if (-not $OPNSenseSessionState.Instance.ApiClient) {
+       Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret"
+   }
+   ```
+
+2. **Insufficient Permissions:**
+   - Verify that the user has the necessary privileges for the operation
+   - Check the error message for permission-related issues
+
+3. **Invalid Parameters:**
+   - Check that you're using the correct parameters and values
+   - Use `Get-Help` to see the required and optional parameters
+
+   ```powershell
+   # Get help for a command
+   Get-Help -Name New-OPNSenseFirewallRule -Full
+   ```
+
+4. **API Limitations:**
+   - Some operations may not be supported by the OPNSense API
+   - Check the OPNSense API documentation for supported operations
+
+5. **Firewall Configuration:**
+   - The current state of the firewall may prevent certain operations
+   - Check the OPNSense logs for more information
+
+### Changes Not Applied
+
+**Symptoms:**
+- Commands appear to succeed, but changes are not reflected on the firewall
+- Configuration changes don't persist after a firewall reboot
+
+**Possible Causes and Solutions:**
+
+1. **Apply Changes Not Called:**
+   - Many commands require an explicit call to apply the changes
+
+   ```powershell
+   # Apply changes after making configuration changes
+   Apply-OPNSenseFirewallChanges
+   ```
+
+2. **Caching Issues:**
+   - The OPNSense web interface may be showing cached data
+   - Refresh the web interface or wait a few moments
+
+3. **Conflicting Configurations:**
+   - Other configurations may be overriding your changes
+   - Check for conflicting rules or settings
+
+4. **Firewall Reboot Required:**
+   - Some changes may require a firewall reboot to take effect
+
+   ```powershell
+   # Reboot the firewall
+   Invoke-OPNSenseReboot
+   ```
+
+## Performance Issues
+
+### Slow Command Execution
+
+**Symptoms:**
+- Commands take a long time to execute
+- Timeouts or performance degradation
+
+**Possible Causes and Solutions:**
+
+1. **Network Latency:**
+   - High latency between your computer and the firewall can slow down commands
+   - Consider running commands from a location with better connectivity
+
+2. **Firewall Load:**
+   - The firewall may be under heavy load
+   - Try running commands during periods of lower activity
+
+3. **Large Data Sets:**
+   - Commands that retrieve large amounts of data may be slow
+   - Use filtering parameters to limit the data returned
+
+   ```powershell
+   # Filter results to reduce data
+   Get-OPNSenseFirewallRule -Interface "lan"
+   ```
+
+4. **Inefficient Scripts:**
+   - Scripts that make many individual API calls can be slow
+   - Batch operations where possible and minimize the number of API calls
+
+## Logging and Debugging
+
+### Enabling Verbose Logging
+
+To troubleshoot issues, you can enable verbose logging:
+
+```powershell
+# Enable verbose output
+$VerbosePreference = "Continue"
+
+# Run commands with verbose output
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -Verbose
+```
+
+### Capturing HTTP Traffic
+
+For advanced troubleshooting, you can capture the HTTP traffic between the module and the OPNSense firewall:
+
+```powershell
+# Enable Fiddler capture
+[System.Net.WebRequest]::DefaultWebProxy = New-Object System.Net.WebProxy("http://localhost:8888")
+[System.Net.WebRequest]::DefaultWebProxy.BypassProxyOnLocal = $false
+```
+
+Note: This requires [Fiddler](https://www.telerik.com/fiddler) or a similar HTTP debugging proxy to be installed and running.
+
+### Checking OPNSense Logs
+
+Check the OPNSense logs for additional information:
+
+1. Log in to the OPNSense web interface
+2. Navigate to **System > Log Files > General**
+3. Look for entries related to the API or the operations you're performing
+
+## Common Error Messages
+
+### "Not connected to an OPNSense firewall"
+
+**Cause:** You're trying to run a command without first connecting to the firewall.
+
+**Solution:** Connect to the firewall before running commands:
+
+```powershell
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret"
+```
+
+### "The remote server returned an error: (401) Unauthorized"
+
+**Cause:** The API key or secret is incorrect, or the user doesn't have the necessary privileges.
+
+**Solution:** Verify the API key and secret, and check the user's privileges.
+
+### "The remote server returned an error: (404) Not Found"
+
+**Cause:** The requested resource or API endpoint doesn't exist.
+
+**Solution:** Check that you're using the correct command and parameters, and that the resource exists on the firewall.
+
+### "The remote server returned an error: (500) Internal Server Error"
+
+**Cause:** An error occurred on the OPNSense firewall while processing the request.
+
+**Solution:** Check the OPNSense logs for more information, and verify that the firewall is functioning correctly.
+
+### "Unable to find type [System.Net.IPNetwork.IPNetwork]"
+
+**Cause:** The IPNetwork2 assembly is not loaded or is missing.
+
+**Solution:** Reinstall the module to ensure all dependencies are properly installed.
+
+## Getting Help
+
+If you're still experiencing issues after trying the troubleshooting steps above:
+
+1. Check the [GitHub repository](https://github.com/freedbygrace/PSOPNSenseAPI) for known issues and solutions
+2. Open an issue on GitHub with detailed information about the problem
+3. Include the following information in your issue:
+   - PSOPNSenseAPI module version
+   - PowerShell version
+   - OPNSense version
+   - Error messages (with sensitive information redacted)
+   - Steps to reproduce the issue

docs/User-Management.md

@@ -0,0 +1,388 @@
+# User Management
+
+This component provides cmdlets for managing users on OPNSense firewalls.
+
+## Overview
+
+The User Management component allows you to create, view, modify, and delete users on OPNSense firewalls. It provides cmdlets for managing user accounts, privileges, and API keys.
+
+## Cmdlets
+
+### Get-OPNSenseUser
+
+Retrieves users from an OPNSense firewall.
+
+#### Parameters
+
+- **Username** - The username of a specific user to retrieve. If not specified, all users are returned.
+- **Uid** - The UID of a specific user to retrieve.
+
+#### Examples
+
+```powershell
+# Get all users
+Get-OPNSenseUser
+
+# Get a specific user by username
+Get-OPNSenseUser -Username "admin"
+
+# Get a specific user by UID
+Get-OPNSenseUser -Uid 1000
+```
+
+### New-OPNSenseUser
+
+Creates a new user on an OPNSense firewall.
+
+#### Parameters
+
+- **Username** - The username for the new user.
+- **Password** - The password for the new user.
+- **FullName** - The full name of the user.
+- **Email** - The email address of the user.
+- **Authorized** - Whether the user is authorized to log in. Default is true.
+- **Privileges** - The privileges to assign to the user.
+- **Group** - The group to assign the user to.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic user
+New-OPNSenseUser -Username "john" -Password "SecurePassword123" -FullName "John Doe" -Email "john@example.com"
+
+# Create a user with specific privileges
+New-OPNSenseUser -Username "jane" -Password "SecurePassword456" -FullName "Jane Smith" -Email "jane@example.com" -Privileges "page-system-access", "page-diagnostics-logs"
+
+# Create a user in a specific group
+New-OPNSenseUser -Username "bob" -Password "SecurePassword789" -FullName "Bob Johnson" -Email "bob@example.com" -Group "admins"
+
+# Create a user without confirmation
+New-OPNSenseUser -Username "alice" -Password "SecurePassword101" -FullName "Alice Brown" -Email "alice@example.com" -Force
+```
+
+### Set-OPNSenseUser
+
+Updates an existing user on an OPNSense firewall.
+
+#### Parameters
+
+- **Username** - The username of the user to update.
+- **Password** - The new password for the user.
+- **FullName** - The new full name of the user.
+- **Email** - The new email address of the user.
+- **Authorized** - Whether the user is authorized to log in.
+- **Privileges** - The new privileges to assign to the user.
+- **Group** - The new group to assign the user to.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated user.
+
+#### Examples
+
+```powershell
+# Update a user's email address
+Set-OPNSenseUser -Username "john" -Email "john.doe@example.com"
+
+# Update a user's password
+Set-OPNSenseUser -Username "jane" -Password "NewSecurePassword456"
+
+# Update a user's privileges
+Set-OPNSenseUser -Username "bob" -Privileges "page-system-access", "page-diagnostics-logs", "page-firewall-rules"
+
+# Update a user's group
+Set-OPNSenseUser -Username "alice" -Group "operators"
+
+# Disable a user
+Set-OPNSenseUser -Username "temp" -Authorized:$false
+
+# Update multiple properties of a user
+Set-OPNSenseUser -Username "john" -FullName "John A. Doe" -Email "john.a.doe@example.com" -Privileges "page-system-access", "page-diagnostics-logs" -PassThru
+```
+
+### Remove-OPNSenseUser
+
+Removes a user from an OPNSense firewall.
+
+#### Parameters
+
+- **Username** - The username of the user to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a user
+Remove-OPNSenseUser -Username "temp"
+
+# Remove a user without confirmation
+Remove-OPNSenseUser -Username "guest" -Force
+```
+
+### Get-OPNSenseUserGroup
+
+Retrieves user groups from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of a specific group to retrieve. If not specified, all groups are returned.
+
+#### Examples
+
+```powershell
+# Get all user groups
+Get-OPNSenseUserGroup
+
+# Get a specific user group by name
+Get-OPNSenseUserGroup -Name "admins"
+```
+
+### New-OPNSenseUserGroup
+
+Creates a new user group on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the new group.
+- **Description** - A description for the group.
+- **Privileges** - The privileges to assign to the group.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a basic user group
+New-OPNSenseUserGroup -Name "operators" -Description "System Operators"
+
+# Create a user group with specific privileges
+New-OPNSenseUserGroup -Name "firewall-admins" -Description "Firewall Administrators" -Privileges "page-firewall-rules", "page-firewall-nat"
+
+# Create a user group without confirmation
+New-OPNSenseUserGroup -Name "readonly" -Description "Read-Only Users" -Privileges "page-system-access" -Force
+```
+
+### Set-OPNSenseUserGroup
+
+Updates an existing user group on an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the group to update.
+- **Description** - The new description for the group.
+- **Privileges** - The new privileges to assign to the group.
+- **Force** - Suppresses the confirmation prompt.
+- **PassThru** - Returns the updated group.
+
+#### Examples
+
+```powershell
+# Update a user group's description
+Set-OPNSenseUserGroup -Name "operators" -Description "System Operators with Limited Access"
+
+# Update a user group's privileges
+Set-OPNSenseUserGroup -Name "firewall-admins" -Privileges "page-firewall-rules", "page-firewall-nat", "page-firewall-aliases"
+
+# Update multiple properties of a user group
+Set-OPNSenseUserGroup -Name "readonly" -Description "Read-Only Access Users" -Privileges "page-system-access", "page-diagnostics-logs" -PassThru
+```
+
+### Remove-OPNSenseUserGroup
+
+Removes a user group from an OPNSense firewall.
+
+#### Parameters
+
+- **Name** - The name of the group to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a user group
+Remove-OPNSenseUserGroup -Name "temp-group"
+
+# Remove a user group without confirmation
+Remove-OPNSenseUserGroup -Name "guest-group" -Force
+```
+
+### Get-OPNSenseApiKey
+
+Retrieves API keys for a user on an OPNSense firewall.
+
+#### Parameters
+
+- **Username** - The username to get API keys for.
+
+#### Examples
+
+```powershell
+# Get API keys for a user
+Get-OPNSenseApiKey -Username "admin"
+```
+
+### New-OPNSenseApiKey
+
+Creates a new API key for a user on an OPNSense firewall.
+
+#### Parameters
+
+- **Username** - The username to create an API key for.
+- **Description** - A description for the API key.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create an API key for a user
+New-OPNSenseApiKey -Username "admin" -Description "Automation API Key"
+
+# Create an API key without confirmation
+New-OPNSenseApiKey -Username "john" -Description "Monitoring API Key" -Force
+```
+
+### Remove-OPNSenseApiKey
+
+Removes an API key from an OPNSense firewall.
+
+#### Parameters
+
+- **KeyId** - The ID of the API key to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove an API key
+Remove-OPNSenseApiKey -KeyId "abcdef123456"
+
+# Remove an API key without confirmation
+Remove-OPNSenseApiKey -KeyId "abcdef123456" -Force
+```
+
+## Common Scenarios
+
+### Creating a New Administrator User
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create a new administrator user
+New-OPNSenseUser -Username "admin2" -Password "SecurePassword123" -FullName "Secondary Admin" -Email "admin2@example.com" -Group "admins" -Force
+
+# Create an API key for the new user
+New-OPNSenseApiKey -Username "admin2" -Description "Admin API Key" -Force
+
+# Get the API key details
+$apiKeys = Get-OPNSenseApiKey -Username "admin2"
+Write-Output "API Key created for admin2:"
+$apiKeys | Format-Table -Property KeyId, Secret, Description, Created
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Creating Users with Different Privilege Levels
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Create user groups with different privilege levels
+New-OPNSenseUserGroup -Name "firewall-admins" -Description "Firewall Administrators" -Privileges "page-firewall-rules", "page-firewall-nat", "page-firewall-aliases" -Force
+New-OPNSenseUserGroup -Name "network-admins" -Description "Network Administrators" -Privileges "page-interfaces", "page-routing", "page-diagnostics-interface" -Force
+New-OPNSenseUserGroup -Name "monitoring" -Description "Monitoring Users" -Privileges "page-diagnostics-logs", "page-diagnostics-system", "page-status-dashboard" -Force
+
+# Create users in different groups
+$users = @(
+    @{ Username = "firewall"; FullName = "Firewall Admin"; Email = "firewall@example.com"; Group = "firewall-admins" },
+    @{ Username = "network"; FullName = "Network Admin"; Email = "network@example.com"; Group = "network-admins" },
+    @{ Username = "monitor"; FullName = "Monitoring User"; Email = "monitor@example.com"; Group = "monitoring" }
+)
+
+foreach ($user in $users) {
+    # Generate a secure password
+    $password = -join ((65..90) + (97..122) + (48..57) | Get-Random -Count 16 | ForEach-Object { [char]$_ })
+    
+    # Create the user
+    New-OPNSenseUser -Username $user.Username -Password $password -FullName $user.FullName -Email $user.Email -Group $user.Group -Force
+    
+    Write-Output "Created user: $($user.Username) with password: $password"
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Managing API Keys
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all users
+$users = Get-OPNSenseUser
+
+# Create API keys for users without them
+foreach ($user in $users) {
+    $apiKeys = Get-OPNSenseApiKey -Username $user.Username
+    
+    if (-not $apiKeys) {
+        New-OPNSenseApiKey -Username $user.Username -Description "Automated API Key" -Force
+        Write-Output "Created API key for user: $($user.Username)"
+    } else {
+        Write-Output "User $($user.Username) already has $($apiKeys.Count) API key(s)"
+    }
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Cleaning Up Inactive Users
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all users
+$users = Get-OPNSenseUser
+
+# Define a cutoff date (e.g., 90 days ago)
+$cutoffDate = (Get-Date).AddDays(-90)
+
+# Disable inactive users
+foreach ($user in $users) {
+    # Skip the admin user
+    if ($user.Username -eq "admin") {
+        continue
+    }
+    
+    # Check if the user has been inactive
+    if ($user.LastLogin -and [DateTime]::Parse($user.LastLogin) -lt $cutoffDate) {
+        Set-OPNSenseUser -Username $user.Username -Authorized:$false -Force
+        Write-Output "Disabled inactive user: $($user.Username) (Last login: $($user.LastLogin))"
+    }
+}
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- User management requires administrative privileges.
+- The `admin` user cannot be removed.
+- API keys provide access to the OPNSense API and should be kept secure.
+- User privileges determine what actions a user can perform in the OPNSense web interface and API.
+- User groups provide a way to assign the same privileges to multiple users.
+- Passwords should be strong and meet the OPNSense password policy requirements.
+- When a user is removed, all associated API keys are also removed.
+- API keys can be used to authenticate with the OPNSense API without a username and password.
+- Consider using the `-Force` parameter when managing users in scripts to avoid confirmation prompts.
+- User accounts can be disabled by setting the `Authorized` parameter to `$false`.
+- The `PassThru` parameter can be used to return the updated user or group for further processing.
+- User privileges are typically specified as page identifiers (e.g., "page-system-access").
+- The available privileges can be found in the OPNSense web interface under System > Access > Privileges.
+- User groups can be used to organize users and assign privileges more efficiently.
+- API keys can have descriptions to help identify their purpose.
+- When creating API keys, both the key ID and secret are returned, but the secret is only shown once.

docs/VLAN-Subnet-Management.md

@@ -0,0 +1,173 @@
+# VLAN and Subnet Management
+
+This component provides cmdlets for managing VLANs and subnets on OPNSense firewalls.
+
+## Overview
+
+The VLAN and Subnet Management component allows you to create, view, modify, and delete VLANs on OPNSense firewalls. It also includes advanced functionality for automatically creating VLANs from subnet divisions, making it easy to implement complex network segmentation.
+
+## Cmdlets
+
+### Get-OPNSenseVLAN
+
+Retrieves VLAN configurations from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of a specific VLAN to retrieve. If not specified, all VLANs are returned.
+
+#### Examples
+
+```powershell
+# Get all VLANs
+Get-OPNSenseVLAN
+
+# Get a specific VLAN by UUID
+Get-OPNSenseVLAN -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+```
+
+### New-OPNSenseVLAN
+
+Creates a new VLAN on an OPNSense firewall.
+
+#### Parameters
+
+- **Interface** - The parent interface for the VLAN.
+- **Tag** - The VLAN tag (1-4094).
+- **Priority** - The VLAN priority (0-7).
+- **Description** - A description for the VLAN.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create a new VLAN
+New-OPNSenseVLAN -Interface "em0" -Tag 10 -Description "Management VLAN"
+
+# Create a new VLAN with priority and without confirmation
+New-OPNSenseVLAN -Interface "em1" -Tag 20 -Priority 5 -Description "Voice VLAN" -Force
+```
+
+### Remove-OPNSenseVLAN
+
+Removes a VLAN from an OPNSense firewall.
+
+#### Parameters
+
+- **Uuid** - The UUID of the VLAN to remove.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Remove a VLAN
+Remove-OPNSenseVLAN -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
+
+# Remove a VLAN without confirmation
+Remove-OPNSenseVLAN -Uuid "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" -Force
+```
+
+### New-OPNSenseSubnetVLANs
+
+Creates VLANs for subnets by dividing a network into smaller subnets.
+
+#### Parameters
+
+- **ParentInterface** - The parent interface for the VLANs.
+- **Network** - The network in CIDR notation to divide into subnets.
+- **SubnetMaskBits** - The subnet mask bits for the subnets.
+- **StartingVlanId** - The starting VLAN ID.
+- **VlanIdIncrement** - The increment for VLAN IDs.
+- **DescriptionPrefix** - The prefix for VLAN descriptions.
+- **EnableDHCP** - Whether to enable DHCP on the created VLANs.
+- **DHCPRangeStart** - The starting IP address for the DHCP range.
+- **DHCPRangeEnd** - The ending IP address for the DHCP range.
+- **DHCPDomain** - The domain name for DHCP clients.
+- **DHCPDnsServers** - The DNS servers for DHCP clients.
+- **Force** - Suppresses the confirmation prompt.
+
+#### Examples
+
+```powershell
+# Create VLANs for subnets with sequential VLAN IDs
+New-OPNSenseSubnetVLANs -ParentInterface "em0" -Network "192.168.0.0/24" -SubnetMaskBits 27 -StartingVlanId 10 -VlanIdIncrement 1
+
+# Create VLANs for subnets with VLAN IDs in multiples of 10
+New-OPNSenseSubnetVLANs -ParentInterface "em1" -Network "10.0.0.0/16" -SubnetMaskBits 24 -StartingVlanId 100 -VlanIdIncrement 10
+
+# Create VLANs for subnets with DHCP enabled
+New-OPNSenseSubnetVLANs -ParentInterface "em2" -Network "172.16.0.0/20" -SubnetMaskBits 24 -StartingVlanId 200 -VlanIdIncrement 1 -EnableDHCP -DescriptionPrefix "VLAN-DHCP"
+
+# Create VLANs with custom DHCP settings
+New-OPNSenseSubnetVLANs -ParentInterface "em3" -Network "192.168.100.0/24" -SubnetMaskBits 26 -StartingVlanId 300 -EnableDHCP -DHCPDomain "example.com" -DHCPDnsServers "8.8.8.8","8.8.4.4"
+```
+
+## Common Scenarios
+
+### Basic VLAN Management
+
+```powershell
+# Get all VLANs
+$vlans = Get-OPNSenseVLAN
+$vlans | Format-Table -Property Uuid, Tag, Interface, Description
+
+# Create a new VLAN
+New-OPNSenseVLAN -Interface "em0" -Tag 100 -Description "Server VLAN"
+
+# Remove a VLAN
+$vlanToRemove = $vlans | Where-Object { $_.Description -eq "Temporary VLAN" }
+if ($vlanToRemove) {
+    Remove-OPNSenseVLAN -Uuid $vlanToRemove.Uuid -Force
+}
+```
+
+### Network Segmentation with VLANs
+
+```powershell
+# Create VLANs for different departments
+$departments = @{
+    "Management" = 10
+    "Finance" = 20
+    "HR" = 30
+    "Engineering" = 40
+    "Sales" = 50
+    "Guest" = 60
+}
+
+foreach ($dept in $departments.GetEnumerator()) {
+    New-OPNSenseVLAN -Interface "em0" -Tag $dept.Value -Description "$($dept.Key) VLAN" -Force
+}
+```
+
+### Automated Subnet Division with VLANs
+
+```powershell
+# Divide a /24 network into /27 subnets (8 subnets) with VLANs
+New-OPNSenseSubnetVLANs -ParentInterface "em0" -Network "192.168.1.0/24" -SubnetMaskBits 27 -StartingVlanId 100 -VlanIdIncrement 1 -DescriptionPrefix "Dept-"
+
+# Divide a /16 network into /20 subnets (16 subnets) with VLANs in multiples of 10
+New-OPNSenseSubnetVLANs -ParentInterface "em1" -Network "10.0.0.0/16" -SubnetMaskBits 20 -StartingVlanId 100 -VlanIdIncrement 10 -DescriptionPrefix "Branch-"
+
+# Create VLANs with DHCP for a campus network
+New-OPNSenseSubnetVLANs -ParentInterface "em2" -Network "172.16.0.0/16" -SubnetMaskBits 22 -StartingVlanId 200 -VlanIdIncrement 1 -EnableDHCP -DescriptionPrefix "Campus-" -DHCPDomain "campus.example.com"
+```
+
+### Creating a Multi-Tenant Network
+
+```powershell
+# Create a multi-tenant network with VLANs and DHCP
+$tenantNetwork = "10.100.0.0/16"
+$tenantCount = 16  # Number of tenants
+$subnetMaskBits = 20  # /20 networks for each tenant (4,094 hosts per tenant)
+
+New-OPNSenseSubnetVLANs -ParentInterface "em0" -Network $tenantNetwork -SubnetMaskBits $subnetMaskBits -StartingVlanId 1000 -VlanIdIncrement 1 -EnableDHCP -DescriptionPrefix "Tenant-" -DHCPDomain "tenants.example.com" -DHCPDnsServers "10.0.0.1","10.0.0.2"
+```
+
+## Notes
+
+- When creating VLANs, ensure that the parent interface supports VLAN tagging.
+- The `New-OPNSenseSubnetVLANs` cmdlet automatically creates interfaces for each VLAN.
+- If DHCP is enabled, the cmdlet configures DHCP servers for each VLAN with appropriate ranges.
+- The VLAN ID must be between 1 and 4094, and must be unique for each parent interface.
+- When dividing networks, ensure that the subnet mask bits are larger than the original network's mask bits (e.g., dividing a /24 into /27 subnets).
+- The cmdlet automatically calculates appropriate gateway addresses for each subnet (first usable IP address).

docs/Visual-Studio-Solution.md

@@ -0,0 +1,132 @@
+# Visual Studio Solution
+
+This document provides information about the Visual Studio solution for the PSOPNSenseAPI project.
+
+## Overview
+
+The PSOPNSenseAPI solution is a Visual Studio solution that contains the source code for the PSOPNSenseAPI PowerShell module. The solution is designed to be opened in Visual Studio for development, debugging, and troubleshooting.
+
+## Solution Structure
+
+The solution contains the following projects:
+
+- **PSOPNSenseAPI**: The main project containing the PowerShell module code.
+
+## Opening the Solution
+
+To open the solution in Visual Studio:
+
+1. Launch Visual Studio
+2. Select "Open a project or solution"
+3. Navigate to the root directory of the PSOPNSenseAPI repository
+4. Select the `PSOPNSenseAPI.sln` file
+5. Click "Open"
+
+## Building the Solution
+
+To build the solution in Visual Studio:
+
+1. Open the solution in Visual Studio
+2. Select the desired build configuration (Debug or Release) from the dropdown in the toolbar
+3. Select "Build > Build Solution" from the menu or press F6
+
+Alternatively, you can build the solution from the command line using the build scripts:
+
+```powershell
+# Build the module
+.\build\build.ps1
+
+# Build a release version with automatic versioning
+.\build\build-release.ps1 -Clean -Test -Package
+```
+
+## Debugging
+
+To debug the module in Visual Studio:
+
+1. Open the solution in Visual Studio
+2. Set breakpoints in the code
+3. Select "Debug > Start Debugging" from the menu or press F5
+
+For debugging PowerShell cmdlets, you can also use the PowerShell Integrated Scripting Environment (ISE) or Visual Studio Code with the PowerShell extension.
+
+## Troubleshooting IPNetwork2 Issues
+
+If you encounter issues with the IPNetwork2 library, here are some common troubleshooting steps:
+
+1. **Check the reference**: Ensure that the IPNetwork2 package is properly referenced in the project file.
+   ```xml
+   <PackageReference Include="IPNetwork2" Version="2.6.618" />
+   ```
+
+2. **Verify the namespace**: The correct namespace for IPNetwork2 is `System.Net.IPNetwork`.
+   ```csharp
+   using System.Net.IPNetwork;
+   ```
+
+3. **Check the class name**: The main class in IPNetwork2 is `IPNetwork`, not `IPNetwork2`.
+   ```csharp
+   // Correct usage
+   System.Net.IPNetwork.IPNetwork network = System.Net.IPNetwork.IPNetwork.Parse("192.168.1.0/24");
+   
+   // Incorrect usage
+   IPNetwork2 network = IPNetwork2.Parse("192.168.1.0/24");
+   ```
+
+4. **Update package references**: If you're still having issues, try updating the package reference to the latest version.
+   ```powershell
+   # In Package Manager Console
+   Update-Package IPNetwork2
+   ```
+
+5. **Restore NuGet packages**: Ensure all NuGet packages are properly restored.
+   ```powershell
+   # In Package Manager Console
+   Restore-Package
+   ```
+
+6. **Clean and rebuild**: Sometimes a clean rebuild can resolve reference issues.
+   ```powershell
+   # In Package Manager Console
+   Clean-Project
+   Build-Project
+   ```
+
+## Adding New Features
+
+When adding new features to the solution:
+
+1. Create appropriate model classes in the `Models` directory
+2. Implement service classes in the `Services` directory
+3. Create PowerShell cmdlets in the `Cmdlets` directory
+4. Update the module manifest (`PSOPNSenseAPI.psd1`) to export the new cmdlets
+5. Add tests for the new features
+6. Update documentation
+
+## Testing
+
+The solution includes unit tests that can be run from Visual Studio using the Test Explorer or from the command line:
+
+```powershell
+# Run tests
+.\build\test.ps1
+```
+
+## Continuous Integration
+
+The project uses GitHub Actions for continuous integration. The CI workflow builds and tests the solution on every push to the main branch.
+
+## Dependencies
+
+The solution has the following dependencies:
+
+- PowerShellStandard.Library (5.1.1)
+- Newtonsoft.Json (13.0.3)
+- System.Net.Http (4.3.4)
+- IPNetwork2 (2.6.618)
+
+## Notes
+
+- The solution is configured to target both .NET Framework 4.7.2 and .NET Standard 2.0 to support both Windows PowerShell 5.1 and PowerShell 7+.
+- The module uses a versioning scheme of `yyyy.MM.dd.HHmm` for releases, which is automatically generated during the build process.
+- The solution includes XML documentation comments that are used to generate help content for the PowerShell cmdlets.

docs/en-US/about_PSOPNSenseAPI.help.txt

@@ -0,0 +1,135 @@
+TOPIC
+    about_PSOPNSenseAPI
+
+SHORT DESCRIPTION
+    PowerShell module for interacting with the OPNSense API to configure firewalls.
+
+LONG DESCRIPTION
+    The PSOPNSenseAPI module provides cmdlets for managing OPNSense firewalls through their API.
+    It allows you to perform various firewall management tasks such as:
+
+    - Managing firewall rules (create, read, update, delete)
+    - Configuring NAT rules and port forwarding
+    - Managing aliases and address groups
+    - Managing network interfaces and VLANs
+    - Configuring DNS settings and overrides
+    - Backing up, restoring, exporting, and importing configurations
+    - Managing plugins (install, uninstall, enable, disable)
+    - Managing users and permissions
+    - Updating and upgrading firmware
+    - Rebooting firewall with wait for reconnection
+    - Creating VLANs from subnet divisions
+    - Configuring DHCP servers and static mappings
+    - Managing cron jobs
+    - Configuring and managing Tailscale VPN (with auto-installation)
+    - Applying and reverting configuration changes
+
+    The module is built as a binary module in C# and is compatible with both PowerShell 5.1 and PowerShell 7.
+
+EXAMPLES
+    Connect to an OPNSense firewall:
+
+    Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret"
+
+    Get all firewall rules:
+
+    Get-OPNSenseFirewallRule
+
+    Create a new firewall rule:
+
+    New-OPNSenseFirewallRule -Description "Allow HTTP" -Protocol TCP -DestinationPort 80 -Action pass
+
+    Apply changes:
+
+    Apply-OPNSenseFirewallChanges
+
+    Manage interfaces:
+
+    Get-OPNSenseInterface
+    Set-OPNSenseInterface -Name "lan" -Description "Local Network" -IpAddress "192.168.1.1" -SubnetMask "24"
+
+    Create VLANs from subnet divisions:
+
+    New-OPNSenseSubnetVLANs -ParentInterface "em0" -Network "192.168.0.0/24" -SubnetMaskBits 27 -StartingVlanId 10 -VlanIdIncrement 10
+
+    Configure DNS:
+
+    Set-OPNSenseDNSServer -Forwarding -Forwarders "8.8.8.8","8.8.4.4" -Apply
+    New-OPNSenseDNSOverride -Hostname "server" -Domain "local" -IpAddress "192.168.1.10"
+
+    Manage plugins:
+
+    Get-OPNSensePlugin -Installed
+    Install-OPNSensePlugin -Name "os-acme-client" -Wait
+
+    Manage users:
+
+    New-OPNSenseUser -Username "john" -Password "P@ssw0rd" -FullName "John Doe" -Groups "admins"
+
+    Configure DHCP:
+
+    Get-OPNSenseDHCPServer
+    Set-OPNSenseDHCPServer -Interface "lan" -RangeFrom "192.168.1.100" -RangeTo "192.168.1.200" -Apply
+    New-OPNSenseDHCPStaticMapping -Interface "lan" -MacAddress "00:11:22:33:44:55" -IpAddress "192.168.1.50"
+
+    Manage cron jobs:
+
+    Get-OPNSenseCronJob
+    New-OPNSenseCronJob -Description "Daily backup" -Command "/usr/local/bin/backup.sh" -Minutes "0" -Hours "2" -Apply
+
+    Configure and manage Tailscale:
+
+    Get-OPNSenseTailscaleStatus -IncludeInterfaces
+    Enable-OPNSenseTailscale -AcceptDns -AcceptRoutes -Force
+    # Advertise subnet routes to Tailscale network
+    Enable-OPNSenseTailscale -AdvertiseRoutes -SubnetRoutes "192.168.1.0/24","10.0.0.0/8" -Force
+    Connect-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -InstallIfMissing -Force
+
+    Firmware management:
+
+    Update-OPNSenseFirmware -Wait
+
+    Reboot firewall:
+
+    Restart-OPNSenseFirewall -Wait -Timeout 300
+
+    Backup and restore configuration:
+
+    Backup-OPNSenseConfig -Filename "pre-upgrade-backup"
+    Export-OPNSenseConfig -Path "C:\Backups\opnsense-config.xml"
+
+KEYWORDS
+    OPNSense, Firewall, API, Network, Security
+
+SEE ALSO
+    Connect-OPNSense
+    Disconnect-OPNSense
+    Get-OPNSenseFirewallRule
+    New-OPNSenseFirewallRule
+    Apply-OPNSenseFirewallChanges
+    Get-OPNSenseInterface
+    Set-OPNSenseInterface
+    New-OPNSenseSubnetVLANs
+    Get-OPNSenseVLAN
+    New-OPNSenseVLAN
+    Get-OPNSenseDNSServer
+    Set-OPNSenseDNSServer
+    Get-OPNSensePlugin
+    Install-OPNSensePlugin
+    Get-OPNSenseUser
+    New-OPNSenseUser
+    Get-OPNSenseDHCPServer
+    Set-OPNSenseDHCPServer
+    Get-OPNSenseDHCPStaticMapping
+    New-OPNSenseDHCPStaticMapping
+    Get-OPNSenseCronJob
+    New-OPNSenseCronJob
+    Get-OPNSenseTailscaleStatus
+    Enable-OPNSenseTailscale
+    Connect-OPNSenseTailscale
+    Disconnect-OPNSenseTailscale
+    Get-OPNSenseFirmware
+    Update-OPNSenseFirmware
+    Restart-OPNSenseFirewall
+    Backup-OPNSenseConfig
+    Export-OPNSenseConfig

docs/examples/Alias-Management.ps1

@@ -0,0 +1,81 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all aliases
+$aliases = Get-OPNSenseAlias
+Write-Output "All Aliases:"
+$aliases | Format-Table -Property Uuid, Name, Type, Content, Description, Enabled
+
+# Get aliases by type
+$hostAliases = Get-OPNSenseAlias -Type host
+Write-Output "Host Aliases:"
+$hostAliases | Format-Table -Property Uuid, Name, Content, Description
+
+$networkAliases = Get-OPNSenseAlias -Type network
+Write-Output "Network Aliases:"
+$networkAliases | Format-Table -Property Uuid, Name, Content, Description
+
+$portAliases = Get-OPNSenseAlias -Type port
+Write-Output "Port Aliases:"
+$portAliases | Format-Table -Property Uuid, Name, Content, Description
+
+# Get a specific alias by name
+$webServersAlias = Get-OPNSenseAlias -Name "WebServers"
+Write-Output "WebServers Alias:"
+$webServersAlias | Format-Table -Property Uuid, Name, Type, Content, Description
+
+# Get a specific alias by UUID
+$aliasUuid = $aliases[0].Uuid
+$specificAlias = Get-OPNSenseAlias -Uuid $aliasUuid
+Write-Output "Specific Alias by UUID:"
+$specificAlias | Format-List
+
+# Create a new host alias
+$webServersUuid = New-OPNSenseAlias -Name "WebServers" -Type host -Content "192.168.1.10,192.168.1.11" -Description "Web Servers" -Apply
+Write-Output "Created WebServers alias with UUID: $webServersUuid"
+
+# Create a new network alias
+$internalNetworksUuid = New-OPNSenseAlias -Name "InternalNetworks" -Type network -Content "192.168.1.0/24,192.168.2.0/24" -Description "Internal Networks" -Apply
+Write-Output "Created InternalNetworks alias with UUID: $internalNetworksUuid"
+
+# Create a new port alias
+$webPortsUuid = New-OPNSenseAlias -Name "WebPorts" -Type port -Content "80,443" -Protocol TCP -Description "Web Ports" -Apply
+Write-Output "Created WebPorts alias with UUID: $webPortsUuid"
+
+# Create a new URL alias
+$blockListUuid = New-OPNSenseAlias -Name "BlockList" -Type url -Content "https://example.com/blocklist.txt" -UpdateFrequency 1 -Description "Block List" -Apply
+Write-Output "Created BlockList alias with UUID: $blockListUuid"
+
+# Update an alias's content
+Set-OPNSenseAlias -Uuid $webServersUuid -Content "192.168.1.10,192.168.1.11,192.168.1.12" -Apply
+Write-Output "Updated WebServers alias content"
+
+# Update an alias's description
+Set-OPNSenseAlias -Uuid $internalNetworksUuid -Description "All Internal Networks" -Apply
+Write-Output "Updated InternalNetworks alias description"
+
+# Disable an alias
+Set-OPNSenseAlias -Uuid $blockListUuid -Disabled -Apply
+Write-Output "Disabled BlockList alias"
+
+# Enable an alias
+Set-OPNSenseAlias -Uuid $blockListUuid -Enabled -Apply
+Write-Output "Enabled BlockList alias"
+
+# Enable counters for an alias
+Set-OPNSenseAlias -Uuid $webServersUuid -EnableCounters -Apply
+Write-Output "Enabled counters for WebServers alias"
+
+# Remove an alias
+Remove-OPNSenseAlias -Uuid $blockListUuid -Force -Apply
+Write-Output "Removed BlockList alias"
+
+# Remove aliases by pipeline
+Get-OPNSenseAlias -Name "WebServers" | Remove-OPNSenseAlias -Force -Apply
+Write-Output "Removed WebServers alias"
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Basic-Usage.ps1

@@ -0,0 +1,22 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get the current connection information
+Get-OPNSenseConnection
+
+# Get all firewall rules
+$rules = Get-OPNSenseFirewallRule
+$rules | Format-Table -Property Uuid, Description, Protocol, SourceNet, DestinationPort, Action
+
+# Create a new firewall rule to allow HTTP traffic
+$ruleId = New-OPNSenseFirewallRule -Description "Allow HTTP" -Protocol TCP -DestinationPort 80 -Action pass
+Write-Output "Created rule with ID: $ruleId"
+
+# Apply the changes
+Apply-OPNSenseFirewallChanges -CancelRollback -Timeout 30
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Configuration-Management.ps1

@@ -0,0 +1,29 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all configuration backups
+$backups = Get-OPNSenseConfigBackup
+$backups | Format-Table -Property Filename, Description, FileSize, Date, Version
+
+# Create a new configuration backup
+$backupFilename = Backup-OPNSenseConfig -Filename "pre-upgrade-backup"
+Write-Output "Created backup: $backupFilename"
+
+# Export the configuration to a file
+$exportPath = "C:\Backups\opnsense-config.xml"
+Export-OPNSenseConfig -Path $exportPath -Force
+Write-Output "Exported configuration to: $exportPath"
+
+# Import a configuration from a file
+# Note: This will restart the firewall
+# Import-OPNSenseConfig -Path $exportPath -Confirm
+
+# Restore a configuration backup
+# Note: This will restart the firewall
+# Restore-OPNSenseConfig -Filename $backupFilename -Confirm
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Cron-Management.ps1

@@ -0,0 +1,36 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all cron jobs
+$cronJobs = Get-OPNSenseCronJob
+$cronJobs | Format-Table -Property Uuid, Description, Command, Minutes, Hours, Days, Months, Weekdays, Enabled
+
+# Get a specific cron job
+$job = Get-OPNSenseCronJob -Uuid $cronJobs[0].Uuid
+$job
+
+# Create a new cron job that runs daily at 2:00 AM
+$dailyBackup = New-OPNSenseCronJob -Description "Daily backup" -Command "/usr/local/bin/backup.sh" -Minutes "0" -Hours "2" -Days "*" -Months "*" -Weekdays "*" -Apply
+$dailyBackup
+
+# Create a new cron job that runs weekly on Sunday at 3:00 AM
+$weeklyCleanup = New-OPNSenseCronJob -Description "Weekly cleanup" -Command "/usr/local/bin/cleanup.sh" -Minutes "0" -Hours "3" -Days "*" -Months "*" -Weekdays "0" -Apply
+$weeklyCleanup
+
+# Update a cron job
+Set-OPNSenseCronJob -Uuid $dailyBackup -Hours "3" -Description "Updated daily backup" -Apply
+
+# Disable a cron job
+Disable-OPNSenseCronJob -Uuid $dailyBackup -Apply
+
+# Enable a cron job
+Enable-OPNSenseCronJob -Uuid $dailyBackup -Apply
+
+# Remove a cron job
+Remove-OPNSenseCronJob -Uuid $weeklyCleanup -Force -Apply
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/DHCP-Management.ps1

@@ -0,0 +1,41 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all DHCP servers
+$dhcpServers = Get-OPNSenseDHCPServer
+$dhcpServers | Format-Table -Property Interface, Enabled, RangeFrom, RangeTo, Gateway
+
+# Get a specific DHCP server
+$lanDhcp = Get-OPNSenseDHCPServer -Interface "lan"
+$lanDhcp
+
+# Update a DHCP server
+Set-OPNSenseDHCPServer -Interface "lan" -RangeFrom "192.168.1.100" -RangeTo "192.168.1.200" -Domain "example.local" -DnsServers "8.8.8.8","8.8.4.4" -Apply
+
+# Get all DHCP leases
+$dhcpLeases = Get-OPNSenseDHCPLease
+$dhcpLeases | Format-Table -Property MacAddress, IpAddress, Hostname, State
+
+# Get active DHCP leases
+$activeLeases = $dhcpLeases | Where-Object { $_.State -eq "active" }
+$activeLeases | Format-Table -Property MacAddress, IpAddress, Hostname
+
+# Get all static mappings for an interface
+$staticMappings = Get-OPNSenseDHCPStaticMapping -Interface "lan"
+$staticMappings | Format-Table -Property Uuid, MacAddress, IpAddress, Hostname, Description
+
+# Create a new static mapping
+$newMapping = New-OPNSenseDHCPStaticMapping -Interface "lan" -MacAddress "00:11:22:33:44:55" -IpAddress "192.168.1.50" -Hostname "printer" -Description "Office Printer" -Apply
+$newMapping
+
+# Update a static mapping
+Set-OPNSenseDHCPStaticMapping -Interface "lan" -Uuid $newMapping -IpAddress "192.168.1.51" -Description "Updated Printer" -Apply
+
+# Remove a static mapping
+Remove-OPNSenseDHCPStaticMapping -Interface "lan" -Uuid $newMapping -Force -Apply
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/DNS-Configuration.ps1

@@ -0,0 +1,27 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get DNS server configuration
+$dnsConfig = Get-OPNSenseDNSServer
+Write-Output "DNS Server Configuration:"
+$dnsConfig
+
+# Update DNS server configuration
+Set-OPNSenseDNSServer -Forwarding -Forwarders "8.8.8.8","8.8.4.4" -RegisterDhcp -RegisterDhcpDomain "local" -Apply
+
+# Get all DNS overrides
+$overrides = Get-OPNSenseDNSOverride
+$overrides | Format-Table -Property Uuid, Hostname, Domain, IpAddress, Description
+
+# Create a new DNS override
+$overrideId = New-OPNSenseDNSOverride -Hostname "server" -Domain "local" -IpAddress "192.168.1.10" -Description "Internal server" -Apply
+Write-Output "Created DNS override with ID: $overrideId"
+
+# Remove a DNS override
+Remove-OPNSenseDNSOverride -Uuid $overrideId -Apply -Confirm:$false
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/DNS-Management.ps1

@@ -0,0 +1,52 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get DNS server configuration
+$dnsServer = Get-OPNSenseDNSServer
+Write-Output "DNS Server Configuration:"
+$dnsServer | Format-List
+
+# Update DNS server configuration
+Set-OPNSenseDNSServer -Forwarding -Forwarders "8.8.8.8","8.8.4.4" -Apply
+Write-Output "DNS Server updated to use Google DNS"
+
+# Get DNS forwarding configuration
+$dnsForwarding = Get-OPNSenseDNSForwarding
+Write-Output "DNS Forwarding Configuration:"
+$dnsForwarding | Format-List
+
+# Enable DNS forwarding
+Set-OPNSenseDNSForwarding -Enabled -DnsServers "1.1.1.1","1.0.0.1" -Apply
+Write-Output "DNS Forwarding enabled with Cloudflare DNS"
+
+# Get DNS forwarding hosts
+$forwardingHosts = Get-OPNSenseDNSForwardingHost
+Write-Output "DNS Forwarding Hosts:"
+$forwardingHosts | Format-Table
+
+# Create a new DNS forwarding host
+$newHost = New-OPNSenseDNSForwardingHost -Domain "example.com" -Server "192.168.1.10" -Description "Internal DNS Server" -Apply
+Write-Output "Created new forwarding host with UUID: $newHost"
+
+# Update a DNS forwarding host
+Set-OPNSenseDNSForwardingHost -Uuid $newHost -Server "192.168.1.20" -Apply
+Write-Output "Updated forwarding host server"
+
+# Remove a DNS forwarding host
+Remove-OPNSenseDNSForwardingHost -Uuid $newHost -Force -Apply
+Write-Output "Removed forwarding host"
+
+# Get system DNS configuration
+$systemDNS = Get-OPNSenseSystemDNS
+Write-Output "System DNS Configuration:"
+$systemDNS | Format-List
+
+# Update system DNS configuration
+Set-OPNSenseSystemDNS -Hostname "firewall" -Domain "example.com" -DnsServers "8.8.8.8","8.8.4.4" -Apply
+Write-Output "Updated system DNS configuration"
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Firmware-Management.ps1

@@ -0,0 +1,37 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get firmware status
+$firmwareStatus = Get-OPNSenseFirmware
+Write-Output "Firmware Status:"
+$firmwareStatus
+
+# Check for updates
+Get-OPNSenseFirmware -Check
+
+# Get firmware changelog
+$changelog = Get-OPNSenseFirmware -Changelog
+Write-Output "Firmware Changelog:"
+$changelog
+
+# Get firmware audit
+$audit = Get-OPNSenseFirmware -Audit
+$audit | Format-Table -Property Name, Version, Installed
+
+# Update firmware (install updates)
+Update-OPNSenseFirmware -Wait
+Write-Output "Firmware updated successfully"
+
+# Upgrade firmware (major version upgrade)
+# Note: This will restart the firewall
+# Upgrade-OPNSenseFirmware -Wait -Timeout 1200
+
+# Restart the firewall
+Restart-OPNSenseFirewall -Wait -Timeout 300
+Write-Output "Firewall restarted successfully"
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Gateway-Route-Management.ps1

@@ -0,0 +1,59 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all gateways
+$gateways = Get-OPNSenseGateway
+Write-Output "Gateways:"
+$gateways | Format-Table
+
+# Get gateways with status information
+$gatewaysWithStatus = Get-OPNSenseGateway -IncludeStatus
+Write-Output "Gateways with Status:"
+$gatewaysWithStatus | Format-Table
+
+# Create a new gateway
+$newGateway = New-OPNSenseGateway -Name "WAN2_GW" -Interface "opt1" -IpAddress "203.0.113.1" -Description "Secondary WAN" -Apply
+Write-Output "Created new gateway with UUID: $newGateway"
+
+# Update a gateway
+Set-OPNSenseGateway -Uuid $newGateway -MonitorIp "8.8.8.8" -Weight 2 -Apply
+Write-Output "Updated gateway monitor IP and weight"
+
+# Make a gateway the default gateway
+Set-OPNSenseGateway -Uuid $newGateway -Default -Apply
+Write-Output "Set gateway as default"
+
+# Get all routes
+$routes = Get-OPNSenseRoute
+Write-Output "Routes:"
+$routes | Format-Table
+
+# Create a new route
+$newRoute = New-OPNSenseRoute -Network "192.168.100.0/24" -Gateway "WAN2_GW" -Description "Remote Office" -Apply
+Write-Output "Created new route with UUID: $newRoute"
+
+# Update a route
+Set-OPNSenseRoute -Uuid $newRoute -Gateway "WAN_GW" -Apply
+Write-Output "Updated route gateway"
+
+# Disable a route
+Set-OPNSenseRoute -Uuid $newRoute -Disabled -Apply
+Write-Output "Disabled route"
+
+# Enable a route
+Set-OPNSenseRoute -Uuid $newRoute -Enabled -Apply
+Write-Output "Enabled route"
+
+# Remove a route
+Remove-OPNSenseRoute -Uuid $newRoute -Force -Apply
+Write-Output "Removed route"
+
+# Remove a gateway
+Remove-OPNSenseGateway -Uuid $newGateway -Force -Apply
+Write-Output "Removed gateway"
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Interface-Management.ps1

@@ -0,0 +1,27 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all interfaces
+$interfaces = Get-OPNSenseInterface
+$interfaces | Format-Table -Property Name, Description, IpAddress, SubnetMask, Status
+
+# Get interface statistics
+$stats = Get-OPNSenseInterfaceStatistics
+$stats | Format-Table -Property Name, InPackets, OutPackets, InBytes, OutBytes
+
+# Update an interface
+Set-OPNSenseInterface -Name "lan" -Description "Local Area Network" -IpAddress "192.168.1.1" -SubnetMask "24" -Apply
+
+# Create a new VLAN
+$vlanId = New-OPNSenseVLAN -Interface "em0" -Tag 10 -Description "Management VLAN"
+Write-Output "Created VLAN with ID: $vlanId"
+
+# Get all VLANs
+$vlans = Get-OPNSenseVLAN
+$vlans | Format-Table -Property Uuid, Tag, Interface, Description
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Network-Supernetting.ps1

@@ -0,0 +1,57 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Basic supernetting of two networks
+$supernet = Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Supernet -AdditionalNetworks "192.168.2.0/24"
+Write-Output "Supernet of 192.168.1.0/24 and 192.168.2.0/24:"
+$supernet
+
+# Supernetting of multiple networks
+$supernet = Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/24" -Operation Supernet -AdditionalNetworks "10.0.1.0/24","10.0.2.0/24","10.0.3.0/24"
+Write-Output "Supernet of multiple /24 networks:"
+$supernet
+
+# Advanced supernetting with summarization
+$summarizedNetworks = Invoke-OPNSenseNetworkCalculation -Network "172.16.0.0/24" -Operation SupernetSummarize -AdditionalNetworks "172.16.1.0/24","172.16.2.0/24","172.16.4.0/24","172.16.5.0/24"
+Write-Output "Summarized networks:"
+$summarizedNetworks | Format-Table
+
+# Example of non-contiguous networks being summarized efficiently
+$summarizedNetworks = Invoke-OPNSenseNetworkCalculation -Network "10.1.0.0/24" -Operation SupernetSummarize -AdditionalNetworks "10.1.1.0/24","10.1.2.0/24","10.2.0.0/24","10.2.1.0/24"
+Write-Output "Summarized non-contiguous networks:"
+$summarizedNetworks | Format-Table
+
+# Example with mixed IPv4 and IPv6 networks
+$summarizedNetworks = Invoke-OPNSenseNetworkCalculation -Network "192.168.0.0/24" -Operation SupernetSummarize -AdditionalNetworks "192.168.1.0/24","2001:db8::/64","2001:db8:1::/64"
+Write-Output "Summarized mixed IPv4 and IPv6 networks:"
+$summarizedNetworks | Format-Table
+
+# Practical example: Summarizing a large number of networks
+$networks = @(
+    "10.0.0.0/24"
+    "10.0.1.0/24"
+    "10.0.2.0/24"
+    "10.0.3.0/24"
+    "10.0.4.0/24"
+    "10.0.5.0/24"
+    "10.0.6.0/24"
+    "10.0.7.0/24"
+    "10.1.0.0/24"
+    "10.1.1.0/24"
+    "10.2.0.0/24"
+    "10.2.1.0/24"
+    "172.16.0.0/24"
+    "172.16.1.0/24"
+    "172.16.2.0/24"
+    "172.16.3.0/24"
+)
+
+$summarizedNetworks = Invoke-OPNSenseNetworkCalculation -Network $networks[0] -Operation SupernetSummarize -AdditionalNetworks $networks[1..($networks.Length-1)]
+Write-Output "Summarized large set of networks:"
+$summarizedNetworks | Format-Table
+
+# Using the summarized networks for route configuration
+Write-Output "Example of using summarized networks for route configuration:"
+foreach ($network in $summarizedNetworks) {
+    Write-Output "New-OPNSenseRoute -Network '$network' -Gateway 'WAN_GW' -Description 'Summarized Route' -Apply"
+}

docs/examples/Network-Utilities.ps1

@@ -0,0 +1,44 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Network information
+$networkInfo = Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Info
+Write-Output "Network Information:"
+$networkInfo | Format-List
+
+# Subnet a network into smaller networks
+$subnets = Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/16" -Operation Subnet -PrefixLength 24
+Write-Output "First 5 subnets of 10.0.0.0/16 divided into /24 networks:"
+$subnets | Select-Object -First 5 | Format-Table
+
+# Subnet a network into a specific number of subnets
+$subnets = Invoke-OPNSenseNetworkCalculation -Network "172.16.0.0/16" -Operation SubnetByCount -SubnetCount 4
+Write-Output "172.16.0.0/16 divided into 4 equal subnets:"
+$subnets | Format-Table
+
+# Check if an IP address is within a network
+$contains = Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Contains -IPAddress "192.168.1.100"
+Write-Output "Is 192.168.1.100 within 192.168.1.0/24? $contains"
+
+# Check if networks overlap
+$overlaps = Invoke-OPNSenseNetworkCalculation -Network "10.0.0.0/24" -Operation Overlaps -AdditionalNetworks "10.0.0.128/25"
+Write-Output "Network overlap check:"
+$overlaps | Format-Table
+
+# Create a supernet from multiple networks
+$supernet = Invoke-OPNSenseNetworkCalculation -Network "192.168.1.0/24" -Operation Supernet -AdditionalNetworks "192.168.2.0/24","192.168.3.0/24"
+Write-Output "Supernet of 192.168.1.0/24, 192.168.2.0/24, and 192.168.3.0/24:"
+$supernet
+
+# Convert between CIDR and subnet mask
+$subnetMask = ConvertTo-OPNSenseNetworkNotation -CIDR 24
+Write-Output "Subnet mask for /24: $subnetMask"
+
+$cidr = ConvertTo-OPNSenseNetworkNotation -SubnetMask "255.255.255.0"
+Write-Output "CIDR for 255.255.255.0: $cidr"
+
+$ipWithSubnetMask = ConvertTo-OPNSenseNetworkNotation -IPWithCIDR "192.168.1.0/24"
+Write-Output "IP with subnet mask for 192.168.1.0/24: $ipWithSubnetMask"
+
+$ipWithCIDR = ConvertTo-OPNSenseNetworkNotation -IPWithSubnetMask "192.168.1.0 255.255.255.0"
+Write-Output "IP with CIDR for 192.168.1.0 255.255.255.0: $ipWithCIDR"

docs/examples/Plugin-Management.ps1

@@ -0,0 +1,29 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all installed plugins
+$installedPlugins = Get-OPNSensePlugin -Installed
+$installedPlugins | Format-Table -Property Name, Version, Comment, Enabled
+
+# Get all available plugins
+$availablePlugins = Get-OPNSensePlugin -Available
+$availablePlugins | Format-Table -Property Name, Version, Comment
+
+# Install a plugin
+Install-OPNSensePlugin -Name "os-acme-client" -Wait
+Write-Output "Plugin installed successfully"
+
+# Enable a plugin
+Enable-OPNSensePlugin -Name "os-acme-client"
+
+# Disable a plugin
+Disable-OPNSensePlugin -Name "os-acme-client"
+
+# Uninstall a plugin
+Uninstall-OPNSensePlugin -Name "os-acme-client" -Wait -Confirm:$false
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Port-Forwarding-README.md

@@ -0,0 +1,212 @@
+# Port Forwarding Examples
+
+This document provides examples of using the PSOPNSenseAPI module to manage port forwarding rules on OPNSense firewalls.
+
+## Basic Port Forwarding
+
+The following example demonstrates how to create, view, update, and delete port forwarding rules:
+
+```powershell
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all port forwarding rules
+$rules = Get-OPNSensePortForwardingRule
+Write-Output "Current port forwarding rules:"
+$rules | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Create a new port forwarding rule for HTTP
+$httpRule = New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "80" -TargetIP "192.168.1.100" -TargetPort "80" -Description "Web Server HTTP"
+Write-Output "Created HTTP port forwarding rule:"
+$httpRule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Create a new port forwarding rule for HTTPS
+$httpsRule = New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "443" -TargetIP "192.168.1.100" -TargetPort "443" -Description "Web Server HTTPS"
+Write-Output "Created HTTPS port forwarding rule:"
+$httpsRule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Update the HTTP rule to point to a different server
+$updatedRule = Set-OPNSensePortForwardingRule -Uuid $httpRule.Uuid -TargetIP "192.168.1.200" -Description "Updated Web Server HTTP" -PassThru
+Write-Output "Updated HTTP port forwarding rule:"
+$updatedRule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Get a specific rule by UUID
+$rule = Get-OPNSensePortForwardingRule -Uuid $httpsRule.Uuid
+Write-Output "Retrieved HTTPS port forwarding rule:"
+$rule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Remove the HTTP rule
+Remove-OPNSensePortForwardingRule -Uuid $httpRule.Uuid -Force
+Write-Output "Removed HTTP port forwarding rule"
+
+# Get all port forwarding rules again to verify changes
+$rules = Get-OPNSensePortForwardingRule
+Write-Output "Updated port forwarding rules:"
+$rules | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Advanced Port Forwarding Scenarios
+
+### Web Server with Multiple Services
+
+This example shows how to set up port forwarding for a web server with multiple services:
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define the web server details
+$webServerIP = "192.168.1.100"
+$services = @(
+    @{ Name = "HTTP"; Protocol = "tcp"; ExternalPort = "80"; InternalPort = "80" },
+    @{ Name = "HTTPS"; Protocol = "tcp"; ExternalPort = "443"; InternalPort = "443" },
+    @{ Name = "Alternative HTTP"; Protocol = "tcp"; ExternalPort = "8080"; InternalPort = "8080" },
+    @{ Name = "WebSocket"; Protocol = "tcp"; ExternalPort = "9000"; InternalPort = "9000" }
+)
+
+# Create port forwarding rules for each service
+foreach ($service in $services) {
+    New-OPNSensePortForwardingRule -Interface "WAN" `
+        -Protocol $service.Protocol `
+        -DestinationPort $service.ExternalPort `
+        -TargetIP $webServerIP `
+        -TargetPort $service.InternalPort `
+        -Description "Web Server - $($service.Name)" `
+        -Force
+}
+
+# Verify the rules were created
+Get-OPNSensePortForwardingRule | Where-Object { $_.TargetIP -eq $webServerIP } | 
+    Format-Table -Property Description, Protocol, DestinationPort, TargetPort
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Game Server Port Forwarding
+
+This example demonstrates how to set up port forwarding for a game server with multiple ports:
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define the game server details
+$gameServerIP = "192.168.1.150"
+$gameServerPorts = @(
+    @{ Name = "Game Server - Main"; Protocol = "tcp/udp"; Ports = "27015" },
+    @{ Name = "Game Server - Query"; Protocol = "udp"; Ports = "27016" },
+    @{ Name = "Game Server - RCON"; Protocol = "tcp"; Ports = "27017" },
+    @{ Name = "Game Server - Voice"; Protocol = "udp"; Ports = "9987-9989" }
+)
+
+# Create port forwarding rules for the game server
+foreach ($port in $gameServerPorts) {
+    New-OPNSensePortForwardingRule -Interface "WAN" `
+        -Protocol $port.Protocol `
+        -DestinationPort $port.Ports `
+        -TargetIP $gameServerIP `
+        -TargetPort $port.Ports `
+        -Description $port.Name `
+        -Force
+}
+
+# Verify the rules were created
+Get-OPNSensePortForwardingRule | Where-Object { $_.TargetIP -eq $gameServerIP } | 
+    Format-Table -Property Description, Protocol, DestinationPort, TargetPort
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Remote Access Services
+
+This example shows how to set up port forwarding for remote access services:
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Define remote access services
+$remoteServices = @(
+    @{ Name = "RDP - Admin Server"; TargetIP = "192.168.1.200"; ExternalPort = "33389"; InternalPort = "3389"; Protocol = "tcp" },
+    @{ Name = "SSH - Dev Server"; TargetIP = "192.168.1.201"; ExternalPort = "2222"; InternalPort = "22"; Protocol = "tcp" },
+    @{ Name = "VNC - Support"; TargetIP = "192.168.1.202"; ExternalPort = "5900"; InternalPort = "5900"; Protocol = "tcp" }
+)
+
+# Create port forwarding rules for remote access
+foreach ($service in $remoteServices) {
+    New-OPNSensePortForwardingRule -Interface "WAN" `
+        -Protocol $service.Protocol `
+        -DestinationPort $service.ExternalPort `
+        -TargetIP $service.TargetIP `
+        -TargetPort $service.InternalPort `
+        -Description $service.Name `
+        -Log `  # Enable logging for security
+        -Force
+}
+
+# Verify the rules were created
+Get-OPNSensePortForwardingRule | Where-Object { $_.Description -like "* - *" } | 
+    Format-Table -Property Description, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+### Bulk Management of Port Forwarding Rules
+
+This example demonstrates how to perform bulk operations on port forwarding rules:
+
+```powershell
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all port forwarding rules
+$rules = Get-OPNSensePortForwardingRule
+
+# Disable all rules with "Temporary" in the description
+$rules | Where-Object { $_.Description -like "*Temporary*" } | ForEach-Object {
+    Set-OPNSensePortForwardingRule -Uuid $_.Uuid -Enabled:$false -Force
+    Write-Output "Disabled rule: $($_.Description)"
+}
+
+# Update all rules pointing to a decommissioned server
+$oldServerIP = "192.168.1.100"
+$newServerIP = "192.168.1.150"
+
+$rules | Where-Object { $_.TargetIP -eq $oldServerIP } | ForEach-Object {
+    Set-OPNSensePortForwardingRule -Uuid $_.Uuid -TargetIP $newServerIP -Description "$($_.Description) (Migrated)" -Force
+    Write-Output "Updated rule: $($_.Description) to point to $newServerIP"
+}
+
+# Delete all rules with "Obsolete" in the description
+$rules | Where-Object { $_.Description -like "*Obsolete*" } | ForEach-Object {
+    Remove-OPNSensePortForwardingRule -Uuid $_.Uuid -Force
+    Write-Output "Removed rule: $($_.Description)"
+}
+
+# Verify changes
+$updatedRules = Get-OPNSensePortForwardingRule
+Write-Output "Rules after bulk operations:"
+$updatedRules | Format-Table -Property Uuid, Description, Enabled, TargetIP, DestinationPort, TargetPort
+
+# Disconnect from the firewall
+Disconnect-OPNSense
+```
+
+## Notes
+
+- Port forwarding rules are applied immediately after creation, update, or deletion.
+- When creating or updating rules, consider security implications and only forward necessary ports.
+- Use the `FilterRuleAssociation` parameter to automatically create associated firewall rules.
+- NAT reflection allows internal clients to access forwarded services using the external IP address.
+- For security-sensitive rules, enable logging with the `-Log` parameter.
+- Always use strong authentication and encryption for remote access services.
+- Consider using non-standard external ports for common services to reduce automated scanning attempts.

docs/examples/Port-Forwarding.ps1

@@ -0,0 +1,42 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all port forwarding rules
+$rules = Get-OPNSensePortForwardingRule
+Write-Output "Current port forwarding rules:"
+$rules | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Create a new port forwarding rule for HTTP
+$httpRule = New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "80" -TargetIP "192.168.1.100" -TargetPort "80" -Description "Web Server HTTP"
+Write-Output "Created HTTP port forwarding rule:"
+$httpRule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Create a new port forwarding rule for HTTPS
+$httpsRule = New-OPNSensePortForwardingRule -Interface "WAN" -Protocol "tcp" -DestinationPort "443" -TargetIP "192.168.1.100" -TargetPort "443" -Description "Web Server HTTPS"
+Write-Output "Created HTTPS port forwarding rule:"
+$httpsRule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Update the HTTP rule to point to a different server
+$updatedRule = Set-OPNSensePortForwardingRule -Uuid $httpRule.Uuid -TargetIP "192.168.1.200" -Description "Updated Web Server HTTP" -PassThru
+Write-Output "Updated HTTP port forwarding rule:"
+$updatedRule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Get a specific rule by UUID
+$rule = Get-OPNSensePortForwardingRule -Uuid $httpsRule.Uuid
+Write-Output "Retrieved HTTPS port forwarding rule:"
+$rule | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Remove the HTTP rule
+Remove-OPNSensePortForwardingRule -Uuid $httpRule.Uuid -Force
+Write-Output "Removed HTTP port forwarding rule"
+
+# Get all port forwarding rules again to verify changes
+$rules = Get-OPNSensePortForwardingRule
+Write-Output "Updated port forwarding rules:"
+$rules | Format-Table -Property Uuid, Description, Interface, Protocol, DestinationPort, TargetIP, TargetPort
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Subnet-VLAN-Creation.ps1

@@ -0,0 +1,31 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get available interfaces
+$interfaces = Get-OPNSenseInterface
+$interfaces | Format-Table -Property Name, Description, Status
+
+# Create VLANs for subnets with sequential VLAN IDs
+$result1 = New-OPNSenseSubnetVLANs -ParentInterface "em0" -Network "192.168.0.0/24" -SubnetMaskBits 27 -StartingVlanId 10 -VlanIdIncrement 1
+Write-Output "Created VLANs with sequential IDs:"
+$result1.VLANs | Format-Table -Property VlanId, Subnet, Gateway, Status
+
+# Create VLANs for subnets with VLAN IDs in multiples of 10
+$result2 = New-OPNSenseSubnetVLANs -ParentInterface "em1" -Network "10.0.0.0/16" -SubnetMaskBits 24 -StartingVlanId 100 -VlanIdIncrement 10
+Write-Output "Created VLANs with IDs in multiples of 10:"
+$result2.VLANs | Format-Table -Property VlanId, Subnet, Gateway, Status
+
+# Create VLANs for subnets with DHCP enabled
+$result3 = New-OPNSenseSubnetVLANs -ParentInterface "em2" -Network "172.16.0.0/20" -SubnetMaskBits 24 -StartingVlanId 200 -VlanIdIncrement 1 -EnableDHCP -DescriptionPrefix "VLAN-DHCP"
+Write-Output "Created VLANs with DHCP enabled:"
+$result3.VLANs | Format-Table -Property VlanId, Subnet, Gateway, Status
+
+# Get all VLANs
+$vlans = Get-OPNSenseVLAN
+$vlans | Format-Table -Property Uuid, Tag, Interface, Description
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/Tailscale-Management.ps1

@@ -0,0 +1,45 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get Tailscale status
+$status = Get-OPNSenseTailscaleStatus
+Write-Output "Tailscale Status:"
+$status
+
+# Get detailed Tailscale status with interfaces and settings
+$detailedStatus = Get-OPNSenseTailscaleStatus -IncludeInterfaces -IncludeSettings
+Write-Output "Tailscale Interfaces:"
+$detailedStatus.Interfaces
+
+# Enable Tailscale with default settings (will install plugin if not present)
+Enable-OPNSenseTailscale -Force
+
+# Enable Tailscale with custom settings
+Enable-OPNSenseTailscale -AcceptDns -AcceptRoutes -Hostname "opnsense-firewall" -Force
+
+# Enable Tailscale with subnet route advertising
+Enable-OPNSenseTailscale -AdvertiseRoutes -SubnetRoutes "192.168.1.0/24","10.0.0.0/8" -Force
+
+# Connect to Tailscale network with an auth key
+# You can generate an auth key at https://login.tailscale.com/admin/settings/keys
+Connect-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -InstallIfMissing -EnableIfDisabled -StartIfStopped -Force
+
+# Connect to Tailscale and advertise subnet routes
+Connect-OPNSenseTailscale -AuthKey "tskey-auth-abcdef123456" -SubnetRoutes "192.168.1.0/24","10.0.0.0/8" -AdvertiseRoutes -Force
+
+# Get Tailscale status after connecting
+$connectedStatus = Get-OPNSenseTailscaleStatus -IncludeInterfaces
+Write-Output "Tailscale Connected Status:"
+$connectedStatus
+
+# Disconnect from Tailscale network
+Disconnect-OPNSenseTailscale -Force
+
+# Disable Tailscale and stop the service
+Disable-OPNSenseTailscale -Stop -Force
+
+# Disconnect from the firewall
+Disconnect-OPNSense

docs/examples/User-Management.ps1

@@ -0,0 +1,28 @@
+# Import the module
+Import-Module PSOPNSenseAPI
+
+# Connect to the OPNSense firewall
+Connect-OPNSense -Server "https://firewall.example.com" -ApiKey "your_api_key" -ApiSecret "your_api_secret" -SkipCertificateCheck
+
+# Get all users
+$users = Get-OPNSenseUser
+$users | Format-Table -Property Uuid, Username, FullName, Email, Disabled
+
+# Create a new user
+$userId = New-OPNSenseUser -Username "john" -Password "P@ssw0rd" -FullName "John Doe" -Email "john@example.com" -Groups "admins"
+Write-Output "Created user with ID: $userId"
+
+# Update a user
+Set-OPNSenseUser -Uuid $userId -Email "john.doe@example.com" -FullName "John A. Doe"
+
+# Disable a user
+Set-OPNSenseUser -Uuid $userId -Disabled
+
+# Enable a user
+Set-OPNSenseUser -Uuid $userId -Enabled
+
+# Remove a user
+Remove-OPNSenseUser -Uuid $userId -Confirm:$false
+
+# Disconnect from the firewall
+Disconnect-OPNSense