Get AvmWanOnlineMonitor - Gincules/avmtools GitHub Wiki

Get-AvmWanOnlineMonitor

Synopsis

Action: X_AVM-DE_GetOnlineMonitor
Available on: ✅ FRITZ!Box / đŸšĢ FRITZ!Repeater
Status: ✅
Remote access: ✅
Required rights: 🔧

Description

This function returns WAN common interface config online details by id.

Input:

Data type Variable Example or Description
Uint NewSyncGroupIndex 0

Output:

Data type Variable Example
String u urn:dslforum-org:service:WANCommonInterfaceConfig:1
Uint NewTotalNumberSyncGroups 2
String NewSyncGroupName sync_cable
String NewSyncGroupMode CABLE
Uint Newmax_ds 74674903
Uint Newmax_us 4334739
String Newds_current_bps 568101,925215,61676,480651,442794,...
String Newmc_current_bps 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
String Newus_current_bps 25850,32156,20661,28682,9170,...
String Newprio_realtime_bps 2815,1148,2797,3456,4150,...
String Newprio_high_bps 5446,2625,65,4759,3363,...
String Newprio_default_bps 17589,28383,17799,20467,1657,...
String Newprio_low_bps 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0

Syntax

Get-AvmWanOnlineMonitor
    [-Insecure]
    [-RemoteAccess]
    [-Url <String>]
    [-Port <Ushort>]
    [-Credential <PSCredential>]
    [-NewSyncGroupIndex <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
    NewSyncGroupIndex  = 0
}

Get-AvmWanOnlineMonitor @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
    NewSyncGroupIndex  = 0
}

Get-AvmWanOnlineMonitor @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
    NewSyncGroupIndex  = 0
}

Get-AvmWanOnlineMonitor @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
    NewSyncGroupIndex  = 0
}

Get-AvmWanOnlineMonitor @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
    NewSyncGroupIndex  = 0
}

Get-AvmWanOnlineMonitor @splatParameters

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

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