Set AvmAppMessageReceiver

Set-AvmAppMessageReceiver

Synopsis

Action: SetAppMessageReceiver
Available on: ✅ FRITZ!Box / 🚫 FRITZ!Repeater
Status: ⚠️
Remote access: 🚫
Required rights: 🔧 / ⚙️ / ☎️ / 🖴 / 🏠

Description

This function configures of a message receiver for the app instance. Every app instance can have at most only one message receiver configuration. In case a message receiver already exists for the app instance, the old configuration is overwritten (deleted).

The security context of this action must belong to an app instance. The app instance of the security context must the same as the one identified by the parameter NewAppId.

Input:

Data type	Variable	Example or Description
String	NewAppId	1
String	NewCryptAlgos
String	NewAppAVMAddress
SecureString	NewAppAVMPasswordHash

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:X_AVM-DE_AppSetup:1
String	NewEncryptionSecret
String	NewBoxSenderId

Syntax

Set-AvmAppMessageReceiver
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewAppId <String>]
    [-NewCryptAlgos <String>]
    [-NewAppAVMAddress <String>]
    [-NewAppAVMPasswordHash <SecureString>]

Examples

Example 1

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]$NewAppPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    Url = "https://fritz.box"
    Port = 49443
    Credential = $Credential
    NewAppId = "1"
    NewCryptAlgos = ""
    NewAppAVMAddress = ""
    NewAppAVMPasswordHash = $NewAppAVMPasswordHash 
}

Set-AvmAppMessageReceiver @splatParameters

IP address can be used instead of DNS name.

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

$splatParameters = @{
    Url = "https://192.168.178.1"
    Port = 49443
    Credential = $Credential
    NewAppId = "1"
    NewCryptAlgos = ""
    NewAppAVMAddress = ""
    NewAppAVMPasswordHash = $NewAppAVMPasswordHash 
}

Set-AvmAppMessageReceiver @splatParameters

Example 2

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]$NewAppPassword = Get-Content -Path "${env:APPDATA}\PScred\function-password.txt" | ConvertTo-SecureString

$splatParameters = @{
    Insecure = $true
    Url = "http://fritz.box"
    Port = 49000
    Credential = $Credential
    NewAppId = "1"
    NewCryptAlgos = ""
    NewAppAVMAddress = ""
    NewAppAVMPasswordHash = $NewAppAVMPasswordHash 
}

Set-AvmAppMessageReceiver @splatParameters

IP address can be used instead of DNS name.

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

$splatParameters = @{
    Insecure = $true
    Url = "http://192.168.178.1"
    Port = 49000
    Credential = $Credential
    NewAppId = "1"
    NewCryptAlgos = ""
    NewAppAVMAddress = ""
    NewAppAVMPasswordHash = $NewAppAVMPasswordHash 
}

Set-AvmAppMessageReceiver @splatParameters