RS.Fritz.Manager.API 2.0.0-beta0002

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.0.0-beta0002
                    
NuGet\Install-Package RS.Fritz.Manager.API -Version 2.0.0-beta0002
                    
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.0.0-beta0002" />
                    
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.0.0-beta0002" />
                    
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.0.0-beta0002
                    
#r "nuget: RS.Fritz.Manager.API, 2.0.0-beta0002"
                    
#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.0.0-beta0002
                    
#: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.0.0-beta0002&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=RS.Fritz.Manager.API&version=2.0.0-beta0002&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.Value.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}"));

// Capture live network traffic from router to file
ICaptureControlService captureControlService = serviceScope.ServiceProvider.GetRequiredService<ICaptureControlService>();
Task.Run(() => StopCaptureAfter10SecondsAsync(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 StopCaptureAfter10SecondsAsync(InternetGatewayDevice device, ICaptureControlService captureControlService)
{
    await Task.Delay(10000);
    await captureControlService.GetStopCaptureResponseAsync(device);
}

TR-064 Service implementation status

WAN

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

Telephony

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

Home network

  • 🔶 urn:dslforum-org:service:Hosts:1
    • ✅ 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:1
  • ❌ urn:dslforum-org:service:LANHostConfigManagement:1
  • ❌ urn:dslforum-org:service:LANEthernetInterfaceConfig:1
  • ❌ urn:dslforum-org:service:X_AVM-DE_Dect:1
  • ❌ urn:dslforum-org:service:X_AVM-DE_Homeauto:1
  • ❌ urn:dslforum-org:service:X_AVM-DE_Homeplug:1

Storage/NAS

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

System

  • ✅ urn:dslforum-org:service:DeviceInfo:1
    • ✅ GetInfo
    • ✅ SetProvisioningCode
    • ✅ GetDeviceLog
    • ✅ GetSecurityPort
  • ❌ urn:dslforum-org:service:DeviceConfig:1
  • ✅ urn:dslforum-org:service:LANConfigSecurity:1
    • ✅ GetInfo
    • ✅ X_AVM-DE_GetAnonymousLogin
    • ✅ X_AVM-DE_GetCurrentUser
    • ✅ SetConfigPassword
    • ✅ X_AVM-DE_GetUserList
  • ❌ urn:dslforum-org:service:X_AVM-DE_AppSetup:1
  • ❌ urn:dslforum-org:service:X_AVM-DE_Auth:1
  • ❌ urn:dslforum-org:service:Time:1
  • ❌ urn:dslforum-org:service:UserInterface:1
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.6 475 12/9/2025
2.8.5 442 12/9/2025
2.8.1 242 1/15/2025
2.8.0 206 1/8/2025
2.7.8 227 1/4/2025
2.7.7 223 1/1/2025
2.7.5 219 1/1/2025
2.5.1 228 12/15/2024
2.5.0-alpha0008 146 5/19/2024
2.5.0-alpha0004 193 3/22/2024
2.5.0-alpha0001 187 1/30/2024
2.5.0-alpha.15 106 12/15/2024
2.4.0 356 1/5/2024
2.4.0-alpha0090 177 1/5/2024
2.4.0-alpha0075 192 12/14/2023
2.4.0-alpha0061 235 6/23/2023
2.4.0-alpha0048 249 6/4/2023
2.4.0-alpha0036 254 5/19/2023
2.4.0-alpha0028 184 4/15/2023
2.4.0-alpha0021 205 2/21/2023
2.4.0-alpha0015 214 1/27/2023
2.4.0-alpha0010 220 1/27/2023
2.4.0-alpha0006 212 1/25/2023
2.4.0-alpha0003 213 1/25/2023
2.4.0-alpha0001 220 1/24/2023
2.3.0 306 1/24/2023
2.3.0-alpha0061 237 1/22/2023
2.3.0-alpha0049 223 1/19/2023
2.3.0-alpha0038 208 1/18/2023
2.3.0-alpha0028 268 1/16/2023
2.3.0-alpha0021 267 11/19/2022
2.3.0-alpha0015 231 10/28/2022
2.3.0-alpha0010 277 7/9/2022
2.3.0-alpha0006 261 5/11/2022
2.3.0-alpha0003 260 4/13/2022
2.3.0-alpha0001 252 4/12/2022
2.2.0 344 4/12/2022
2.2.0-alpha0131 250 4/12/2022
2.2.0-alpha0107 249 4/12/2022
2.2.0-alpha0084 242 4/8/2022
2.2.0-alpha0066 261 4/7/2022
2.2.0-alpha0050 254 4/7/2022
2.2.0-alpha0036 260 4/7/2022
2.2.0-alpha0023 247 4/6/2022
2.2.0-alpha0011 253 4/5/2022
2.2.0-alpha0003 248 4/4/2022
2.1.0 265 4/4/2022
2.1.0-alpha0316 258 4/4/2022
2.1.0-alpha0274 258 4/3/2022
2.1.0-alpha0234 260 4/1/2022
2.1.0-alpha0198 249 3/30/2022
2.1.0-alpha0168 243 3/28/2022
2.1.0-alpha0140 240 3/28/2022
2.1.0-alpha0114 250 3/28/2022
2.1.0-alpha0090 244 3/27/2022
2.1.0-alpha0068 256 3/27/2022
2.1.0-alpha0048 257 3/26/2022
2.1.0-alpha0032 250 3/25/2022
2.1.0-alpha0019 258 3/25/2022
2.1.0-alpha0008 252 3/24/2022
2.0.0 280 3/22/2022
2.0.0-beta0002 250 3/22/2022
2.0.0-beta0001 248 3/22/2022
2.0.0-alpha0011 240 3/24/2022
2.0.0-alpha0004 240 3/23/2022
1.1.0-alpha0161 254 3/22/2022
1.1.0-alpha0135 249 3/22/2022
1.1.0-alpha0111 247 3/22/2022
1.1.0-alpha0089 229 3/21/2022
1.1.0-alpha0069 246 3/21/2022
1.1.0-alpha0051 247 3/21/2022
1.1.0-alpha0036 250 3/21/2022
1.1.0-alpha0023 253 3/21/2022
1.1.0-alpha0012 240 3/20/2022
1.1.0-alpha0003 244 3/19/2022
1.1.0-alpha0001 246 3/19/2022
1.0.0 290 3/19/2022
1.0.0-beta0003 244 3/19/2022
1.0.0-beta0002 251 3/19/2022
1.0.0-beta0001 245 3/19/2022
0.2.0-alpha1222 242 3/19/2022
0.2.0-alpha1221 237 3/19/2022
0.2.0-alpha1118 250 3/19/2022
0.2.0-alpha1017 253 3/19/2022
0.2.0-alpha0926 246 3/19/2022
0.2.0-alpha0836 241 3/19/2022
0.2.0-alpha0747 242 3/18/2022
0.2.0-alpha0660 247 3/18/2022
0.2.0-alpha0574 249 3/18/2022
0.2.0-alpha0489 245 3/18/2022
0.2.0-alpha0405 254 3/18/2022
0.2.0-alpha0322 257 3/18/2022
0.2.0-alpha0240 248 3/18/2022
0.2.0-alpha0159 247 3/18/2022
0.2.0-alpha0079 265 3/17/2022
0.1.3 287 3/17/2022
0.1.3-alpha0051 261 3/17/2022
0.1.3-alpha0050 255 3/17/2022
0.1.3-alpha0049 244 3/17/2022
0.1.3-alpha0048 261 3/17/2022
0.1.3-alpha0047 265 3/16/2022
0.1.3-alpha0046 261 3/16/2022
0.1.3-alpha0045 247 3/16/2022
0.1.3-alpha.44 255 3/15/2022
0.1.3-alpha.43 249 3/14/2022
0.1.3-alpha.42 251 3/14/2022
0.1.3-alpha.41 246 3/14/2022
0.1.3-alpha.40 241 3/14/2022
0.1.3-alpha.39 241 3/14/2022
0.1.3-alpha.38 248 3/14/2022
0.1.3-alpha.37 255 3/14/2022
0.1.3-alpha.36 238 3/13/2022
0.1.3-alpha.35 250 3/13/2022
0.1.3-alpha.34 247 3/13/2022
0.1.3-alpha.33 249 3/13/2022
0.1.3-alpha.32 265 3/13/2022
0.1.3-alpha.31 246 3/13/2022
0.1.3-alpha.30 248 3/13/2022
0.1.3-alpha.29 239 3/13/2022
0.1.3-alpha.28 240 3/13/2022
0.1.3-alpha.27 250 3/13/2022
0.1.3-alpha.26 244 3/13/2022
0.1.3-alpha.8 247 3/13/2022
0.1.3-alpha.7 246 3/13/2022
0.1.3-alpha.4 260 3/13/2022
0.1.3-alpha.3 251 3/13/2022
0.1.3-alpha.2 268 3/13/2022
0.1.2 300 3/12/2022
0.1.2-alpha.15 269 3/12/2022
0.1.2-alpha.14 272 3/12/2022
0.1.2-alpha.13 264 3/12/2022
0.1.2-alpha.12 277 3/12/2022
0.1.2-alpha.11 277 3/12/2022
0.1.2-alpha.10 280 3/11/2022
0.1.2-alpha.7 278 3/11/2022
0.1.2-alpha.6 275 3/11/2022
0.1.2-alpha.2 280 3/10/2022
0.1.1 298 3/9/2022
0.1.1-alpha.10 269 3/10/2022
0.1.1-alpha.9 278 3/9/2022
0.1.1-alpha.6 274 3/9/2022
0.1.1-alpha.2 270 3/9/2022
0.1.0 295 3/7/2022
0.1.0-alpha.80 274 3/8/2022
0.1.0-alpha.79 289 3/8/2022
0.1.0-alpha.78 282 3/7/2022
0.1.0-alpha.77 273 3/6/2022
0.1.0-alpha.76 278 3/6/2022
0.1.0-alpha.75 257 3/6/2022
0.1.0-alpha.74 260 3/5/2022
0.1.0-alpha.73 275 3/5/2022
0.1.0-alpha.72 280 3/5/2022