about_SensorSettings.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
TOPIC
    about_SensorSettings

SHORT DESCRIPTION
    Describes PRTG Sensor properties that can be used in conjunction with the Set-ObjectProperty and Get-ObjectProperty
    cmdlets.

LONG DESCRIPTION
    PrtgAPI supports the retrieval and modification of dozens of Sensor Setting values in a reliable, typesafe manner.
    The following tables outline the properties that are currently supported/unsupported by PrtgAPI, as well as the
    setting values each property corresponds to within the PRTG Web Interface.

    For properties that are not currently supported, it is possible to interact with these values via the "Raw"
    cmdlet parameter sets. For more information, see the help pages of Get-ObjectProperty and Set-ObjectProperty

    In the tables below, the following keys are used to indicate typesafe support status.

    Yes       : Supported
    Read-Only : Supports Get, and will never support Set
    No        : Not currently supported
    Direct    : Supports Get and Set, however can only be Get via direct requests
    GetDirect : Supports Get via direct requests, will never support Set

    This help topic describes properties that are specific to sensor objects only. For information about
    properties common to Sensors, Devices, Groups and Probes, see about_ObjectSettings

    | Access Rights              | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | InheritAccess              |    Yes    | Whether to inherit Access Rights                                |

    | Debug Options              | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | DebugMode                  |    Yes    | How debug data should be stored                                 |

    | Basic Sensor Settings      | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | Name                       |    Yes    | Name of the sensor                                              |
    | ParentTags                 | Read-Only | Tags inherited from the parent object                           |
    | Tags                       | Yes | No  | Tags applied to this object                                     |
    | Priority                   |    Yes    | Priority of the sensor                                          |

    | HTTP Specific              | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | Timeout                    |    Yes    | Timeout for HTTP requests                                       |
    | Url                        |    Yes    | URL to monitor. If protocol is ommitted, HTTP is used           |
    | HttpRequestMethod          |    Yes    | Request method to use to access URL                             |
    | PostData                   |    Yes    | Data to include in POST request                                 |
    | UseCustomPostContent       |    Yes    | Whether to use custom content type for POST request             |
    | PostContentType            |    Yes    | Custom content type to use for POST request                     |
    | SNI                        |    No     | Server Name Indication of target                                |
    | UseSNIFromUrl              |    Yes    | Whether to use SNI from the Url or parent device                |

    | Ping Settings              | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | Timeout                    |    Yes    | Timeout for Ping requests                                       |
    | PingPacketSize             |    Yes    | Packet size of each request. Must be 1-10,000 bytes             |
    | PingMode                   |    Yes    | Whether to send a single or multiple pings                      |
    | PingCount                  |    Yes    | Number of pings to send when PingMode is MultiPing              |
    | PingDelay                  |    Yes    | Delay between each ping when PingMode is MultiPing              |
    | AutoAcknowledge            |    Yes    | Whether to auto acknowledge when sensor goes down               |

    | Sensor Display             | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | PrimaryChannel             |    No     | The primary channel of this sensor                              |
    | GraphType                  |    Yes    | Whether channels should be independent or stacked in graphs     |
    | StackUnit                  |    No     | The unit of channels to include in stacked graphs               |

    | Sensor Settings (EXE/XML)  | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | ExeFile                    |    Yes    | EXE/Script file to execute                                      |
    | ExeParameters              |    Yes    | Parameters to pass to EXE/Script file                           |
    | SetExeEnvironmentVariables |    Yes    | Whether to set PRTG variables as environment variables          |
    | UseWindowsAuthentication   |    Yes    | Whether run with credentials of Device or of Probe Service      |
    | Mutex                      |    Yes    | Mutex to execute related sensors sequentially                   |
    | NotifyChanged              |    Yes    | Whether change triggers applied to this sensor are active       |
    | ExeValueType               |    No     | How the channel value is numerically represented                |
    | DebugMode                  |    Yes    | How debug data should be stored                                 |

    | WMI Alternate Query        | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | WmiMode                    |    Yes    | Whether to use default or alternate query mode                  |

    | WMI Remote Ping            | Get | Set | Description                                                     |
    | Configuration              |           |                                                                 |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | Target                     |    Yes    | IP Address or DNS name to ping                                  |
    | Timeout                    |    Yes    | Timeout for Ping requests                                       |
    | PingRemotePacketSize       |    Yes    | Packet size of each request. Must be 1-10,000 bytes             |

    | Sensor Factory Specific    | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | ChannelDefinition          |    Yes    | Channels to display in a sensor factory                         |
    | FactoryErrorMode           |    Yes    | How a sensor factory should react when a source sensor is down  |
    | FactoryErrorFormula        |    Yes    | Custom formula for determining when a sensor factory goes down  |
    | FactoryMissingDataMode     |    Yes    | How sensor factory values are calculated when channels are down |

    | WMI Service Monitor        | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | DebugMode                  |    Yes    | How debug data should be stored                                 |
    | StartStopped               |    Yes    | Whether PRTG should start the target service if stopped/crashed |
    | NotifyChanged              |    Yes    | Whether to activate Change Triggers when starting services      |
    | MonitorPerformance         |    Yes    | Whether to monitor additional performance metrics               |
    | ServiceName                | Read-Only | The name of the service being monitored                         |

    | Database Specific          | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | Database                   |    Yes    | The name of the database to monitor                             |
    | UseCustomInstance          |    Yes    | Whether to connect to a custom or default SQL Server Instance   |
    | InstanceName               |    Yes    | The name of the SQL Server instance to connect to               |
    | SqlEncryptionMode          |    Yes    | How PRTG should encrypt its connection to the target SQL Server |

    | Data                       | Get | Set | Description                                                     |
    | -------------------------- | --------- | --------------------------------------------------------------- |
    | SqlServerQuery             |   Direct  | The SQL query file to execute against the database              |
    | UseSqlInputParameter       |    Yes    | Whether the SQL query file requires any input parameters        |
    | SqlInputParameter          |    Yes    | Input parameters to the SQL query file                          |
    | SqlTransactionMode         |    Yes    | The SQL transaction mode PRTG should use for the SQL query file |
    | SqlProcessingMode          | GetDirect | How to handle the data returned from the SQL query file         |

EXAMPLES
    Retrieve all object properties of sensor with ID 1001

    C:\> Get-Sensor -Id 1001 | Get-ObjectProperty

    Modify the scanning interval of sensor with ID 1001

    C:\> Get-Sensor -Id 1001 | Set-ObjectProperty Interval "00:00:30"

    Retrieve raw property "name" of sensor with ID 1001

    C:\> Get-Sensor -Id 1001 | Get-ObjectProperty -RawProperty Name

    Set raw property "name" of sensor with ID 1001

    C:\> Get-Sensor -Id 1001 | Set-ObjectProperty -RawProperty name_ -RawValue test

    Retrieve a direct property from a Microsoft SQL v2 sensor

    C:\> Get-Sensor -Tags sqlserver | Get-Objectproperty SqlServerQuery

SEE ALSO
    PrtgAPI Wiki: https://github.com/lordmilko/PrtgAPI/wiki
    Get-Sensor
    Get-ObjectProperty
    Set-ObjectProperty
    about_ObjectSettings
    about_SensorSettings