Skip to content

Enable AvmOnTelConfigByIndex

Gincules edited this page Apr 4, 2023 · 1 revision

Enable-AvmOnTelConfigByIndex

Synopsis

Action: SetConfigByIndex
Available on: ✅ FRITZ!Box / 🚫 FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: ☎️

Description

This function sets config by index. If the given index addresses an existing account the configuration is changed. If the index addresses a new account and the index is OntelNumberOfEntries + 1 then a new account is generated.

Input:

Data type Variable Example or Description
Ushort NewIndex 0
Boolean NewEnable 0
String NewUrl https://myurl.provider.com
String NewServiceId MyServiceId
String NewUsername PhoneUser
SecureString NewPassword <SecureString>
String NewName My Great Phonebook-Name

Output:

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

Syntax

Enable-AvmOnTelConfigByIndex
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewIndex <Ushort>]
    [-NewEnable <Boolean>]
    [-NewUrl <String>]
    [-NewServiceId <String>]
    [-NewUsername <String>]
    [-NewPassword <SecureString>]
    [-NewName <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
    NewIndex = 0
    NewEnable = $true
    NewUrl = "https://phonebook.provider.com"
    NewServiceId = "0"
    NewUsername = "PhoneUser"
    NewPassword = $NewPassword 
    NewName = "My Great Phonebook"
}

Enable-AvmOnTelConfigByIndex @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
    NewIndex = 0
    NewEnable = $true
    NewUrl = "https://phonebook.provider.com"
    NewServiceId = "0"
    NewUsername = "PhoneUser"
    NewPassword = $NewPassword 
    NewName = "My Great Phonebook"
}

Enable-AvmOnTelConfigByIndex @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
    NewIndex = 0
    NewEnable = $true
    NewUrl = "https://phonebook.provider.com"
    NewServiceId = "0"
    NewUsername = "PhoneUser"
    NewPassword = $NewPassword 
    NewName = "My Great Phonebook"
}

Enable-AvmOnTelConfigByIndex @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
    NewIndex = 0
    NewEnable = $true
    NewUrl = "https://phonebook.provider.com"
    NewServiceId = "0"
    NewUsername = "PhoneUser"
    NewPassword = $NewPassword 
    NewName = "My Great Phonebook"
}

Enable-AvmOnTelConfigByIndex @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
    NewIndex = 0
    NewEnable = $true
    NewUrl = "https://phonebook.provider.com"
    NewServiceId = "0"
    NewUsername = "PhoneUser"
    NewPassword = $NewPassword 
    NewName = "My Great Phonebook"
}

Enable-AvmOnTelConfigByIndex @splatParameters
Clone this wiki locally