Set AvmAuthConfig

Set-AvmAuthConfig

Synopsis

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

Description

This function starts or stops a two-factor-authentication for the current user.

Input:

Data type	Variable	Example or Description
String	NewAction	start, stop

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:X_AVM-DE_Auth:1
StateEnum	NewState	waitingforauth
UUID	NewToken	1234abc-1a2b-1a2b-1a2b-123a123b123c
String	NewMethods	button,dtmf;*12956

Syntax

Set-AvmAuthConfig
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewAction <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
    NewAction = "start"
}

Set-AvmAuthConfig @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
    NewAction = "start"
}

Set-AvmAuthConfig @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
    NewAction = "start"
}

Set-AvmAuthConfig @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
    NewAction = "start"
}

Set-AvmAuthConfig @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
    NewAction = "start"
}

Set-AvmAuthConfig @splatParameters