about_ObjectSettings.help.txt
|
TOPIC about_ObjectSettings SHORT DESCRIPTION Describes PRTG Device, Group and Probe 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 Object 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 No : Not currently supported Direct : Supports Get and Set, however can only be Get via direct requests N/A : Not Applicable This help topic describes properties that are supported on Sensors, Devices, Groups and Probes. For information about properties that are specific to sensors only, see about_SensorSettings Sensor, Device, Group, Probe Settings | Scanning Interval | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | InheritInterval | Yes | Whether to inherit Scanning Interval | | Interval | Yes | Interval with which sensor refreshes | | IntervalErrorMode | Yes | How sensor transitions from Up -> Warning -> Error | | Schedules, Dependencies | Get | Set | Description | | and Maintenance Window | | | | --------------------------- | --------- | -------------------------------------------------------------------- | | InheritDependency | Yes | No | Whether to inherit Schedules/Dependencies/Maintenance | | Schedule | Yes | No | Schedule during which this object is active | | MaintenanceEnabled | Yes | No | Whether a one time maintenance window has been set | | MaintenanceStart | Yes | No | Maintenance window start, or default start time | | MaintenanceEnd | Yes | No | Maintenance window end, or default end time | | DependencyType | Yes | No | The type of object this object uses as its dependency | | Dependency | Yes | No | The object this object depends on when DependencyType is Object | | DependencyDelay | Yes | No | The delay before resuming when DependencyType is Object (secs) | | Proxy Settings for HTTP | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | InheritProxy | Yes | Whether to inherit Proxy Settings | | ProxyAddress | Yes | Proxy server address | | ProxyPort | Yes | Proxy server port | | ProxyUser | Yes | Proxy server username | | ProxyPassword | No | Yes | Proxy server password | | Channel Unit Configuration | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | InheritChannelUnit | Yes | Whether to inherit Channel Unit Configuration Settings | | BandwidthVolumeUnit | Yes | Unit to use for bandwidth volume sensor channels | | BandwidthSpeedUnit | Yes | Unit to use for bandwidth speed sensor channels | | BandwidthTimeUnit | Yes | Time unit to use for bandwidth speed sensor channels | | MemoryUsageUnit | Yes | Unit to use for memory sensor channels | | DiskSizeUnit | Yes | Unit to use for disk size sensor channels | | FileSizeUnit | Yes | Unit to use for file size sensor channels | Device, Group, Probe Settings | Basic Settings | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | Name | Yes | Yes | Name of the object | | Tags | Yes | No | Yes | Tags applied to the object | | ParentTags | Yes | No | Yes | Yes | N/A | Tags inherit from the parent object | | Active | Yes | Yes | Whether this object is active | | Priority | Yes | Yes | Priority of the object | | Basic Settings | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritLocation | Yes | Yes | Whether to inherit Location Settings | | Location | Yes | Yes | Location of the object | | LocationName | Yes | Yes | Label to use for the location | | Credentials for Windows | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritWindowsCredentials | Yes | Yes | Whether to inherit Windows Credentials | | WindowsDomain | Yes | Yes | Windows Domain or Computer HostName | | WindowsUserName | Yes | Yes | Windows UserName | | WindowsPassword | No | Yes | Yes | Windows Password | | HasWindowsPassword | Yes | No | Yes | Whether a Windows Password is set | | Credentials for Linux | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritLinuxCredentials | Yes | Yes | Whether to inherit Linux Credentials | | LinuxUserName | Yes | Yes | Linux UserName for SSH | | LinuxPassword | No | Yes | Yes | Linux Password for SSH | | HasLinuxPassword | Yes | No | Yes | Whether a Linux Password is set | | LinuxLoginMode | Yes | Yes | Whether to use password or private key | | LinuxPrivateKey | No | Yes | Yes | Private Key for SSH | | HasLinuxPrivateKey | Yes | No | Yes | Whether a Linux Private Key is set | | WbemProtocolMode | Yes | Yes | Whether to use HTTP or HTTPS | | WbemPortMode | Yes | Yes | Whether to use default port or custom | | WbemPort | Yes | Yes | Custom WBEM Port to use | | SSHPort | Yes | Yes | Port to use for SSH | | SSHElevationMode | Yes | Yes | How su/sudo should be used | | SSHElevationSuUser | Yes | No | Yes | User to use with su | | SSHElevationSudoUser | Yes | No | Yes | User to use with sudo | | SSHElevationPassword | No | Yes | Yes | Password to use with su/sudo | | HasSSHElevationPassword | Yes | No | Yes | Whether a SSH Elevation Password is set | | SSHEngine | Yes | Yes | SSH engine to use | | Credentials for VMware | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritVMwareCredentials | Yes | Yes | Whether to inherit VMware Credentials | | VMwareUserName | Yes | Yes | VMware ESXi/vCenter UserName | | VMwarePassword | No | Yes | Yes | VMware ESXi/vCenter Password | | HasVMwarePassword | Yes | No | Yes | Whether a VMware Password is set | | VMwareProtocol | Yes | Yes | Whether to use HTTP or HTTPS | | VMwareSessionMode | Yes | Yes | Whether to reuse sessions across scans | | Credentials for SNMP | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | SNMPVersion | Yes | Yes | Whether to use SNMP v1, v2c or v3 | | SNMPCommunityStringV1 | Yes | Yes | Community string to use for SNMP v1 | | SNMPCommunityStringV2 | Yes | Yes | Community string to use for SNMP v2c | | SNMPv3AuthType | Yes | Yes | Whether to use MD5 or SHA | | SNMPv3UserName | Yes | Yes | UserName to use for SNMP v3 | | SNMPv3Password | No | Yes | Yes | Password to use for SNMP v3 | | HasSNMPv3Password | Yes | No | Yes | Whether a SNMPv3 Password is set | | SNMPv3EncryptionType | Yes | Yes | Whether to use DES or AES | | SNMPv3EncryptionKey | No | Yes | Yes | Encryption key to use for data packets | | HasSNMPv3EncryptionKey | Yes | No | Yes | Whether a SNMPv3 Encryption Key is set | | SNMPv3Context | Yes | Yes | Context name to use for SNMP v3 | | SNMPPort | Yes | Yes | Port to use for SNMP | | SNMPTimeout | Yes | Yes | Timeout for SNMP requests (secs) | | Credentials for Databases | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritDBCredentials | Yes | Yes | Whether to inherit DB Credentials | | DBPortMode | Yes | Yes | Whether to use default port or custom | | DBPort | Yes | Yes | Custom DB Port to use | | DBAuthMode | Yes | Yes | Whether to use Windows or SQL auth | | DBUserName | Yes | Yes | SQL authentication username | | DBPassword | No | Yes | Yes | SQL authentication password | | HasDBPassword | Yes | No | Yes | Whether a DB Password is set | | DBTimeout | Yes | Yes | Timeout for database requests (secs) | | Credentials for Amazon | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritAmazonCredentials | Yes | Yes | Whether to inherit Amazon Credentials | | AmazonAccessKey | Yes | Yes | Amazon Web Services Access Key | | AmazonSecretKey | No | Yes | Yes | Amazon Web Services Secret Key | | HasAmazonSecretKey | Yes | No | Yes | Whether an Amazon Secret Key is set | | Windows Compatibility | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritWindowsCompatibility | Yes | Yes | Whether to inherit Windows Compatibility | | WmiDataSource | Yes | Yes | Whether to use perf counters and/or WMI | | WmiTimeoutMethod | Yes | Yes | Whether to use 1.5x interval or custom | | WmiTimeout | Yes | Yes | Custom timeout for WMI requests (secs) | | SNMP Compatibility | Get | Set | Devices | Groups | Probes | Description | | --------------------------- | --------- | ------------------------- | ---------------------------------------- | | InheritSNMPCompatibility | Yes | Yes | Whether to inherit SNMP Compatibility | | SNMPDelay | Yes | Yes | Delay between each SNMP sensor (0-100ms) | | SNMPRetryMode | Yes | Yes | Whether to retry request on failure | | SNMPOverflowMode | Yes | Yes | Whether to handle/ignore overflow values | | SNMPZeroValueMode | Yes | Yes | Whether to handle/ignore zero values | | SNMPCounterMode | Yes | Yes | Whether to use 64-bit + 32-bit counters | | SNMPRequestMode | Yes | Yes | Whether to use milti get or single get | | SNMPPortNameTemplate | Yes | Yes | Template for default sensor name | | SNMPPortNameUpdateMode | Yes | Yes | Whether to update SNMP ports ensor names | | SNMPPortIdMode | Yes | Yes | How to identify ports on order changes | | SNMPInterfaceStartIndex | Yes | Yes | Start index for SNMP Traffic sensors | | SNMPInterfaceEndIndex | Yes | Yes | End index for SNMP Traffic sensors | Device, Group Settings | Device / Group Type | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | AutoDiscoverySchedule | Yes | How often auto-discovery operations should periodically be performed | Probe Settings | Special | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | ProbeApproved | Yes | No | Whether the probe has been confirmed for use in PRTG yet | Group Settings | Group Type | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | AutoDiscoveryMode | Yes | No | Specifies how detailed auto-discovery operations should be | Device Settings | Basic Device Settings | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | IPVersion | Yes | No | Whether to use IPv4 or IPv6. Set via Hostv4 and Hostv6 respectively | | Hostv4 | Yes | IPv4 Address/Hostname to use. Sets IPVersion to IPv4 when set | | Hostv6 | Yes | IPv6 Address/Hosthame to use. Sets IPVersion to IPv6 when set | | Host | Yes | Sets IPv4 Address/Hostname. Gets Hostv4/Hostv6 based on IPVersion | | Additional Device Info | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | ServiceUrl | Yes | URL used to manage this device | | Device Type | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | AutoDiscoveryMode | Yes | Specifies how detailed auto-discovery operations should be | | Other | Get | Set | Description | | --------------------------- | --------- | -------------------------------------------------------------------- | | InheritTriggers | Direct | Whether to inherit notification triggers. | | Comments | Direct | Any comments aplied to this object | EXAMPLES Set the Windows UserName to "Administrator" on all probes named "contoso" C:\> Get-Probe contoso | Set-ObjectProperty WindowsUserName Administrator Retrieve the Windows UserName on all probes named "contoso"" C:\> Get-Probe contoso | Get-ObjectProperty | select WindowsUserName Retrieve the raw Windows UserName on all probes named "contoso"" C:\> Get-Probe contoso | Get-ObjectProperty -RawProperty windowsloginusername_ Set the raw Windows UserName on all probes named "contoso" C:\> Get-Probe contoso | Set-ObjectProperty -RawProperty windowsloginusername_ -RawValue Administrator SEE ALSO PrtgAPI Wiki: https://github.com/lordmilko/PrtgAPI/wiki Get-ObjectProperty Set-ObjectProperty about_SensorSettings about_ChannelSettings |