Get AvmHostSpecificEntryByIp

Get-AvmHostSpecificEntryByIp

Synopsis

Action: X_AVM-DE_GetSpecificHostEntryByIp
Available on: ✅ FRITZ!Box / ✅ FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: 🔧 / ⚙️ / ☎️

Description

This function returns a specific host entry by IP address.

Input:

Data type	Variable	Example or Description
String	NewIPAddress	192.168.178.123

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:Hosts:1
String	NewMACAddress	AB:CD:EF:12:34:56
Boolean	NewActive	1
String	NewHostName	E810
String	NewInterfaceType	`Ethernet, 802.11, HomePlug or <empty>`
Int	NewX_AVM-DE_Port	2
Int	NewX_AVM-DE_Speed	1000
Boolean	NewX_AVM-DE_UpdateAvailable	0
String	NewX_AVM-DE_UpdateSuccessful	`unknown, failed or succeeded`
String	NewX_AVM-DE_InfoURL
String	NewX_AVM-DE_Model
String	NewX_AVM-DE_URL

Syntax

Get-AvmHostSpecificEntryByIp
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewIPAddress <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
    NewIPAddress = "192.168.178.123"
}

Get-AvmHostSpecificEntryByIp @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
    NewIPAddress = "192.168.178.123"
}

Get-AvmHostSpecificEntryByIp @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
    NewIPAddress = "192.168.178.123"
}

Get-AvmHostSpecificEntryByIp @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
    NewIPAddress = "192.168.178.123"
}

Get-AvmHostSpecificEntryByIp @splatParameters