Set AvmRemoteAccessDdnsConfig

Enable-AvmRemoteAccess

Synopsis

Action: SetDDNSConfig
Available on: ✅ FRITZ!Box / 🚫 FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: 🔧

Description

This function sets devices dyn-DNS configuration.

Input:

Data type	Variable	Example or Description
Boolean	NewEnable	1
String	NewProviderName	User-defined
String	NewUpdateURL	https://freedns.afraid.org/dynamic/update.php?1a2b3c4d5e6f=
String	NewServerIPv4
String	NewServerIPv6
String	NewDomain	mydomain.provider.com
String	NewUsername	username@provider.com
SecureString	NewPassword	<SecureString>
String	NewMode	ddns_v4, ddns_v6 or ddns_both

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:X_AVM-DE_RemoteAccess:1

Syntax

Enable-AvmRemoteAccess
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewEnabled <Boolean>]
    [-NewProviderName <String>]
    [-NewUpdateURL <String>]
    [-NewServerIPv4 <String>]
    [-NewServerIPv6 <String>]
    [-NewDomain <String>]
    [-NewUsername <String>]
    [-NewPassword <SecureString>]
    [-NewMode <String>]

Examples

Example 1

This example describes how to run the command using a valid certificate and remote access.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"
[SecureString]$NewPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    RemoteAccess = $true
    Url = "https://myfritzaddress12.myfritz.net"
    Port = 443
    Credential = $Credential
    NewEnabled = 1
    NewProviderName = "User-defined"
    NewUpdateURL = "https://freedns.afraid.org/dynamic/update.php?1a2b3c4d5e6f="
    NewDomain = "mydomain.provider.com"
    NewUsername = "username@provider.com"
    NewPassword = $NewPassword 
    NewMode = "ddns_v4"
}

Enable-AvmRemoteAccess @splatParameters

Example 2

This example describes how to run the command using local connection with a valid certificate.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"
[SecureString]$NewPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    Url = "https://fritz.box"
    Port = 49443
    Credential = $Credential
    NewEnabled = 1
    NewProviderName = "User-defined"
    NewUpdateURL = "https://freedns.afraid.org/dynamic/update.php?1a2b3c4d5e6f="
    NewDomain = "mydomain.provider.com"
    NewUsername = "username@provider.com"
    NewPassword = $NewPassword 
    NewMode = "ddns_v4"
}

Enable-AvmRemoteAccess @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"
[SecureString]$NewPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    Url = "https://192.168.178.1"
    Port = 49443
    Credential = $Credential
    NewEnabled = 1
    NewProviderName = "User-defined"
    NewUpdateURL = "https://freedns.afraid.org/dynamic/update.php?1a2b3c4d5e6f="
    NewDomain = "mydomain.provider.com"
    NewUsername = "username@provider.com"
    NewPassword = $NewPassword 
    NewMode = "ddns_v4"
}

Enable-AvmRemoteAccess @splatParameters

Example 3

This example describes how to run the command using local connection without a valid certificate.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"
[SecureString]$NewPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    Insecure = $true
    Url = "http://fritz.box"
    Port = 49000
    Credential = $Credential
    NewEnabled = 1
    NewProviderName = "User-defined"
    NewUpdateURL = "https://freedns.afraid.org/dynamic/update.php?1a2b3c4d5e6f="
    NewDomain = "mydomain.provider.com"
    NewUsername = "username@provider.com"
    NewPassword = $NewPassword 
    NewMode = "ddns_v4"
}

Enable-AvmRemoteAccess @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"
[SecureString]$NewPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    Insecure = $true
    Url = "http://192.168.178.1"
    Port = 49000
    Credential = $Credential
    NewEnabled = 1
    NewProviderName = "User-defined"
    NewUpdateURL = "https://freedns.afraid.org/dynamic/update.php?1a2b3c4d5e6f="
    NewDomain = "mydomain.provider.com"
    NewUsername = "username@provider.com"
    NewPassword = $NewPassword 
    NewMode = "ddns_v4"
}

Enable-AvmRemoteAccess @splatParameters