< Back

Open-PrtgObject

Sun Jan 19, 2020 5:44 pm

NAME Open-PrtgObject



SYNOPSIS

Opens the URL of a PRTG Object in the PRTG Web Interface.





SYNTAX

Open-PrtgObject -Object <SensorOrDeviceOrGroupOrProbe> [<CommonParameters>]



Open-PrtgObject -Notification <NotificationAction> [<CommonParameters>]



Open-PrtgObject -Schedule <Schedule> [<CommonParameters>]



Open-PrtgObject [-Id] <int[]> [<CommonParameters>]





DESCRIPTION

The Open-PrtgObject cmdlet opens the web page of a PRTG Object in your default browser. Care should be taken with

Open-PrtgObject, as your system may experience performance issues if too many URLs are opened at one time.



Open-PrtgObject is only compatible with objects that contain a URL field; namely Probes, Devices, Groups Sensors,

Notification Actions and Schedules.





PARAMETERS

-Object <SensorOrDeviceOrGroupOrProbe>

The sensor, device, group or probe to open.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Notification <NotificationAction>

The notification action to open.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Schedule <Schedule>

The schedule to open.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Id <int[]>

ID of the object to open.



Required? true

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

PrtgAPI.SensorOrDeviceOrGroupOrProbe

The sensor, device, group or probe to open.



PrtgAPI.NotificationAction

The notification action to open.



PrtgAPI.Schedule

The schedule to open.





OUTPUTS



---------- EXAMPLE 1 ----------



C:\\> Get-Device dc-1 | Get-Sensor ping | Open-PrtgObject



Open all sensors named "ping" under devices named "dc-1" in the default web browser.



---------- EXAMPLE 2 ----------



C:\\> Open-PrtgObject -Id 1001



Opens the object with ID 1001 in the default web browser.



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... tg-objects

Get-Sensor

Get-Device

Get-Group

Get-Probe