RS.Fritz.Manager.API 2.0.0

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                
NuGet\Install-Package RS.Fritz.Manager.API -Version 2.0.0                
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" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add RS.Fritz.Manager.API --version 2.0.0                
#r "nuget: RS.Fritz.Manager.API, 2.0.0"                
#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.
// Install RS.Fritz.Manager.API as a Cake Addin
#addin nuget:?package=RS.Fritz.Manager.API&version=2.0.0

// Install RS.Fritz.Manager.API as a Cake Tool
#tool nuget:?package=RS.Fritz.Manager.API&version=2.0.0                

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. 
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.5.0-alpha0008 83 5/19/2024
2.5.0-alpha0004 118 3/22/2024
2.5.0-alpha0001 119 1/30/2024
2.4.0 227 1/5/2024
2.4.0-alpha0090 104 1/5/2024
2.4.0-alpha0075 124 12/14/2023
2.4.0-alpha0061 127 6/23/2023
2.4.0-alpha0048 128 6/4/2023
2.4.0-alpha0036 124 5/19/2023
2.4.0-alpha0028 81 4/15/2023
2.4.0-alpha0021 104 2/21/2023
2.4.0-alpha0015 106 1/27/2023
2.4.0-alpha0010 106 1/27/2023
2.4.0-alpha0006 115 1/25/2023
2.4.0-alpha0003 101 1/25/2023
2.4.0-alpha0001 111 1/24/2023
2.3.0 189 1/24/2023
2.3.0-alpha0061 114 1/22/2023
2.3.0-alpha0049 103 1/19/2023
2.3.0-alpha0038 96 1/18/2023
2.3.0-alpha0028 138 1/16/2023
2.3.0-alpha0021 142 11/19/2022
2.3.0-alpha0015 120 10/28/2022
2.3.0-alpha0010 135 7/9/2022
2.3.0-alpha0006 132 5/11/2022
2.3.0-alpha0003 128 4/13/2022
2.3.0-alpha0001 122 4/12/2022
2.2.0 209 4/12/2022
2.2.0-alpha0131 123 4/12/2022
2.2.0-alpha0107 121 4/12/2022
2.2.0-alpha0084 123 4/8/2022
2.2.0-alpha0066 121 4/7/2022
2.2.0-alpha0050 129 4/7/2022
2.2.0-alpha0036 136 4/7/2022
2.2.0-alpha0023 120 4/6/2022
2.2.0-alpha0011 120 4/5/2022
2.2.0-alpha0003 120 4/4/2022
2.1.0 136 4/4/2022
2.1.0-alpha0316 117 4/4/2022
2.1.0-alpha0274 127 4/3/2022
2.1.0-alpha0234 135 4/1/2022
2.1.0-alpha0198 125 3/30/2022
2.1.0-alpha0168 119 3/28/2022
2.1.0-alpha0140 112 3/28/2022
2.1.0-alpha0114 120 3/28/2022
2.1.0-alpha0090 124 3/27/2022
2.1.0-alpha0068 119 3/27/2022
2.1.0-alpha0048 114 3/26/2022
2.1.0-alpha0032 119 3/25/2022
2.1.0-alpha0019 128 3/25/2022
2.1.0-alpha0008 118 3/24/2022
2.0.0 141 3/22/2022
2.0.0-beta0002 121 3/22/2022
2.0.0-beta0001 123 3/22/2022
2.0.0-alpha0011 115 3/24/2022
2.0.0-alpha0004 116 3/23/2022
1.1.0-alpha0161 122 3/22/2022
1.1.0-alpha0135 119 3/22/2022
1.1.0-alpha0111 117 3/22/2022
1.1.0-alpha0089 103 3/21/2022
1.1.0-alpha0069 114 3/21/2022
1.1.0-alpha0051 114 3/21/2022
1.1.0-alpha0036 119 3/21/2022
1.1.0-alpha0023 119 3/21/2022
1.1.0-alpha0012 118 3/20/2022
1.1.0-alpha0003 119 3/19/2022
1.1.0-alpha0001 120 3/19/2022
1.0.0 151 3/19/2022
1.0.0-beta0003 121 3/19/2022
1.0.0-beta0002 122 3/19/2022
1.0.0-beta0001 122 3/19/2022
0.2.0-alpha1222 117 3/19/2022
0.2.0-alpha1221 119 3/19/2022
0.2.0-alpha1118 117 3/19/2022
0.2.0-alpha1017 121 3/19/2022
0.2.0-alpha0926 117 3/19/2022
0.2.0-alpha0836 120 3/19/2022
0.2.0-alpha0747 119 3/18/2022
0.2.0-alpha0660 113 3/18/2022
0.2.0-alpha0574 119 3/18/2022
0.2.0-alpha0489 115 3/18/2022
0.2.0-alpha0405 126 3/18/2022
0.2.0-alpha0322 121 3/18/2022
0.2.0-alpha0240 119 3/18/2022
0.2.0-alpha0159 115 3/18/2022
0.2.0-alpha0079 118 3/17/2022
0.1.3 146 3/17/2022
0.1.3-alpha0051 131 3/17/2022
0.1.3-alpha0050 126 3/17/2022
0.1.3-alpha0049 121 3/17/2022
0.1.3-alpha0048 122 3/17/2022
0.1.3-alpha0047 123 3/16/2022
0.1.3-alpha0046 123 3/16/2022
0.1.3-alpha0045 121 3/16/2022
0.1.3-alpha.44 123 3/15/2022
0.1.3-alpha.43 123 3/14/2022
0.1.3-alpha.42 122 3/14/2022
0.1.3-alpha.41 118 3/14/2022
0.1.3-alpha.40 126 3/14/2022
0.1.3-alpha.39 114 3/14/2022
0.1.3-alpha.38 116 3/14/2022
0.1.3-alpha.37 123 3/14/2022
0.1.3-alpha.36 112 3/13/2022
0.1.3-alpha.35 126 3/13/2022
0.1.3-alpha.34 124 3/13/2022
0.1.3-alpha.33 121 3/13/2022
0.1.3-alpha.32 126 3/13/2022
0.1.3-alpha.31 120 3/13/2022
0.1.3-alpha.30 118 3/13/2022
0.1.3-alpha.29 115 3/13/2022
0.1.3-alpha.28 114 3/13/2022
0.1.3-alpha.27 119 3/13/2022
0.1.3-alpha.26 120 3/13/2022
0.1.3-alpha.8 122 3/13/2022
0.1.3-alpha.7 119 3/13/2022
0.1.3-alpha.4 125 3/13/2022
0.1.3-alpha.3 123 3/13/2022
0.1.3-alpha.2 143 3/13/2022
0.1.2 158 3/12/2022
0.1.2-alpha.15 146 3/12/2022
0.1.2-alpha.14 146 3/12/2022
0.1.2-alpha.13 136 3/12/2022
0.1.2-alpha.12 145 3/12/2022
0.1.2-alpha.11 145 3/12/2022
0.1.2-alpha.10 150 3/11/2022
0.1.2-alpha.7 146 3/11/2022
0.1.2-alpha.6 146 3/11/2022
0.1.2-alpha.2 148 3/10/2022
0.1.1 165 3/9/2022
0.1.1-alpha.10 138 3/10/2022
0.1.1-alpha.9 145 3/9/2022
0.1.1-alpha.6 151 3/9/2022
0.1.1-alpha.2 146 3/9/2022
0.1.0 154 3/7/2022
0.1.0-alpha.80 143 3/8/2022
0.1.0-alpha.79 151 3/8/2022
0.1.0-alpha.78 152 3/7/2022
0.1.0-alpha.77 143 3/6/2022
0.1.0-alpha.76 144 3/6/2022
0.1.0-alpha.75 134 3/6/2022
0.1.0-alpha.74 131 3/5/2022
0.1.0-alpha.73 143 3/5/2022
0.1.0-alpha.72 157 3/5/2022