RS.Fritz.Manager.API 2.1.0-alpha0274

This is a prerelease version of RS.Fritz.Manager.API.
There is a newer version of this package available.
See the version list below for details.
dotnet add package RS.Fritz.Manager.API --version 2.1.0-alpha0274
                    
NuGet\Install-Package RS.Fritz.Manager.API -Version 2.1.0-alpha0274
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RS.Fritz.Manager.API" Version="2.1.0-alpha0274" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RS.Fritz.Manager.API" Version="2.1.0-alpha0274" />
                    
Directory.Packages.props
<PackageReference Include="RS.Fritz.Manager.API" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RS.Fritz.Manager.API --version 2.1.0-alpha0274
                    
#r "nuget: RS.Fritz.Manager.API, 2.1.0-alpha0274"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package RS.Fritz.Manager.API@2.1.0-alpha0274
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RS.Fritz.Manager.API&version=2.1.0-alpha0274&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=RS.Fritz.Manager.API&version=2.1.0-alpha0274&prerelease
                    
Install as a Cake Tool

RS.Fritz.Manager

Allows FritzBox device detection, monitoring, configuring and network traffic capturing. The TR-064 implementation is using pure WCF Soap calls.

Available as a standalone Windows application (UI) and as a NuGet package (API).

For a list of implemented services check the Service implementation status

RS.Fritz.Manager.UI

A Windows .NET WPF application for x64 and ARM64.

Screenshot 2022-03-19 210434

Usage Instructions

  1. Click Discover Internet Gateway Devices
  2. Select a detected device
  3. Select a detected user
  4. Enter the selected user's password
  5. Click Login
  6. Use the Device Information tab to see device details

RS.Fritz.Manager.API

A NuGet package to manage FritzBox devices using pure WCF calls.

Usage Examples

using System.Net;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using RS.Fritz.Manager.API;

// Register the Fritz services in the dependency container using AddFritzApi()
using IHost host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((_, services) => services.AddFritzApi())
    .Build();

using IServiceScope serviceScope = host.Services.CreateScope();

// Search for routers and take the first one
IDeviceSearchService deviceSearchService = serviceScope.ServiceProvider.GetRequiredService<IDeviceSearchService>();
InternetGatewayDevice device = (await deviceSearchService.GetDevicesAsync()).First();

// Show the device model from UPnP data
Console.WriteLine($"Device model: {device.UPnPDescription.Device.ModelDescription}");

// Initialize the device for TR-064, retrieves the security port and the users
await device.InitializeAsync();

// Provide the password for the last logged on user
string lastUsedUserName = device.Users.Single(q => q.LastUser).Name;
Console.WriteLine($"Enter password for {lastUsedUserName}:");
device.NetworkCredential = new NetworkCredential(lastUsedUserName, Console.ReadLine());

// TR-064 example; show the device uptime from the TR-064 DeviceInfo service
DeviceInfoGetInfoResponse deviceInfo = await device.DeviceInfoGetInfoAsync();
Console.WriteLine($"Device uptime: {TimeSpan.FromSeconds(deviceInfo.Uptime)}");

// Special services

// Retrieving the device users manually
IUsersService usersService = serviceScope.ServiceProvider.GetRequiredService<IUsersService>();
IEnumerable<User> users = await usersService.GetUsersAsync(device);
users.ToList().ForEach(q => Console.WriteLine($"User: {q.Name}"));

// Retrieving a list of device hosts in the network
IDeviceHostsService deviceHostsService = serviceScope.ServiceProvider.GetRequiredService<IDeviceHostsService>();
DeviceHostInfo deviceHostInfo = await deviceHostsService.GetDeviceHostsAsync(device);
deviceHostInfo.DeviceHosts.ToList().ForEach(q => Console.WriteLine($"Device host: {q.HostName}"));

// Retrieving a list of mesh hosts in the network
IDeviceMeshService deviceMeshService = serviceScope.ServiceProvider.GetRequiredService<IDeviceMeshService>();
DeviceMeshInfo deviceMeshInfo = await deviceMeshService.GetDeviceMeshAsync(device);
deviceMeshInfo.DeviceMesh.Nodes.ToList().ForEach(q => Console.WriteLine($"Mesh host: {q.DeviceName}"));

// Retrieving a list of WLAN devices in the network
IWlanDeviceService wlanDeviceService = serviceScope.ServiceProvider.GetRequiredService<IWlanDeviceService>();
WlanDeviceInfo wlanDeviceInfo = await wlanDeviceService.GetWlanDevicesAsync(device);
wlanDeviceInfo.WlanDeviceList.Items.ToList().ForEach(q => Console.WriteLine($"WLAN device: {q.AssociatedDeviceIpAddress}"));

// Retrieve a new session for use in the WebUI
IWebUiService webUiService = serviceScope.ServiceProvider.GetRequiredService<IWebUiService>();
WebUiSessionInfo webUiSessionInfo = await webUiService.LogonAsync(device);
Console.WriteLine($"Session: {webUiSessionInfo.Sid}");

// Capture live network traffic from router to file
ICaptureControlService captureControlService = serviceScope.ServiceProvider.GetRequiredService<ICaptureControlService>();
Task.Run(() => StopCaptureAfter1SecondsAsync(device, captureControlService));
FileInfo fileInfo = await captureControlService.GetStartCaptureResponseAsync(device, "c:\\temp", "capturefile");
Console.WriteLine($"Network trace written to file: {fileInfo}");

await host.RunAsync();

static async Task StopCaptureAfter1SecondsAsync(InternetGatewayDevice device, ICaptureControlService captureControlService)
{
    await Task.Delay(1000);
    await captureControlService.GetStopCaptureResponseAsync(device);
}

TR-064 Service implementation status

WAN

  • 🔶 urn:dslforum-org:service:WANIPConnection
    • ✅ GetInfo
    • ✅ GetConnectionTypeInfo
    • ❌ SetConnectionType
    • ✅ GetStatusInfo
    • ✅ GetNATRSIPStatus
    • ❌ SetConnectionTrigger
    • ❌ ForceTermination
    • ❌ RequestConnection
    • ✅ X_GetDNSServers
    • ✅ GetPortMappingNumberOfEntries
    • ✅ GetGenericPortMappingEntry
    • ❌ GetSpecificPortMappingEntry
    • ❌ AddPortMapping
    • ❌ DeletePortMapping
    • ✅ GetExternalIPAddress
    • ❌ SetRouteProtocolRx
    • ❌ SetIdleDisconnectTime
  • 🔶 urn:dslforum-org:service:WANPPPConnection
    • ✅ GetInfo
    • ✅ GetConnectionTypeInfo
    • ❌ SetConnectionType
    • ✅ GetStatusInfo
    • ✅ GetLinkLayerMaxBitRates
    • ✅ GetUserName
    • ❌ SetUserName
    • ❌ SetPassword
    • ✅ GetNATRSIPStatus
    • ❌ SetConnectionTrigger
    • ❌ ForceTermination
    • ❌ RequestConnection
    • ✅ X_GetDNSServers
    • ✅ GetPortMappingNumberOfEntries
    • ✅ GetGenericPortMappingEntry
    • ❌ GetSpecificPortMappingEntry
    • ❌ AddPortMapping
    • ❌ DeletePortMapping
    • ✅ GetExternalIPAddress
    • ❌ SetRouteProtocolRx
    • ❌ SetIdleDisconnectTime
    • ✅ X_AVM-DE_GetAutoDisconnectTimeSpan
    • ❌ X_AVM-DE_SetAutoDisconnectTimeSpan
  • ✅ urn:dslforum-org:service:WANCommonInterfaceConfig
    • ✅ GetCommonLinkProperties
    • ✅ GetTotalBytesSent
    • ✅ GetTotalBytesReceived
    • ✅ GetTotalPacketsSent
    • ✅ GetTotalPacketsReceived
    • ✅ X_AVM-DE_SetWANAccessType
    • ✅ X_AVM-DE_GetOnlineMonitor
  • ✅ urn:dslforum-org:service:WANEthernetLinkConfig
    • ✅ GetEthernetLinkStatus
  • ✅ urn:dslforum-org:service:WANDSLInterfaceConfig
    • ✅ GetInfo
    • ✅ GetStatisticsTotal
    • ✅ X_AVM-DE_GetDSLDiagnoseInfo
    • ✅ X_AVM-DE_GetDSLInfo
  • 🔶 urn:dslforum-org:service:WANDSLLinkConfig
    • ✅ GetInfo
    • ❌ SetEnable
    • ❌ SetDSLLinkType
    • ✅ GetDSLLinkInfo
    • ❌ SetDestinationAddress
    • ✅ GetDestinationAddress
    • ❌ SetATMEncapsulation
    • ✅ GetATMEncapsulation
    • ✅ GetAutoConfig
    • ✅ GetStatistics
  • 🔶 urn:dslforum-org:service:X_AVM-DE_Speedtest
    • ✅ GetInfo
    • ❌ SetConfig
  • ❌ urn:dslforum-org:service:X_AVM-DE_RemoteAccess
  • ❌ urn:dslforum-org:service:X_AVM-DE_MyFritz
  • ❌ urn:dslforum-org:service:X_AVM-DE_HostFilter
  • 🔶 urn:dslforum-org:service:Layer3Forwarding
    • ❌ SetDefaultConnectionService
    • ✅ GetDefaultConnectionService
    • ✅ GetForwardNumberOfEntries
    • ❌ AddForwardingEntry
    • ❌ DeleteForwardingEntry
    • ❌ GetSpecificForwardingEntry
    • ✅ GetGenericForwardingEntry
    • ❌ SetForwardingEntryEnable

Telephony

  • ❌ urn:dslforum-org:service:X_AVM-DE_OnTel
  • ❌ urn:dslforum-org:service:X_AVM-DE_TAM
  • ❌ urn:dslforum-org:service:X_VoIP

Home network

  • 🔶 urn:dslforum-org:service:Hosts
    • ✅ GetHostNumberOfEntries
    • ❌ GetSpecificHostEntry
    • ✅ GetGenericHostEntry
    • ✅ X_AVM-DE_GetChangeCounter
    • ❌ X_AVM-DE_GetAutoWakeOnLANByMACAddress
    • ❌ X_AVM-DE_SetAutoWakeOnLANByMACAddress
    • ❌ X_AVM-DE_SetHostNameByMACAddress
    • ❌ X_AVM-DE_WakeOnLANByMACAddress
    • ❌ X_AVM-DE_GetSpecificHostEntryByIp
    • ❌ X_AVM-DE_HostsCheckUpdate
    • ❌ X_AVM-DE_HostDoUpdate
    • ✅ X_AVM-DE_GetHostListPath
    • ✅ X_AVM-DE_GetMeshListPath
  • 🔶 urn:dslforum-org:service:WLANConfiguration
    • ❌ SetEnable
    • ✅ GetInfo
    • ❌ SetConfig
    • ❌ SetSecurityKeys
    • ❌ GetSecurityKeys
    • ❌ SetDefaultWEPKeyIndex
    • ❌ GetDefaultWEPKeyIndex
    • ❌ SetBasBeaconSecurityProperties
    • ✅ GetBasBeaconSecurityProperties
    • ✅ GetBSSID
    • ✅ GetSSID
    • ❌ SetSSID
    • ✅ GetBeaconType
    • ❌ SetBeaconType
    • ✅ GetChannelInfo
    • ❌ SetChannel
    • ✅ GetBeaconAdvertisement
    • ❌ SetBeaconAdvertisement
    • ✅ GetTotalAssociations
    • ❌ GetGenericAssociatedDeviceInfo
    • ❌ GetSpecificAssociatedDeviceInfo
    • ❌ X_AVM-DE_GetSpecificAssociatedDeviceInfoByIp
    • ✅ X_AVM-DE_GetWLANDeviceListPath
    • ❌ X_AVM-DE_SetStickSurfEnable
    • ✅ X_AVM-DE_GetIPTVOptimized
    • ❌ X_AVM-DE_SetIPTVOptimized
    • ✅ GetStatistics
    • ✅ GetPacketStatistics
    • ✅ X_AVM-DE_GetNightControl
    • ❌ X_SetHighFrequencyBand
    • ✅ X_AVM-DE_GetWLANHybridMode
    • ❌ X_AVM-DE_SetWLANHybridMode
    • ✅ X_AVM-DE_GetWLANExtInfo
    • ❌ X_AVM-DE_SetWLANGlobalEnable
    • ✅ X_AVM-DE_GetWPSInfo
    • ❌ X_AVM-DE_SetWPSConfig
    • ❌ X_AVM-DE_SetWPSEnable
    • ✅ X_AVM-DE_GetWLANConnectionInfo
  • 🔶 urn:dslforum-org:service:LANHostConfigManagement
    • ✅ GetInfo
    • ❌ SetDHCPServerEnable
    • ❌ SetSubnetMask
    • ✅ GetSubnetMask
    • ❌ SetIPRouter
    • ✅ GetIPRoutersList
    • ❌ SetIPInterface
    • ✅ GetAddressRange
    • ❌ SetAddressRange
    • ✅ GetIPInterfaceNumberOfEntries
    • ✅ GetDNSServers
  • 🔶 urn:dslforum-org:service:LANEthernetInterfaceConfig
    • ❌ SetEnable
    • ✅ GetInfo
    • ✅ GetStatistics
  • ❌ urn:dslforum-org:service:X_AVM-DE_Dect
  • ❌ urn:dslforum-org:service:X_AVM-DE_Homeauto
  • ❌ urn:dslforum-org:service:X_AVM-DE_Homeplug

Storage/NAS

  • ❌ urn:dslforum-org:service:X_AVM-DE_Storage
  • ❌ urn:dslforum-org:service:X_AVM-DE_UPnP
  • ❌ urn:dslforum-org:service:X_AVM-DE_Filelinks

System

  • ✅ urn:dslforum-org:service:DeviceInfo
    • ✅ GetInfo
    • ✅ SetProvisioningCode
    • ✅ GetDeviceLog
    • ✅ GetSecurityPort
  • ❌ urn:dslforum-org:service:DeviceConfig
  • ✅ urn:dslforum-org:service:LANConfigSecurity
    • ✅ GetInfo
    • ✅ X_AVM-DE_GetAnonymousLogin
    • ✅ X_AVM-DE_GetCurrentUser
    • ✅ SetConfigPassword
    • ✅ X_AVM-DE_GetUserList
  • ❌ urn:dslforum-org:service:X_AVM-DE_AppSetup
  • ✅ urn:dslforum-org:service:ManagementServer
    • ✅ GetInfo
    • ✅ SetManagementServerURL
    • ✅ SetManagementServerUsername
    • ✅ SetManagementServerPassword
    • ✅ SetPeriodicInform
    • ✅ SetConnectionRequestAuthentication
    • ✅ SetUpgradeManagement
    • ✅ X_SetTR069Enable
    • ✅ X_AVM-DE_GetTR069FirmwareDownloadEnabled
    • ✅ X_AVM-DE_SetTR069FirmwareDownloadEnabled
  • ❌ urn:dslforum-org:service:X_AVM-DE_Auth
  • ❌ urn:dslforum-org:service:Time
  • ❌ urn:dslforum-org:service:UserInterface
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.8.1 136 1/15/2025
2.8.0 110 1/8/2025
2.7.8 146 1/4/2025
2.7.7 131 1/1/2025
2.7.5 141 1/1/2025
2.5.1 144 12/15/2024
2.5.0-alpha0008 98 5/19/2024
2.5.0-alpha0004 139 3/22/2024
2.5.0-alpha0001 142 1/30/2024
2.5.0-alpha.15 77 12/15/2024
2.4.0 269 1/5/2024
2.4.0-alpha0090 129 1/5/2024
2.4.0-alpha0075 144 12/14/2023
2.4.0-alpha0061 157 6/23/2023
2.4.0-alpha0048 170 6/4/2023
2.4.0-alpha0036 165 5/19/2023
2.4.0-alpha0028 119 4/15/2023
2.4.0-alpha0021 143 2/21/2023
2.4.0-alpha0015 149 1/27/2023
2.4.0-alpha0010 151 1/27/2023
2.4.0-alpha0006 153 1/25/2023
2.4.0-alpha0003 143 1/25/2023
2.4.0-alpha0001 154 1/24/2023
2.3.0 239 1/24/2023
2.3.0-alpha0061 163 1/22/2023
2.3.0-alpha0049 150 1/19/2023
2.3.0-alpha0038 141 1/18/2023
2.3.0-alpha0028 179 1/16/2023
2.3.0-alpha0021 186 11/19/2022
2.3.0-alpha0015 164 10/28/2022
2.3.0-alpha0010 202 7/9/2022
2.3.0-alpha0006 187 5/11/2022
2.3.0-alpha0003 194 4/13/2022
2.3.0-alpha0001 183 4/12/2022
2.2.0 272 4/12/2022
2.2.0-alpha0131 185 4/12/2022
2.2.0-alpha0107 181 4/12/2022
2.2.0-alpha0084 181 4/8/2022
2.2.0-alpha0066 179 4/7/2022
2.2.0-alpha0050 186 4/7/2022
2.2.0-alpha0036 195 4/7/2022
2.2.0-alpha0023 181 4/6/2022
2.2.0-alpha0011 178 4/5/2022
2.2.0-alpha0003 180 4/4/2022
2.1.0 198 4/4/2022
2.1.0-alpha0316 179 4/4/2022
2.1.0-alpha0274 191 4/3/2022
2.1.0-alpha0234 193 4/1/2022
2.1.0-alpha0198 181 3/30/2022
2.1.0-alpha0168 175 3/28/2022
2.1.0-alpha0140 170 3/28/2022
2.1.0-alpha0114 178 3/28/2022
2.1.0-alpha0090 181 3/27/2022
2.1.0-alpha0068 183 3/27/2022
2.1.0-alpha0048 179 3/26/2022
2.1.0-alpha0032 179 3/25/2022
2.1.0-alpha0019 190 3/25/2022
2.1.0-alpha0008 180 3/24/2022
2.0.0 207 3/22/2022
2.0.0-beta0002 182 3/22/2022
2.0.0-beta0001 183 3/22/2022
2.0.0-alpha0011 178 3/24/2022
2.0.0-alpha0004 175 3/23/2022
1.1.0-alpha0161 185 3/22/2022
1.1.0-alpha0135 179 3/22/2022
1.1.0-alpha0111 177 3/22/2022
1.1.0-alpha0089 162 3/21/2022
1.1.0-alpha0069 175 3/21/2022
1.1.0-alpha0051 177 3/21/2022
1.1.0-alpha0036 180 3/21/2022
1.1.0-alpha0023 182 3/21/2022
1.1.0-alpha0012 177 3/20/2022
1.1.0-alpha0003 180 3/19/2022
1.1.0-alpha0001 181 3/19/2022
1.0.0 216 3/19/2022
1.0.0-beta0003 182 3/19/2022
1.0.0-beta0002 185 3/19/2022
1.0.0-beta0001 185 3/19/2022
0.2.0-alpha1222 178 3/19/2022
0.2.0-alpha1221 177 3/19/2022
0.2.0-alpha1118 175 3/19/2022
0.2.0-alpha1017 184 3/19/2022
0.2.0-alpha0926 176 3/19/2022
0.2.0-alpha0836 181 3/19/2022
0.2.0-alpha0747 179 3/18/2022
0.2.0-alpha0660 174 3/18/2022
0.2.0-alpha0574 184 3/18/2022
0.2.0-alpha0489 179 3/18/2022
0.2.0-alpha0405 192 3/18/2022
0.2.0-alpha0322 186 3/18/2022
0.2.0-alpha0240 181 3/18/2022
0.2.0-alpha0159 177 3/18/2022
0.2.0-alpha0079 182 3/17/2022
0.1.3 215 3/17/2022
0.1.3-alpha0051 192 3/17/2022
0.1.3-alpha0050 190 3/17/2022
0.1.3-alpha0049 180 3/17/2022
0.1.3-alpha0048 187 3/17/2022
0.1.3-alpha0047 187 3/16/2022
0.1.3-alpha0046 181 3/16/2022
0.1.3-alpha0045 181 3/16/2022
0.1.3-alpha.44 185 3/15/2022
0.1.3-alpha.43 181 3/14/2022
0.1.3-alpha.42 183 3/14/2022
0.1.3-alpha.41 177 3/14/2022
0.1.3-alpha.40 184 3/14/2022
0.1.3-alpha.39 174 3/14/2022
0.1.3-alpha.38 182 3/14/2022
0.1.3-alpha.37 186 3/14/2022
0.1.3-alpha.36 170 3/13/2022
0.1.3-alpha.35 186 3/13/2022
0.1.3-alpha.34 183 3/13/2022
0.1.3-alpha.33 177 3/13/2022
0.1.3-alpha.32 189 3/13/2022
0.1.3-alpha.31 176 3/13/2022
0.1.3-alpha.30 181 3/13/2022
0.1.3-alpha.29 174 3/13/2022
0.1.3-alpha.28 174 3/13/2022
0.1.3-alpha.27 176 3/13/2022
0.1.3-alpha.26 178 3/13/2022
0.1.3-alpha.8 181 3/13/2022
0.1.3-alpha.7 177 3/13/2022
0.1.3-alpha.4 185 3/13/2022
0.1.3-alpha.3 181 3/13/2022
0.1.3-alpha.2 202 3/13/2022
0.1.2 225 3/12/2022
0.1.2-alpha.15 203 3/12/2022
0.1.2-alpha.14 204 3/12/2022
0.1.2-alpha.13 196 3/12/2022
0.1.2-alpha.12 206 3/12/2022
0.1.2-alpha.11 205 3/12/2022
0.1.2-alpha.10 209 3/11/2022
0.1.2-alpha.7 204 3/11/2022
0.1.2-alpha.6 205 3/11/2022
0.1.2-alpha.2 208 3/10/2022
0.1.1 233 3/9/2022
0.1.1-alpha.10 197 3/10/2022
0.1.1-alpha.9 204 3/9/2022
0.1.1-alpha.6 207 3/9/2022
0.1.1-alpha.2 204 3/9/2022
0.1.0 219 3/7/2022
0.1.0-alpha.80 203 3/8/2022
0.1.0-alpha.79 211 3/8/2022
0.1.0-alpha.78 211 3/7/2022
0.1.0-alpha.77 205 3/6/2022
0.1.0-alpha.76 213 3/6/2022
0.1.0-alpha.75 193 3/6/2022
0.1.0-alpha.74 189 3/5/2022
0.1.0-alpha.73 206 3/5/2022
0.1.0-alpha.72 215 3/5/2022