Get AvmMyFritzServiceByIndex

Get-AvmMyFritzServiceByIndex

Synopsis

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

Description

This function returns the list of MyFRITZ! services by index.

Input:

Data type	Variable	Example or Description
Uint	NewIndex	0

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:X_AVM-DE_MyFritz:1
Boolean	NewEnabled	1
String	NewName	l33tsp34k
String	NewScheme	https://
Uint	NewPort	1337
String	NewURLPath
String	NewType	`<empty> or servicetype_app_camera`
Sbyte	NewIPv4ForwardingWarning	`0 = unknown` `1 = IPv4Forwarding not necessary or succeeded` `2 = IPv4Forwarding failed`
String	NewIPv4Addresses	10.10.10.10
String	NewIPv6Addresses
String	NewIPv6InterfaceIDs
String	NewMACAddress
String	NewHostName
String	NewDynDnsLabel	ubuntuserver
String	NewStatus	200

Syntax

Get-AvmMyFritzServiceByIndex
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewIndex <Uint>]

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
}

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
}

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
}

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
}

Get-AvmMyFritzServiceByIndex @splatParameters