Set AvmAppMessageFilter

Set-AvmAppMessageFilter

Synopsis

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

Description

This function can add multiple message filters of different types to each app instance. If an app instance already contains a filter with the same type, it is overwritten. A filter consists of the type and a list of filter criteria. If an empty list of filter criteria is passed, the filter of this type is completely removed from the app configuration

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	NewType	aha_ident, tel_local_number
String	NewEventId	A stringlist of filter criteria

Output:

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

Syntax

Set-AvmAppMessageFilter
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewAppId <String>]
    [-NewType <String>]
    [-NewFilter <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"

$splatParameters = @{
    RemoteAccess = $true
    Url = "https://myfritzaddress12.myfritz.net"
    Port = 443
    Credential = $Credential
    NewAppId = "1"
    NewType = "aha_ident"
    NewFilter = "08761 0000444,34:45:12:43:55"
}

Set-AvmAppMessageFilter @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"

$splatParameters = @{
    Url = "https://fritz.box"
    Port = 49443
    Credential = $Credential
    NewAppId = "1"
    NewType = "aha_ident"
    NewFilter = "08761 0000444,34:45:12:43:55"
}

Set-AvmAppMessageFilter @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Url = "https://192.168.178.1"
    Port = 49443
    Credential = $Credential
    NewAppId = "1"
    NewType = "aha_ident"
    NewFilter = "08761 0000444,34:45:12:43:55"
}

Set-AvmAppMessageFilter @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"

$splatParameters = @{
    Insecure = $true
    Url = "http://fritz.box"
    Port = 49000
    Credential = $Credential
    NewAppId = "1"
    NewType = "aha_ident"
    NewFilter = "08761 0000444,34:45:12:43:55"
}

Set-AvmAppMessageFilter @splatParameters

IP address can be used instead of DNS name.

[PSCredential]$Credential = Import-Clixml -Path "${env:APPDATA}\PScred\avmtools-credential.xml"

$splatParameters = @{
    Insecure = $true
    Url = "http://192.168.178.1"
    Port = 49000
    Credential = $Credential
    NewAppId = "1"
    NewType = "aha_ident"
    NewFilter = "08761 0000444,34:45:12:43:55"
}

Set-AvmAppMessageFilter @splatParameters