Show-PrtgTree

NAME Show-PrtgTree



SYNOPSIS

Pretty prints a TreeNode object.





SYNTAX

Show-PrtgTree -Tree <TreeNode> [-Options {Sensors | Devices | Groups | Probes | Properties | Triggers | Common |

All}] [<CommonParameters>]



Show-PrtgTree -Object <SensorOrDeviceOrGroupOrProbe> [-Options {Sensors | Devices | Groups | Probes | Properties |

Triggers | Common | All}] [<CommonParameters>]



Show-PrtgTree -Id <int> [-Options {Sensors | Devices | Groups | Probes | Properties | Triggers | Common | All}]

[<CommonParameters>]





DESCRIPTION

The Show-PrtgTree cmdlet pretty prints a PRTG Tree Object, such as a PrtgNode or CompareNode. When printing

PrtgNode objects, key nodes are colored according to their state or purpose (e.g. sensors that are Up are green,

Down red, etc). When printing CompareNode objects, nodes are colored according to the result of their comparisons.

If an object is red, it was removed, green added, yellow changed.





PARAMETERS

-Tree <TreeNode>

The tree to print.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Object <SensorOrDeviceOrGroupOrProbe>

The object whose tree should be printed.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Options <TreeParseOption[]>

Specifies the types of descendants to include when constructing a PrtgNode tree. If no value is specified,

Common will be used.



Possible values: Sensors, Devices, Groups, Probes, Properties, Triggers, Common, All



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Id <int>

The ID of the object whose tree should be printed.



Required? true

Position? named

Default value 0

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.Tree.TreeNode

The tree to print.



PrtgAPI.SensorOrDeviceOrGroupOrProbe

The object whose tree should be printed.





OUTPUTS



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



C:\\> Get-PrtgTree -Id 1 | Show-PrtgTree



Prints the PRTG Tree for the object with ID 1001.



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... lization-1

Get-PrtgTree