Set AvmMyFritzServiceByIndex

Get-AvmMyFritzServiceByIndex

Synopsis

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

Description

This function adds a new entry to the list of MyFRITZ! services or change an existing entry in the list of MyFRITZ! Services.

The list of services may be reordered after a change. Clients can only add services for themselves(their IP address).

Input:

Data type	Variable	Example or Description
Uint	NewIndex	0
Boolean	NewEnabled	0
String	NewName	FTP-Server
String	NewScheme	ftp://
Uint	NewPort	21
String	NewURLPath
String	NewType
String	NewIPv4Address	10.10.10.10
String	NewIPv6Address
String	NewIPv6InterfaceID
String	NewMACAddress	AB:CD:EF:12:34:56
String	NewHostName	ubuntuserver

Output:

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

Syntax

Get-AvmMyFritzServiceByIndex
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewIndex <Uint>]
    [-NewEnabled <Boolean>]
    [-NewName <String>]
    [-NewScheme <String>]
    [-NewPort <Uint>]
    [-NewURLPath <String>]
    [-NewType <String>]
    [-NewIPv4Address <String>]
    [-NewIPv6Address <String>]
    [-NewIPv6InterfaceID <String>]
    [-NewMACAddress <String>]
    [-NewHostName <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
    NewIndex = 0
    NewEnabled = 0
    NewName = "FTP-Server"
    NewScheme = "ftp://"
    NewPort = 21
    NewIPv4Address = "10.10.10.10"
    NewHostName = "ubuntuserver"
}

Get-AvmMyFritzServiceByIndex @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
    NewIndex = 0
    NewEnabled = 0
    NewName = "FTP-Server"
    NewScheme = "ftp://"
    NewPort = 21
    NewIPv4Address = "10.10.10.10"
    NewHostName = "ubuntuserver"
}

Get-AvmMyFritzServiceByIndex @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
    NewIndex = 0
    NewEnabled = 0
    NewName = "FTP-Server"
    NewScheme = "ftp://"
    NewPort = 21
    NewIPv4Address = "10.10.10.10"
    NewHostName = "ubuntuserver"
}

Get-AvmMyFritzServiceByIndex @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
    NewIndex = 0
    NewEnabled = 0
    NewName = "FTP-Server"
    NewScheme = "ftp://"
    NewPort = 21
    NewIPv4Address = "10.10.10.10"
    NewHostName = "ubuntuserver"
}

Get-AvmMyFritzServiceByIndex @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
    NewIndex = 0
    NewEnabled = 0
    NewName = "FTP-Server"
    NewScheme = "ftp://"
    NewPort = 21
    NewIPv4Address = "10.10.10.10"
    NewHostName = "ubuntuserver"
}

Get-AvmMyFritzServiceByIndex @splatParameters