Get AvmHostListPath - Gincules/avmtools GitHub Wiki

Get-AvmHostListPath

Synopsis

Action: X_AVM-DE_GetHostListPath
Available on: ✅ FRITZ!Box / ✅ FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: 🔧 / ⚙ī¸ / ☎ī¸

Description

This function returns a path to a lua script file, which generates an XML structured list of hosts.

Output:

Data type Variable Example
String u urn:dslforum-org:service:Hosts:1
String NewX_AVM-DE_HostListPath /devicehostlist.lua?sid=a1b234cd5e67f890

Syntax

Get-AvmHostListPath
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]

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
}

Get-AvmHostListPath @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
}

Get-AvmHostListPath @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
}

Get-AvmHostListPath @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
}

Get-AvmHostListPath @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
}

Get-AvmHostListPath @splatParameters

Copyright Šī¸ 2020 Gincules. All rights reserved.

⚠ī¸ **GitHub.com Fallback** ⚠ī¸