Get AvmIpSpecificPortMappingEntry

Get-AvmIpSpecificPortMappingEntry

Synopsis

Action: GetSpecificPortMappingEntry
Available on: ✅ FRITZ!Box / 🚫 FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: 🔧

Description

This function returns specific port mapping entry.

Input:

Data type	Variable	Example or Description
String	NewRemoteHost	0.0.0.0
Ushort	NewExternalPort	22
String	NewProtocol	TCP

Output:

Data type	Variable	Example
String	u	urn:dslforum-org:service:WANIPConnection:1
String	NewInternalPort	22
String	NewInternalClient	192.168.178.2
String	NewEnabled	1
String	NewPortMappingDescription	SSH-Server
String	NewLeaseDuration	0

Syntax

Get-AvmIpSpecificPortMappingEntry
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewRemoteHost <String>]
    [-NewExternalPort <Ushort>]
    [-NewProtocol <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
    NewRemoteHost = "0.0.0.0"
    NewExternalPort = 22
    NewProtocol = "TCP"
}

Get-AvmIpSpecificPortMappingEntry @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
    NewRemoteHost = "0.0.0.0"
    NewExternalPort = 22
    NewProtocol = "TCP"
}

Get-AvmIpSpecificPortMappingEntry @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
    NewRemoteHost = "0.0.0.0"
    NewExternalPort = 22
    NewProtocol = "TCP"
}

Get-AvmIpSpecificPortMappingEntry @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
    NewRemoteHost = "0.0.0.0"
    NewExternalPort = 22
    NewProtocol = "TCP"
}

Get-AvmIpSpecificPortMappingEntry @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
    NewRemoteHost = "0.0.0.0"
    NewExternalPort = 22
    NewProtocol = "TCP"
}

Get-AvmIpSpecificPortMappingEntry @splatParameters