PrtgAPI.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PrtgAPI</name> </assembly> <members> <member name="T:PrtgAPI.Attributes.CategoryAttribute"> <summary> Specifies the category a value belongs to. </summary> </member> <member name="P:PrtgAPI.Attributes.CategoryAttribute.Name"> <summary> Gets the name of the category this attribute's associated field belongs to. </summary> </member> <member name="M:PrtgAPI.Attributes.CategoryAttribute.#ctor(PrtgAPI.ObjectPropertyCategory)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Attributes.CategoryAttribute"/> class. </summary> <param name="category">The name of the category this attribute's associated field belongs to.</param> </member> <member name="T:PrtgAPI.Attributes.FilterHandlerAttribute"> <summary> Specifies a custom <see cref="T:PrtgAPI.Request.Serialization.FilterHandlers.FilterHandler"/> used to validate the components specified in a <see cref="T:PrtgAPI.SearchFilter"/>. </summary> </member> <member name="T:PrtgAPI.Attributes.LengthLimitAttribute"> <summary> Specifies that there is a limit to the length or number of items that can be applied to a field. </summary> </member> <member name="T:PrtgAPI.Attributes.LiteralValueAttribute"> <summary> Specifies that a value should be used as-is, without further processing. </summary> </member> <member name="T:PrtgAPI.Attributes.NewSensorAttribute"> <summary> Specifies configuration options used when parsing <see cref="T:PrtgAPI.Parameters.NewSensorParameters"/>. </summary> </member> <member name="P:PrtgAPI.Attributes.NewSensorAttribute.DynamicName"> <summary> Indicates the name of the parameters object should be ignored as it will be dynamically generated. </summary> </member> <member name="P:PrtgAPI.Attributes.NewSensorAttribute.ConfigOptional"> <summary> Indicates that all properties of a parameters object are optional, and that a sensor can successfully be created with each parameter's default values. </summary> </member> <member name="T:PrtgAPI.Attributes.NumericEnumAttribute"> <summary> Specifies that an enum represents a set of numeric values. </summary> </member> <member name="T:PrtgAPI.Attributes.TypeAttribute"> <summary> Specifies the type of object that should be used in conjunction with a corresponding field.<para/> When used in conjunction with a <see cref="T:PrtgAPI.Attributes.TypeLookupAttribute"/>, this attribute overrides the type indicated by the field found via the <see cref="T:PrtgAPI.Attributes.TypeLookupAttribute"/>, indicating the <see cref="T:PrtgAPI.Attributes.TypeLookupAttribute"/> is only being used for identifying other pieces of information, such as the value of a <see cref="T:System.Xml.Serialization.XmlElementAttribute"/>. </summary> </member> <member name="T:PrtgAPI.Attributes.VersionAttribute"> <summary> Specifies the target application element exerts different behavior from a specific version of PRTG. </summary> </member> <member name="P:PrtgAPI.Attributes.VersionAttribute.Version"> <summary> The PRTG version this attribute pertains to. </summary> </member> <member name="M:PrtgAPI.Attributes.VersionAttribute.#ctor(PrtgAPI.RequestVersion)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Attributes.VersionAttribute"/> class. </summary> <param name="version">The PRTG version this attribute pertains to.</param> </member> <member name="T:PrtgAPI.Attributes.RequireValueAttribute"> <summary> Indicates whether the associated property requires a value. </summary> </member> <member name="P:PrtgAPI.Attributes.RequireValueAttribute.ValueRequired"> <summary> Gets whether the associated property requires a value. </summary> </member> <member name="M:PrtgAPI.Attributes.RequireValueAttribute.#ctor(System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Attributes.RequireValueAttribute"/> class. </summary> <param name="valueRequired">Whether the associated property requires a value.</param> </member> <member name="P:PrtgAPI.Attributes.DependentPropertyAttribute.RequiredValue"> <summary> The value that should be assigned to the dependent property when this property is assigned a value.<para/> For example, if a property does not apply unless its section inheritance is disabled, the required value is inheritance = false. </summary> </member> <member name="P:PrtgAPI.Attributes.DependentPropertyAttribute.ReverseDependency"> <summary> Indicates whether the property specified by <see cref="P:PrtgAPI.Attributes.DependentPropertyAttribute.Property"/> has a dependency on this field when its value is <see cref="P:PrtgAPI.Attributes.DependentPropertyAttribute.RequiredValue"/><para/> For example, if a value can have automatic and manual modes, the manual value depends on the mode being manual, however when the mode is manual the manual value must also be specified. </summary> </member> <member name="T:PrtgAPI.Attributes.PropertyParameterAttribute"> <summary> Specifies a property for use as the name or value of a URL parameter/query string. </summary> </member> <member name="T:PrtgAPI.Attributes.UndocumentedAttribute"> <summary> Indicates whether a member is exposed by the PRTG API. If a member is not publically exposed, PRTG may filter or process the associated member differently from fully documented members.<para/> If this member is a URL function, the <see cref="T:System.ComponentModel.DescriptionAttribute"/> of this function specifies the absolute path to the URI resource. </summary> </member> <member name="M:PrtgAPI.Dynamic.DynamicProxy`1.TryGetMember(`0,System.Dynamic.GetMemberBinder,System.Object@)"> <summary> Retrieves the value of a property from a dynamic object. </summary> <param name="instance">The dynamic object to retrieve the property from.</param> <param name="binder">The binder that specifies the property to access.</param> <param name="value">Returns the value of the property set by this method.</param> <returns>True if the member was successfully retrieved. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.Dynamic.DynamicProxy`1.TrySetMember(`0,System.Dynamic.SetMemberBinder,System.Object)"> <summary> Sets the value of a property on a dynamic object. </summary> <param name="instance">The dynamic object to set a property on.</param> <param name="binder">The binder that specifies the property to modify.</param> <param name="value">The value to set the property to.</param> <returns>True if the member was successfully set. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.Dynamic.DynamicProxy`1.GetDynamicMemberNames(`0)"> <summary> Retrieves a list of all dynamic properties defined on a dynamic object. </summary> <param name="instance">The dynamic object to list the dynamic properties of.</param> <returns>A list of all dynamic properties defined on the specified object.</returns> </member> <member name="T:PrtgAPI.ClusterNodeType"> <summary> Specifies roles PRTG Servers can take in a PRTG Cluster. </summary> </member> <member name="F:PrtgAPI.ClusterNodeType.Master"> <summary> Node is the Master Node. Changes made on the Master Node will be replicated to all Failover Nodes. </summary> </member> <member name="F:PrtgAPI.ClusterNodeType.Failover"> <summary> Node is a Failover Node. Changes to objects cannot be made. </summary> </member> <member name="T:PrtgAPI.LicenseType"> <summary> Specifies license types use by a PRTG Server. </summary> </member> <member name="F:PrtgAPI.LicenseType.Freeware"> <summary> PRTG is running a freeware license. </summary> </member> <member name="F:PrtgAPI.LicenseType.Commercial"> <summary> PRTG is using a paid commercial license. </summary> </member> <member name="T:PrtgAPI.LogStatus"> <summary> Specifies logging event categories. </summary> </member> <member name="F:PrtgAPI.LogStatus.SystemStart"> <summary> PRTG Core Service started. </summary> </member> <member name="F:PrtgAPI.LogStatus.SystemStop"> <summary> PRTG Core Service shut down. </summary> </member> <member name="F:PrtgAPI.LogStatus.ProbeGidDenied"> <summary> A remote probe whose GID has been blocked attempted to connect to the PRTG Core. </summary> </member> <member name="F:PrtgAPI.LogStatus.WebServer"> <summary> Web server status message, potentially indicating issue starting PRTG Core Service. </summary> </member> <member name="F:PrtgAPI.LogStatus.UpdateAvailable"> <summary> PRTG detected an update is available for install after having performed an <see cref="F:PrtgAPI.LogStatus.UpdateCheck"/>. </summary> </member> <member name="F:PrtgAPI.LogStatus.GraphCache"> <summary> Graph cache is being recalculated. </summary> </member> <member name="F:PrtgAPI.LogStatus.Data"> <summary> An internal exception occurred within PRTG while attempting to perform an operation. </summary> </member> <member name="F:PrtgAPI.LogStatus.SystemInfo"> <summary> Informational message about a core system operation. </summary> </member> <member name="F:PrtgAPI.LogStatus.ProbeDenied"> <summary> A new probe that attempted to connect to PRTG was denied. </summary> </member> <member name="F:PrtgAPI.LogStatus.NotificationItem"> <summary> Notification trigger was activated on object. </summary> </member> <member name="F:PrtgAPI.LogStatus.ProbeKeyDenied"> <summary> A remote probe with an incorrect version or invalid access key attempted to connect to the PRTG Core. </summary> </member> <member name="F:PrtgAPI.LogStatus.NotifyChanged"> <summary> Indicates a "Notify Changed" event occurred on an EXE/XML sensor, or that a WMI sensor encountered an error. </summary> </member> <member name="F:PrtgAPI.LogStatus.Info"> <summary> Miscellaneous informational item, including certain ticket creation events. </summary> </member> <member name="F:PrtgAPI.LogStatus.WMIFallback"> <summary> A sensor has fallen back to using WMI as Performance Counters are malfunctioning. </summary> </member> <member name="F:PrtgAPI.LogStatus.UsePerfCounters"> <summary> A sensor that was previously in status <see cref="F:PrtgAPI.LogStatus.WMIFallback"/> has resumed working normally. </summary> </member> <member name="F:PrtgAPI.LogStatus.FtpMode"> <summary> An FTP connection could not be established using the specified mode. </summary> </member> <member name="F:PrtgAPI.LogStatus.Created"> <summary> Object was created. </summary> </member> <member name="F:PrtgAPI.LogStatus.Deleted"> <summary> Object with the same ID was previously deleted.<para/> Under normal circumstances object IDs cannot be reused, however this status can occur when the PRTG Configuration is reverted to before an object was initially created. </summary> </member> <member name="F:PrtgAPI.LogStatus.Moved"> <summary> An object was moved to another parent. States where the object was moved from and to. Occurs in conjunction with <see cref="F:PrtgAPI.LogStatus.ChildObjectMoved"/>. </summary> </member> <member name="F:PrtgAPI.LogStatus.Edited"> <summary> Object settings were modified. </summary> </member> <member name="F:PrtgAPI.LogStatus.NewChildObject"> <summary> A new child object (such as a sensor) was created. </summary> </member> <member name="F:PrtgAPI.LogStatus.ChildObjectDeleted"> <summary> A child object (such as a sensor) was deleted. </summary> </member> <member name="F:PrtgAPI.LogStatus.ChildObjectMoved"> <summary> An child of this object was moved to another parent. Event states what was moved. Occurs in conjunction with <see cref="F:PrtgAPI.LogStatus.Moved"/>. </summary> </member> <member name="F:PrtgAPI.LogStatus.MovedObjectInserted"> <summary> An object that was <see cref="F:PrtgAPI.LogStatus.Moved"/> was inserted. </summary> </member> <member name="F:PrtgAPI.LogStatus.SubnodeCreated"> <summary> A new subnode (such as a notification trigger) was created. </summary> </member> <member name="F:PrtgAPI.LogStatus.SubnodeDeleted"> <summary> A subnode (such as a notification trigger) was deleted </summary> </member> <member name="F:PrtgAPI.LogStatus.SubnodeEdited"> <summary> A subnode (such as a channel or notification trigger) was edited. </summary> </member> <member name="F:PrtgAPI.LogStatus.CreatedFromClone"> <summary> Object was created from cloning another object. </summary> </member> <member name="F:PrtgAPI.LogStatus.Activation"> <summary> A license could not be found. </summary> </member> <member name="F:PrtgAPI.LogStatus.Unknown"> <summary> Sensor is unable to collect data. </summary> </member> <member name="F:PrtgAPI.LogStatus.Resuming"> <summary> Monitoring of a previously paused object is in the process of being resumed. </summary> </member> <member name="F:PrtgAPI.LogStatus.Pausing"> <summary> Object is in the process of being paused. Shows the pause message that was specified for the object (if applicable) </summary> </member> <member name="F:PrtgAPI.LogStatus.PausedByUser"> <summary> Object has been paused indefinitely by a user. </summary> </member> <member name="F:PrtgAPI.LogStatus.PausedByDependency"> <summary> Object has been paused due to a dependency on another sensor (e.g. the device is not pingable) </summary> </member> <member name="F:PrtgAPI.LogStatus.PausedBySchedule"> <summary> Object has been paused automatically by a schedule used to control monitoring windows. </summary> </member> <member name="F:PrtgAPI.LogStatus.Up"> <summary> Object is in an up and working state. </summary> </member> <member name="F:PrtgAPI.LogStatus.Down"> <summary> Object is down and has failed. </summary> </member> <member name="F:PrtgAPI.LogStatus.Warning"> <summary> Sensor is behaving abnormally, but has not yet failed. </summary> </member> <member name="F:PrtgAPI.LogStatus.Unusual"> <summary> Sensor data is outside of normal ranges, potentially indicating an issue. </summary> </member> <member name="F:PrtgAPI.LogStatus.Connected"> <summary> A remote probe connected to the PRTG Core. </summary> </member> <member name="F:PrtgAPI.LogStatus.Disconnected"> <summary> A remote probe disconnected from the PRTG Core. </summary> </member> <member name="F:PrtgAPI.LogStatus.ProbeInfo"> <summary> Probe status message (e.g. restart occurred) </summary> </member> <member name="F:PrtgAPI.LogStatus.PausedByLicense"> <summary> Sensor has been paused due to sensor limits imposed by a chance in license. </summary> </member> <member name="F:PrtgAPI.LogStatus.Active"> <summary> Previously paused object has completed <see cref="F:PrtgAPI.LogStatus.Resuming"/> and is now active. </summary> </member> <member name="F:PrtgAPI.LogStatus.DownAcknowledged"> <summary> Sensor is down but has been acknowledged by a user. </summary> </member> <member name="F:PrtgAPI.LogStatus.DownPartial"> <summary> Sensor is down for at least one node in a PRTG Cluster. </summary> </member> <member name="F:PrtgAPI.LogStatus.ProbeApproved"> <summary> A new probe was approved and added to PRTG. </summary> </member> <member name="F:PrtgAPI.LogStatus.UpdateCheck"> <summary> A software update check was performed. </summary> </member> <member name="F:PrtgAPI.LogStatus.SystemError"> <summary> Could not complete operation due to critical error (such as performance issue). </summary> </member> <member name="F:PrtgAPI.LogStatus.ReportDone"> <summary> A scheduled report has completed. </summary> </member> <member name="F:PrtgAPI.LogStatus.NewProbe"> <summary> A new probe connected to PRTG requiring user approval. </summary> </member> <member name="F:PrtgAPI.LogStatus.SmtpConfiguration"> <summary> Indicates an error with PRTG's SMTP Configuration. </summary> </member> <member name="F:PrtgAPI.LogStatus.NewClusterNode"> <summary> Indicates that a new cluster node has attempted to connect to PRTG and is pending approval. </summary> </member> <member name="F:PrtgAPI.LogStatus.UpdateApplied"> <summary> Indicates that a PRTG update was successfully applied. </summary> </member> <member name="F:PrtgAPI.LogStatus.OverloadProtection"> <summary> Authentication attempts have been throttled due to excessive failed logins. </summary> </member> <member name="F:PrtgAPI.LogStatus.Reminder"> <summary> A reminder from PRTG or Paessler about an upcoming event or change. </summary> </member> <member name="F:PrtgAPI.LogStatus.GroupDiscoveryStarted"> <summary> A group auto-discovery operation started. </summary> </member> <member name="F:PrtgAPI.LogStatus.GroupDiscoveryFinished"> <summary> A group auto-discovery operation completed. </summary> </member> <member name="F:PrtgAPI.LogStatus.DiscoveryDeviceFound"> <summary> A new device was discovered by auto-discovery </summary> </member> <member name="F:PrtgAPI.LogStatus.DiscoveryTemplateApplied"> <summary> An auto-discovery template was applied to a device. </summary> </member> <member name="F:PrtgAPI.LogStatus.DiscoveryFailed"> <summary> An auto-discovery operation failed. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterStart"> <summary> The clustering engine has started. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterStop"> <summary> The clustering engine has stopped. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterInit"> <summary> Indicates clustering has initialized on a single cluster node. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterConnection"> <summary> Indicates that two initialized cluster nodes have successfully connected to one another </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterNodeConnected"> <summary> Indicates that a cluster successfully connected to a new cluster node. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterNodeDisconnected"> <summary> Indicates that a cluster node disconnected from a cluster. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterMasterChanged"> <summary> The master node of a PRTG Cluster changed. </summary> </member> <member name="F:PrtgAPI.LogStatus.ClusterInfo"> <summary> Informational event regarding the status of an active cluster connection, including error messages. </summary> </member> <member name="F:PrtgAPI.LogStatus.MultipleClusterMasters"> <summary> Multiple PRTG Cluster master nodes were detected. </summary> </member> <member name="T:PrtgAPI.EmailContentType"> <summary> Specifies the content type an email should be formatted with. </summary> </member> <member name="F:PrtgAPI.EmailContentType.HTML"> <summary> Format automatically with HTML. </summary> </member> <member name="F:PrtgAPI.EmailContentType.Text"> <summary> Format automatically with text. </summary> </member> <member name="F:PrtgAPI.EmailContentType.Custom"> <summary> Provide a custom format using variable placeholders. </summary> </member> <member name="T:PrtgAPI.EmailPriority"> <summary> Specifies the priority with which a notification email is identified as. </summary> </member> <member name="F:PrtgAPI.EmailPriority.Highest"> <summary> Email is identified as being of high importance. </summary> </member> <member name="F:PrtgAPI.EmailPriority.High"> <summary> Email is identified as being of high importance. </summary> </member> <member name="F:PrtgAPI.EmailPriority.Normal"> <summary> Email is sent with normal importance. </summary> </member> <member name="F:PrtgAPI.EmailPriority.Low"> <summary> Email is identified as being of low importance. </summary> </member> <member name="F:PrtgAPI.EmailPriority.Lowest"> <summary> Email is identified as being of low importance. </summary> </member> <member name="T:PrtgAPI.EventLog"> <summary> Specifies the Event Log events shoud be placed under. </summary> </member> <member name="F:PrtgAPI.EventLog.Application"> <summary> Store events under the Application event log. </summary> </member> <member name="F:PrtgAPI.EventLog.PrtgNetworkMonitor"> <summary> Store events under the PRTG Network Monitor event log. </summary> </member> <member name="T:PrtgAPI.EventLogType"> <summary> Specifies types of event logs that can be generated by PRTG. </summary> </member> <member name="F:PrtgAPI.EventLogType.Error"> <summary> Error, indicating something has gone wrong. </summary> </member> <member name="F:PrtgAPI.EventLogType.Warning"> <summary> Warning, indicating a potential issue. </summary> </member> <member name="F:PrtgAPI.EventLogType.Information"> <summary> Informational log for diagnostic purposes. </summary> </member> <member name="T:PrtgAPI.SummaryMode"> <summary> Specifies how PRTG should summarize multiple notifications within a certain timespan before sending an alert. </summary> </member> <member name="F:PrtgAPI.SummaryMode.None"> <summary> Always notify immediately without summarizing. </summary> </member> <member name="F:PrtgAPI.SummaryMode.AfterFirstDown"> <summary> Send the first <see cref="F:PrtgAPI.Status.Down"/> alert immediately, summarizing all subsequent failures. </summary> </member> <member name="F:PrtgAPI.SummaryMode.AfterFirstDownUp"> <summary> Send the fisrt <see cref="F:PrtgAPI.Status.Down"/> and <see cref="F:PrtgAPI.Status.Up"/> alert immediately, summarizing all subsequent alerts. </summary> </member> <member name="F:PrtgAPI.SummaryMode.AllButDown"> <summary> Summarize all alerts but alerts for <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="F:PrtgAPI.SummaryMode.AllButDownAndUp"> <summary> Summarize all alerts but alerts for <see cref="F:PrtgAPI.Status.Down"/> and <see cref="F:PrtgAPI.Status.Up"/>. </summary> </member> <member name="F:PrtgAPI.SummaryMode.All"> <summary> Summarize all notifications. </summary> </member> <member name="T:PrtgAPI.SyslogEncoding"> <summary> Specifies the character encoding to use for syslog messages. </summary> </member> <member name="F:PrtgAPI.SyslogEncoding.ANSI"> <summary> ANSI encoding. </summary> </member> <member name="F:PrtgAPI.SyslogEncoding.UTF8"> <summary> Unicode encoding with UTF-8. </summary> </member> <member name="T:PrtgAPI.SyslogFacility"> <summary> Specifies Syslog Facility levels used to describe the type of program that is generating the message. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.UserLevel"> <summary> User-level messages. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local0"> <summary> Custom facility 0. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local1"> <summary> Custom facility 1. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local2"> <summary> Custom facility 2. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local3"> <summary> Custom facility 3. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local4"> <summary> Custom facility 4. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local5"> <summary> Custom facility 5. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local6"> <summary> Custom facility 6. </summary> </member> <member name="F:PrtgAPI.SyslogFacility.Local7"> <summary> Custom facility 7. </summary> </member> <member name="T:PrtgAPI.AutoDiscoveryMode"> <summary> Specifies how thoroughly PRTG should scan for compatible sensor types when performing an auto-discovery. </summary> </member> <member name="F:PrtgAPI.AutoDiscoveryMode.Manual"> <summary> Do not perform auto-discovery; sensors will be added manually. </summary> </member> <member name="F:PrtgAPI.AutoDiscoveryMode.Automatic"> <summary> Perform a standard auto-discovery scan, creating the most common sensor types. </summary> </member> <member name="F:PrtgAPI.AutoDiscoveryMode.AutomaticDetailed"> <summary> Perform an exhaustive auto-discovery scan, identifying as many sensor types as possible. </summary> </member> <member name="F:PrtgAPI.AutoDiscoveryMode.AutomaticTemplate"> <summary> Perform an auto-discovery using a specified device template. </summary> </member> <member name="T:PrtgAPI.AutoDiscoverySchedule"> <summary> Specifies how often auto-discovery operations should be perform to create new sensors. </summary> </member> <member name="F:PrtgAPI.AutoDiscoverySchedule.Once"> <summary> Perform auto-discovery once, only when activated. </summary> </member> <member name="F:PrtgAPI.AutoDiscoverySchedule.Hourly"> <summary> Perform auto-discovery once an hour. </summary> </member> <member name="F:PrtgAPI.AutoDiscoverySchedule.Daily"> <summary> Perform auto-discovery once a day. </summary> </member> <member name="F:PrtgAPI.AutoDiscoverySchedule.Weekly"> <summary> Perform auto-discovery once a week. </summary> </member> <member name="T:PrtgAPI.DBAuthMode"> <summary> Specifies the type of authentication PRTG uses to connect to a database server. </summary> </member> <member name="F:PrtgAPI.DBAuthMode.Windows"> <summary> Use the Windows Credentials of the sensor's PRTG Device. </summary> </member> <member name="F:PrtgAPI.DBAuthMode.SQL"> <summary> Use credentials specific to the SQL Server. </summary> </member> <member name="T:PrtgAPI.DiscoveryRescanMode"> <summary> Specifies whether known devices should be re-auto-discovered when performing a group auto-discovery. </summary> </member> <member name="F:PrtgAPI.DiscoveryRescanMode.SkipKnownIPs"> <summary> Do not rescan existing devices. </summary> </member> <member name="T:PrtgAPI.EncryptionType"> <summary> Specifies types of encryption that can be used. </summary> </member> <member name="F:PrtgAPI.EncryptionType.DES"> <summary> Use Data Encryption Standard (DES) (less secure). </summary> </member> <member name="F:PrtgAPI.EncryptionType.AES"> <summary> Use Advanced Encryption Standard (more secure). </summary> </member> <member name="T:PrtgAPI.FactoryErrorMode"> <summary> Specifies how sensor factories should respond when a source sensor enters an error state. </summary> </member> <member name="F:PrtgAPI.FactoryErrorMode.ErrorOnError"> <summary> Show <see cref="F:PrtgAPI.Status.Down"/> when one or more source sensors are in error. </summary> </member> <member name="F:PrtgAPI.FactoryErrorMode.WarnOnError"> <summary> Show <see cref="F:PrtgAPI.Status.Warning"/> when one or more sensors are in error. </summary> </member> <member name="F:PrtgAPI.FactoryErrorMode.CustomFormula"> <summary> Determine whether to enter <see cref="F:PrtgAPI.Status.Down"/> according to a custom formula. </summary> </member> <member name="T:PrtgAPI.FactoryMissingDataMode"> <summary> Specifies the calculation mode to use when a sensor used by a channel is paused or does not exist. </summary> </member> <member name="F:PrtgAPI.FactoryMissingDataMode.DontCalculate"> <summary> Do not calculate values for channels that use the affected sensor. </summary> </member> <member name="F:PrtgAPI.FactoryMissingDataMode.CalculateWithZero"> <summary> Calculate values for channels that used the affected sensor using a value of "0" for any missing sensors. </summary> </member> <member name="T:PrtgAPI.GraphType"> <summary> Specifies how graphs should be displayed. </summary> </member> <member name="F:PrtgAPI.GraphType.Independent"> <summary> Each series in the graph is shown independently of one another. </summary> </member> <member name="F:PrtgAPI.GraphType.Stacked"> <summary> Each series in the graph is stacked on top of each other. </summary> </member> <member name="T:PrtgAPI.HashType"> <summary> Specifies hash types that can be used for performing authentication. </summary> </member> <member name="F:PrtgAPI.HashType.MD5"> <summary> Message-Digest Algorithm 5. MD5 is the standard authentication type. </summary> </member> <member name="F:PrtgAPI.HashType.SHA"> <summary> Secure hash Algorithm (SHA). </summary> </member> <member name="T:PrtgAPI.HttpMode"> <summary> Specifies HTTP protocols. </summary> </member> <member name="F:PrtgAPI.HttpMode.HTTPS"> <summary> Secure HTTP. </summary> </member> <member name="F:PrtgAPI.HttpMode.HTTP"> <summary> Regular HTTP. </summary> </member> <member name="T:PrtgAPI.HttpRequestMethod"> <summary> Specifies request methods to use for HTTP requests. </summary> </member> <member name="F:PrtgAPI.HttpRequestMethod.GET"> <summary> Execute the request using GET. </summary> </member> <member name="F:PrtgAPI.HttpRequestMethod.POST"> <summary> Execute the request using POST. </summary> </member> <member name="F:PrtgAPI.HttpRequestMethod.HEAD"> <summary> Execute the request using HEAD. HEAD is similar to GET, however only includes the response headers, omitting the response body. </summary> </member> <member name="T:PrtgAPI.IPVersion"> <summary> Specifies the Internet Protocol version to use. </summary> </member> <member name="F:PrtgAPI.IPVersion.IPv4"> <summary> Internet Protocol version 4. </summary> </member> <member name="F:PrtgAPI.IPVersion.IPv6"> <summary> Internet Protocol version 6. </summary> </member> <member name="T:PrtgAPI.LinuxLoginMode"> <summary> Specifies the authentication mode to use when connecting to Linux Servers. </summary> </member> <member name="F:PrtgAPI.LinuxLoginMode.Password"> <summary> Authenticate with a Password. </summary> </member> <member name="F:PrtgAPI.LinuxLoginMode.PrivateKey"> <summary> Authenticate with a Private Key. </summary> </member> <member name="T:PrtgAPI.PingMode"> <summary> Specifies the number of packets to send in a single Ping Request. </summary> </member> <member name="F:PrtgAPI.PingMode.SinglePing"> <summary> Perform a single Ping. </summary> </member> <member name="F:PrtgAPI.PingMode.MultiPing"> <summary> Perform multiple Pings. </summary> </member> <member name="T:PrtgAPI.ProbeRestartOption"> <summary> Specifies whether a PRTG Probe should periodically restart certain components to improve system performance/reliability. </summary> </member> <member name="F:PrtgAPI.ProbeRestartOption.DoNothing"> <summary> Do not perform scheduled service reboots/system restarts. </summary> </member> <member name="F:PrtgAPI.ProbeRestartOption.RestartServices"> <summary> Periodically restart all PRTG Services. </summary> </member> <member name="F:PrtgAPI.ProbeRestartOption.RebootSystem"> <summary> Periodically restart the entire PRTG Probe Server. </summary> </member> <member name="T:PrtgAPI.RetryMode"> <summary> Specifies whether or not to retry an action. </summary> </member> <member name="F:PrtgAPI.RetryMode.Retry"> <summary> Retry the action. </summary> </member> <member name="F:PrtgAPI.RetryMode.DoNotRetry"> <summary> Do not retry the action. </summary> </member> <member name="T:PrtgAPI.SNMPCounterMode"> <summary> Specifies whether to allow the use of 64-bit SNMP counters or always force 32-bit. </summary> </member> <member name="F:PrtgAPI.SNMPCounterMode.Use64BitIfAvailable"> <summary> Use 64-bit counters if available; otherwise use 32-bit. </summary> </member> <member name="F:PrtgAPI.SNMPCounterMode.Use32BitOnly"> <summary> Always use 32-bit counters. For some devices, this can assist with reliability. </summary> </member> <member name="T:PrtgAPI.SNMPOverflowMode"> <summary> Specifies how PRTG should process overflow values. </summary> </member> <member name="F:PrtgAPI.SNMPOverflowMode.Ignore"> <summary> Ignore overflow values. </summary> </member> <member name="F:PrtgAPI.SNMPOverflowMode.Handle"> <summary> Treat overflow values as valid results. </summary> </member> <member name="T:PrtgAPI.SNMPPortIdentification"> <summary> Specifies how an SNMP interface is identified if its port is changed after a reboot. </summary> </member> <member name="F:PrtgAPI.SNMPPortIdentification.Automatic"> <summary> Uses IfAlias first, followed by IfDescr if IfAlias is unsuccessful. </summary> </member> <member name="F:PrtgAPI.SNMPPortIdentification.UseIfAlias"> <summary> Use the interface's alias. </summary> </member> <member name="F:PrtgAPI.SNMPPortIdentification.UseIfDescr"> <summary> Use the interface's description. </summary> </member> <member name="F:PrtgAPI.SNMPPortIdentification.UseIfName"> <summary> Use the interface's name. </summary> </member> <member name="F:PrtgAPI.SNMPPortIdentification.NoPortUpdate"> <summary> Do not update the port's interface. </summary> </member> <member name="T:PrtgAPI.SNMPPortNameUpdateMode"> <summary> Specifies whether PRTG should automatically update sensor names when names change in the target device. </summary> </member> <member name="F:PrtgAPI.SNMPPortNameUpdateMode.Manual"> <summary> Do not automatically update sensor names. </summary> </member> <member name="F:PrtgAPI.SNMPPortNameUpdateMode.Automatic"> <summary> Automatically update sensor names. </summary> </member> <member name="T:PrtgAPI.SNMPRequestMode"> <summary> Specifies how many SNMP requests are bundled in each SNMP communication with the device. </summary> </member> <member name="F:PrtgAPI.SNMPRequestMode.MultiGet"> <summary> Allow for multiple SNMP request in each request. </summary> </member> <member name="F:PrtgAPI.SNMPRequestMode.SingleGet"> <summary> Include one SNMP request in each request. This can be required in older devices. </summary> </member> <member name="T:PrtgAPI.SNMPVersion"> <summary> Specifies the version to use for SNMP. </summary> </member> <member name="F:PrtgAPI.SNMPVersion.v1"> <summary> Use SNMPv1. </summary> </member> <member name="F:PrtgAPI.SNMPVersion.v2c"> <summary> Use SNMPv2c. </summary> </member> <member name="F:PrtgAPI.SNMPVersion.v3"> <summary> Use SNMPv3. </summary> </member> <member name="T:PrtgAPI.SNMPZeroValueMode"> <summary> Specifies whether spurious "0" values should be ignored for delta (difference) SNMP sensors. </summary> </member> <member name="F:PrtgAPI.SNMPZeroValueMode.Ignore"> <summary> Ignore 0 values. </summary> </member> <member name="F:PrtgAPI.SNMPZeroValueMode.Handle"> <summary> Handle 0 values as valid results. </summary> </member> <member name="T:PrtgAPI.SqlEncryptionMode"> <summary> Specifies whethet encryption is used when communicating with a SQL Server. </summary> </member> <member name="F:PrtgAPI.SqlEncryptionMode.Default"> <summary> The level of encryption used is determined by the target SQL Server. </summary> </member> <member name="F:PrtgAPI.SqlEncryptionMode.Encrypt"> <summary> Enforce encryption but do not validate the server certificate. </summary> </member> <member name="F:PrtgAPI.SqlEncryptionMode.EncryptAndValidate"> <summary> Enforce encryption and validate the server certificate. </summary> </member> <member name="T:PrtgAPI.SqlProcessingMode"> <summary> Specifies how PRTG should process the data returned from the SQL query.<para/> Note: PrtgAPI does not natively support data processing mode "Process data table" and its associated settings. </summary> </member> <member name="F:PrtgAPI.SqlProcessingMode.Execute"> <summary> Report how long execution of the query took and how many rows were affected. </summary> </member> <member name="F:PrtgAPI.SqlProcessingMode.CountRows"> <summary> Report how many rows were returned from the query. </summary> </member> <member name="T:PrtgAPI.SqlTransactionMode"> <summary> Specifies whether PRTG should use transactional processing when executing a database query. </summary> </member> <member name="F:PrtgAPI.SqlTransactionMode.None"> <summary> Don't use database transactions. </summary> </member> <member name="F:PrtgAPI.SqlTransactionMode.Rollback"> <summary> Use transactions always rollback all changes to the database. </summary> </member> <member name="F:PrtgAPI.SqlTransactionMode.CommitOnSuccess"> <summary> Use transactions and commit any changes if all steps execute successfully. </summary> </member> <member name="T:PrtgAPI.SSHElevationMode"> <summary> Specifies how rights elevation should be performed via SSH. </summary> </member> <member name="F:PrtgAPI.SSHElevationMode.RunAsUser"> <summary> Run commands as the specified user. </summary> </member> <member name="F:PrtgAPI.SSHElevationMode.RunAsAnotherWithPasswordViaSudo"> <summary> Run commands as another user requiring a password using 'sudo'. </summary> </member> <member name="F:PrtgAPI.SSHElevationMode.RunAsAnotherWithoutPasswordViaSudo"> <summary> Run commands as another user not requiring a password using sudo. </summary> </member> <member name="F:PrtgAPI.SSHElevationMode.RunAsAnotherViaSu"> <summary> Run commands as another user using 'su'. </summary> </member> <member name="T:PrtgAPI.SSHEngine"> <summary> Specifies the SSH engine to use. </summary> </member> <member name="F:PrtgAPI.SSHEngine.Default"> <summary> The default SSH engine. </summary> </member> <member name="F:PrtgAPI.SSHEngine.CompatibilityMode"> <summary> The compatibility mode engine (deprecated). </summary> </member> <member name="T:PrtgAPI.VMwareSessionMode"> <summary> Specifies whether to reuse sessions for multiple sensor scans. </summary> </member> <member name="F:PrtgAPI.VMwareSessionMode.ReuseSession"> <summary> Reuse sessions for multiple scans. </summary> </member> <member name="F:PrtgAPI.VMwareSessionMode.CreateNewSession"> <summary> Create a new session for each scan. This increases network load and creates additional log entries on the target device. </summary> </member> <member name="T:PrtgAPI.WmiDataSource"> <summary> Specifies the data source to use for WMI sensors. </summary> </member> <member name="F:PrtgAPI.WmiDataSource.PerformanceCountersAndWMI"> <summary> Use both Performance Counters and WMI. </summary> </member> <member name="F:PrtgAPI.WmiDataSource.PerformanceCounters"> <summary> Use Performance Counters only. </summary> </member> <member name="F:PrtgAPI.WmiDataSource.WMI"> <summary> Use WMI only. </summary> </member> <member name="T:PrtgAPI.WmiTimeoutMethod"> <summary> Specifies how long WMI sensors should wait before timing out. </summary> </member> <member name="F:PrtgAPI.WmiTimeoutMethod.OnePointFiveTimesInterval"> <summary> Sensors will wait 1.5x their scanning interval before timing out. </summary> </member> <member name="F:PrtgAPI.WmiTimeoutMethod.Manual"> <summary> Use a custom timeout for all sensors. </summary> </member> <member name="T:PrtgAPI.ProbeStatus"> <summary> Connection status of a PRTG Probe. </summary> </member> <member name="F:PrtgAPI.ProbeStatus.Disconnected"> <summary> The probe is disconnected from the PRTG Core Server. </summary> </member> <member name="F:PrtgAPI.ProbeStatus.Connected"> <summary> The probe is connected to the PRTG Core Server. </summary> </member> <member name="T:PrtgAPI.WmiServiceStatus"> <summary> Indicates the current state of a WMI Service. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.Stopped"> <summary> The service is stopped. This corresponds to the Win32 <see langword="SERVICE_STOPPED" /> constant, which is defined as 0x00000001. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.StartPending"> <summary> The service is starting. This corresponds to the Win32 <see langword="SERVICE_START_PENDING" /> constant, which is defined as 0x00000002. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.StopPending"> <summary> The service is stopping. This corresponds to the Win32 <see langword="SERVICE_STOP_PENDING" /> constant, which is defined as 0x00000003. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.Running"> <summary> The service is running. This corresponds to the Win32 <see langword="SERVICE_RUNNING" /> constant, which is defined as 0x00000004. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.ContinuePending"> <summary> The service continue is pending. This corresponds to the Win32 <see langword="SERVICE_CONTINUE_PENDING" /> constant, which is defined as 0x00000005. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.PausePending"> <summary> The service pause is pending. This corresponds to the Win32 <see langword="SERVICE_PAUSE_PENDING" /> constant, which is defined as 0x00000006. </summary> </member> <member name="F:PrtgAPI.WmiServiceStatus.Paused"> <summary> The service is paused.. This corresponds to the Win32 <see langword="SERVICE_PAUSED" /> constant, which is defined as 0x00000007. </summary> </member> <member name="T:PrtgAPI.DeviceInfoType"> <summary> Specifies types of system information that can exist on a device. </summary> </member> <member name="F:PrtgAPI.DeviceInfoType.System"> <summary> System information including IP/MAC Addresses, serial numbers and operating system versions. </summary> </member> <member name="F:PrtgAPI.DeviceInfoType.Software"> <summary> Installed software information. </summary> </member> <member name="F:PrtgAPI.DeviceInfoType.Hardware"> <summary> Device hardware information, including CPU, Memory, Disk and Network Adapter info. </summary> </member> <member name="F:PrtgAPI.DeviceInfoType.User"> <summary> Logged on user information. </summary> </member> <member name="F:PrtgAPI.DeviceInfoType.Process"> <summary> System process information. </summary> </member> <member name="F:PrtgAPI.DeviceInfoType.Service"> <summary> System service information. </summary> </member> <member name="T:PrtgAPI.ExeType"> <summary> Specifies types of executable files that can be executed by PRTG. </summary> </member> <member name="F:PrtgAPI.ExeType.Application"> <summary> A regular application ending in .exe </summary> </member> <member name="F:PrtgAPI.ExeType.Script"> <summary> A script written in a scripting programming language. </summary> </member> <member name="T:PrtgAPI.FilterMode"> <summary> Specifies the level of level of transformation and validation to perform on a serialized <see cref="P:PrtgAPI.SearchFilter.Value"/> based on the <see cref="P:PrtgAPI.SearchFilter.Property"/>'s required processing rules. </summary> </member> <member name="F:PrtgAPI.FilterMode.Normal"> <summary> Apply all normal transformations and validations. </summary> </member> <member name="F:PrtgAPI.FilterMode.Illegal"> <summary> Apply all normal transformations however do not perform validations. </summary> </member> <member name="F:PrtgAPI.FilterMode.Raw"> <summary> Do not perform any transformations or validations. </summary> </member> <member name="T:PrtgAPI.LogLevel"> <summary> Specifies the types of events that should be logged by <see cref="E:PrtgAPI.PrtgClient.LogVerbose"/>. </summary> </member> <member name="F:PrtgAPI.LogLevel.None"> <summary> Disable all logging. </summary> </member> <member name="F:PrtgAPI.LogLevel.Trace"> <summary> Trace messages describing decisions that will be made and the results of those actions. </summary> </member> <member name="F:PrtgAPI.LogLevel.Request"> <summary> HTTP requests that will be executed and whether those requests will be executed synchronously/asynchronously. </summary> </member> <member name="F:PrtgAPI.LogLevel.Response"> <summary> Responses that are returned from PRTG in response to HTTP API requests. </summary> </member> <member name="F:PrtgAPI.LogLevel.All"> <summary> All log types. </summary> </member> <member name="T:PrtgAPI.ProbeApproval"> <summary> Specifies approval actions for controlling whether new probes may be utilized with PRTG. </summary> </member> <member name="F:PrtgAPI.ProbeApproval.Allow"> <summary> Approve a new probe for use within PRTG. </summary> </member> <member name="F:PrtgAPI.ProbeApproval.AllowAndDiscover"> <summary> Approve a new probe for use within PRTG and immediately perform an auto-discovery. </summary> </member> <member name="F:PrtgAPI.ProbeApproval.Deny"> <summary> Deny a probe from communicating with PRTG and blacklist its GID. </summary> </member> <member name="T:PrtgAPI.RestartCoreStage"> <summary> Specifies stages of restarting the PRTG Core Service. </summary> </member> <member name="F:PrtgAPI.RestartCoreStage.Shutdown"> <summary> PRTG is still in the process of shutting down. </summary> </member> <member name="F:PrtgAPI.RestartCoreStage.Restart"> <summary> PRTG is currently in the middle of restarting. </summary> </member> <member name="F:PrtgAPI.RestartCoreStage.Startup"> <summary> PRTG has restarted and is in the process of initializing. </summary> </member> <member name="F:PrtgAPI.RestartCoreStage.Completed"> <summary> PRTG has successfully restarted. </summary> </member> <member name="T:PrtgAPI.SortDirection"> <summary> Specifies directions list items can be sorted in. </summary> </member> <member name="F:PrtgAPI.SortDirection.Ascending"> <summary> Ascending, from lowest to highest (A-Z, 0-9). </summary> </member> <member name="F:PrtgAPI.SortDirection.Descending"> <summary> Ascending, from highest to lowest (Z-A, 9-0). </summary> </member> <member name="T:PrtgAPI.ObjectPropertyCategory"> <summary> Specifies the settings category an <see cref="T:PrtgAPI.ObjectProperty"/> belongs to. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.BasicSettings"> <summary> Properties found under the Basic Settings section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.Location"> <summary> Properties found under the Location section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.CredentialsForWindows"> <summary> Properties found under the Credentials for Windows Systems section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.CredentialsForLinux"> <summary> Properties found under the Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.CredentialsForVMware"> <summary> Properties found under the Credentials for VMware/XenServer section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.CredentialsForSNMP"> <summary> Properties found under the Credentials for SNMP Devices section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.CredentialsForDatabases"> <summary> Properties found under the Credentials for Database Management Systems section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.CredentialsForAmazon"> <summary> Properties found under the Credentials for Amazon Cloudwatch section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.WindowsCompatibility"> <summary> Properties found under the Windows Compatibility Options section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.SNMPCompatibility"> <summary> Properties found under the SNMP Compatibility Options section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.ChannelUnit"> <summary> Properties found under the Channel Unit Configuration section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.AccessRights"> <summary> Properties found under the Access Rights section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.BasicSensorSettings"> <summary> Properties found under the Basic Sensor Settings section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.DebugOptions"> <summary> Properties found under the Debug Options section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.HttpSpecific"> <summary> Properties found under the HTTP Specific section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.ProxySettingsForHttp"> <summary> Properties found under the Proxy Settings for HTTP Sensors section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.PingSettings"> <summary> Properties found under the Ping Settings section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.ScanningInterval"> <summary> Properties found under the Scanning Interval section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.SchedulesDependenciesAndMaintenance"> <summary> Properties found under the Schedules, Dependencies and Maintenance Window section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.SensorDisplay"> <summary> Properties found under the Sensor Display section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.SensorSettingsExeXml"> <summary> Properties found under the Sensor Settings (EXE/XML) section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.WmiAlternativeQuery"> <summary> Properties found under the WMI Alternative Query section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.WmiRemotePing"> <summary> Properties found under the WMI Remote Ping Configuration section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.SensorFactorySpecific"> <summary> Properties found under the Sensor Factory Specific Settings section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.WmiServiceMonitor"> <summary> Properties found under the WMI Service Monitor section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.DatabaseSpecific"> <summary> Properties found under the Database Specific section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.Data"> <summary> Properties found under the Data section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.Devices"> <summary> Properties found under the Devices section of an object. </summary> </member> <member name="F:PrtgAPI.ObjectPropertyCategory.Special"> <summary> Special properties not visible in the Settings page of the PRTG UI. </summary> </member> <member name="T:PrtgAPI.ObjectType"> <summary> Specifies types of objects that can be targeted by API requests for retrieving and modifying object properties. </summary> </member> <member name="F:PrtgAPI.ObjectType.Sensor"> <summary> Objects used to monitor and collect information according to a specified scanning interval. </summary> </member> <member name="F:PrtgAPI.ObjectType.Device"> <summary> Objects used to organize and specify the physical systems that <see cref="F:PrtgAPI.ObjectType.Sensor"/> objects should target. </summary> </member> <member name="F:PrtgAPI.ObjectType.Group"> <summary> Organizational units used to group <see cref="F:PrtgAPI.ObjectType.Device"/> objects. </summary> </member> <member name="F:PrtgAPI.ObjectType.Probe"> <summary> Physical systems used to distribute monitoring responsibilities across multiple nodes. </summary> </member> <member name="F:PrtgAPI.ObjectType.Map"> <summary> System dashboards. </summary> </member> <member name="F:PrtgAPI.ObjectType.Report"> <summary> An object used to generate reports based on one or more sensors on demand or according to a specified schedule. </summary> </member> <member name="F:PrtgAPI.ObjectType.User"> <summary> A user account capable of authenticating to PRTG. </summary> </member> <member name="F:PrtgAPI.ObjectType.UserGroup"> <summary> A user group used to organize <see cref="F:PrtgAPI.ObjectType.User"/> objects based on role or responsibility. </summary> </member> <member name="F:PrtgAPI.ObjectType.Notification"> <summary> A notification action describing one or more actions to perform when alerting <see cref="F:PrtgAPI.ObjectType.User"/> objects to system activities. </summary> </member> <member name="F:PrtgAPI.ObjectType.Schedule"> <summary> A schedule describing when monitoring should be active or paused. </summary> </member> <member name="F:PrtgAPI.ObjectType.Library"> <summary> A custom view of sensors of a specified type. </summary> </member> <member name="F:PrtgAPI.ObjectType.System"> <summary> Root level system nodes used by PRTG. </summary> </member> <member name="F:PrtgAPI.ObjectType.WebServerOptions"> <summary> Options used for configuring the PRTG Web Server. </summary> </member> <member name="F:PrtgAPI.ObjectType.PrtgUserOrGroup"> <summary> A <see cref="F:PrtgAPI.ObjectType.User"/> or <see cref="F:PrtgAPI.ObjectType.Group"/> used for authenticating locally against PRTG. </summary> </member> <member name="F:PrtgAPI.ObjectType.ActiveDirectoryUserOrGroup"> <summary> A <see cref="F:PrtgAPI.ObjectType.User"/> or <see cref="F:PrtgAPI.ObjectType.Group"/> used for authenticating against PRTG via Active Directory. </summary> </member> <member name="T:PrtgAPI.SensorType"> <summary> <para type="description">Specifies types of sensors that can be created in PRTG.</para> </summary> </member> <member name="F:PrtgAPI.SensorType.ExeXml"> <summary> EXE/Script Advanced sensor, returning XML or JSON </summary> </member> <member name="F:PrtgAPI.SensorType.WmiService"> <summary> WMI Service sensor, for monitoring a Microsoft Windows system service. </summary> </member> <member name="F:PrtgAPI.SensorType.SqlServerDB"> <summary> Microsoft SQL v2 sensor, for monitoring a database on Microsoft SQL Server. </summary> </member> <member name="F:PrtgAPI.SensorType.Http"> <summary> HTTP sensor, for monitoring a web server of HTTP/HTTPS. </summary> </member> <member name="F:PrtgAPI.SensorType.Factory"> <summary> Sensor factory, for aggregating data from other sensors. </summary> </member> <member name="T:PrtgAPI.SensorTypeInternal"> <summary> <para type="description">Specifies types of sensors that can be created in PRTG.</para> </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ActiveDirectoryReplicationErrors"> <summary> Checks Windows domain controllers for replication errors </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ADOSQLv2"> <summary> Monitors any data source that is available via OLE DB or ODBC </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchAlarm"> <summary> Monitors the status of an Amazon CloudWatch alarm by reading its data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchEBS"> <summary> Monitors the performance of an Amazon Elastic Block Store (EBS) by reading its data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchEC2"> <summary> Monitors the performance of an Amazon Elastic Compute Cloud (EC2) by reading its data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchElastiCache"> <summary> Monitors the performance of an Amazon ElastiCache by reading its performance data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchELB"> <summary> Monitors the performance of an Amazon Elastic Load Balancer (ELB) by reading its performance data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchRDS"> <summary> Monitors the performance of an Amazon Relational Database Service (RDS) by reading the data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchSNS"> <summary> Monitors the performance of an Amazon Simple Notification Service (SNS) by reading the data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.AmazonCloudWatchSQS"> <summary> Monitors the performance of an Amazon Simple Queue Service (SQS) by reading its performance data from the AWS CloudWatch API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.BusinessProcess"> <summary> Monitors several business process components and shows a summary status of the whole business process </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CiscoIPSLA"> <summary> Monitors VoIP network parameters using IP SLA from Cisco (uses SNMP) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CitrixXenServerHost"> <summary> Monitors a Citrix XenServer host version 5.0 or later </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CitrixXenServerVirtualMachine"> <summary> Monitors a virtual machine on a Citrix XenServer version 5.0 or later </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CloudHTTP"> <summary> Monitors a web server using HTTP and shows the loading time from different locations on five continents around the globe </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CloudPing"> <summary> Monitors the Ping time to the target device from different locations worldwide, on five continents around the globe </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CommonSaaS"> <summary> Monitors response times of common Software as a Service providers </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.CoreHealth"> <summary> Internal sensor used to monitor the health of the PRTG core </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DellPowerVaultMDiLogDisk"> <summary> Monitors the status of a logical drive on your Dell PowerVault MD3000 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DellPowerVaultMDiPhyDisk"> <summary> Monitors the status of a physical drive on your Dell PowerVault MD3000 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DHCP"> <summary> Checks if the device running the probe can request an IP address via DHCP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DICOMBandwidthSensor"> <summary> Monitors bandwidth usage of a C-STORE request to a DICOM capable device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DICOMCECHOSensor"> <summary> Monitors the availability of DICOM capable systems and devices </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DICOMQueryRetrieveSensor"> <summary> Monitors the C-FIND capability of DICOM capable systems and devices </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DNS"> <summary> Monitors a DNS server (Domain Name Service), resolves a domain name, and compares it to an IP address </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.DockerContainerStatus"> <summary> Monitors the status, uptime, CPU, memory, and network usage of a docker container </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.Dropbox"> <summary> Monitors the free space of your Dropbox account using the Dropbox API and OAuth2 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.EnterpriseVirtualArray"> <summary> Monitors the status of the different modules of an HP StorageWorks EVA using Command View </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.EventLogWindowsAPI"> <summary> Monitors Event Log entries using Windows API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ExchangeBackupPowerShell"> <summary> Monitors backups of an Exchange server using Remote PowerShell </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ExchangeDatabasePowerShell"> <summary> Monitors database information of an Exchange server using Remote PowerShell </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ExchangeDatabaseDAGPowerShell"> <summary> Monitors the DAG status of a database on an Exchange server using Remote PowerShell </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ExchangeMailQueuePowerShell"> <summary> Monitors the number of items in the outgoing mail queue of an Exchange server using Remote PowerShell </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ExchangeMailboxPowerShell"> <summary> Monitors Mailbox information of an Exchange server using Remote PowerShell </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ExchangePublicFolderPowerShell"> <summary> Monitors Public Folder information of an Exchange server using Remote PowerShell </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.EXEScript"> <summary> Runs EXE/DLL or a script (batch file, VBScript, PowerShell) which returns a numerical value </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.EXEScriptAdvanced"> <summary> Runs EXE/DLL or a script (batch file, VBScript, PowerShell) that returns XML or JSON </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.File"> <summary> Monitors a file (availability, file age, file size, changes) using SMB </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.FileContent"> <summary> Monitors the last occurrence of a specified string in a file, for example, a logfile </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.Folder"> <summary> Monitors a folder (availability, file age, file size, file count, changes) using SMB </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.FTP"> <summary> Monitors FTP servers (File Transfer Protocol) and FTPS servers (FTP over SSL) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.FTPServerFileCount"> <summary> Monitors the number of files on an FTP server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.GitLabBuildStatus"> <summary> Monitors the status of the latest build on one specific branch in either your own GitLab environment or on GitLab.com </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.GoogleAnalytics"> <summary> Monitors metrics from your Google Analytics account using the Google API and OAuth2 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.GoogleDrive"> <summary> Monitors the free space of your Google Drive account using the Google API and OAuth2 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.GreenIT"> <summary> We all want Green IT </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HL7Sensor"> <summary> Monitors the availability of HL7 capable systems and devices </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTP"> <summary> Monitors a web server using HTTP (Hypertext Transfer Protocol) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPAdvanced"> <summary> Monitors a web server using HTTP (supports authentication, content checks, etc.) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPApacheModStatusPerfStats"> <summary> Monitors performance statistics of an Apache web server using mod_status over HTTP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPApacheModStatusTotals"> <summary> Monitors accesses and transferred kBytes of an Apache web server using mod_status over HTTP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPContent"> <summary> Monitors a numerical value returned by an HTTP request </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPDataAdvanced"> <summary> Accesses a web server and retrieves data in XML or JSON encoded format </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPFullWebPage"> <summary> Monitors the download time of a complete web page including page elements, for example images </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPIoTPushDataAdvanced"> <summary> Displays data from XML encoded messages that are pushed to PRTG via an HTTPS request in one or more channels </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPPushCount"> <summary> Counts received messages that are pushed via an HTTP request to PRTG </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPPushDataAdvanced"> <summary> Displays data from XML encoded messages that are pushed to PRTG via an HTTP request in one or more channels </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPPushData"> <summary> Displays numerical values from messages that are pushed to PRTG via an HTTP request in one channel </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPTransaction"> <summary> Monitors a web server by performing a transaction using a set of URLs </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HTTPXMLRESTValue"> <summary> Retrieves an XML file via HTTP and returns the value of an XML node (JSON allowed) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HyperVClusterSharedVolDiskFree"> <summary> Monitors the usage of a Microsoft Cluster Shared Volume (CSV) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HyperVHostServer"> <summary> Monitors a Hyper-V host server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HyperVVirtualMachine"> <summary> Monitors a virtual machine on a Hyper-V server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HyperVVirtualNetworkAdapter"> <summary> Monitors a Hyper-V Virtual Network Adapter </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.HyperVVirtualStorageDevice"> <summary> Monitors a Hyper-V Virtual Storage Device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.IMAP"> <summary> Monitors an email server using IMAP (Internet Message Access Protocol) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.IPonDNSBlacklist"> <summary> Checks the IP address of the parent device against a number of blacklist servers </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.IPFIX"> <summary> Monitors a switch using IPFIX </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.IPFIXCustom"> <summary> Monitors a switch using IPFIX (customizable) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.IPMISystemHealth"> <summary> Monitors temperature, fan, voltage, and power supply via the Intelligent Platform Management Interface (IPMI) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.jFlowV5"> <summary> Monitors a switch using jFlow V5 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.jFlowV5Custom"> <summary> Monitors a switch using jFlow V5 (customizable) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.LDAP"> <summary> Monitors LDAP directory services </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.MicrosoftOneDrive"> <summary> Monitors the free space on your OneDrive Personal account using the OneDrive API and OAuth2 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.MicrosoftSQLv2"> <summary> Monitors a database on a Microsoft SQL Server (MSSQL) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.MySQLv2"> <summary> Monitors a database on a MySQL Server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppAggregate"> <summary> Monitors size and files of a NetApp cDOT or ONTAP storage aggregate using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppIO"> <summary> Monitors traffic and disk throughput (IOPS) of a NetApp cDOT or ONTAP storage system using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppLIF"> <summary> Monitors logical interfaces of a NetApp cluster using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppLUN"> <summary> Monitors the logical unit number (LUN) of a NetApp cDOT or ONTAP storage system using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppNIC"> <summary> Monitors the network interface controller (NIC) of a NetApp cDOT or ONTAP cluster using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppPhysicalDisk"> <summary> Monitors disks of a NetApp cDOT or ONTAP storage system using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppSnapMirror"> <summary> Monitors SnapMirror relationships of a NetApp cDOT or ONTAP storage system using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppSystemHealth"> <summary> Monitors CPU and memory of a NetApp cDOT or ONTAP storage system using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetAppVolume"> <summary> Monitors volumes of a NetApp cDOT or ONTAP storage system using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetFlowV5"> <summary> Monitors a switch using NetFlow version 5 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetFlowV5Custom"> <summary> Monitors a switch using NetFlow Version 5 (customizable) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetFlowV9"> <summary> Monitors a switch using NetFlow version 9 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.NetFlowV9Custom"> <summary> Monitors a switch using NetFlow version 9 (customizable) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.OracleSQLv2"> <summary> Monitors a database on an Oracle server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.OracleTablespace"> <summary> Monitors a tablespace on an Oracle server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PacketSniffer"> <summary> Monitors headers of data packets passing a local network card using built-in packet sniffer </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PacketSnifferCustom"> <summary> Monitors data packets passing a local network card with custom channels </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PerfCounterCustom"> <summary> Monitors a configured set of Performance Counters </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PerfCounterIISApplicationPool"> <summary> Monitors IIS Application Pools using Performance Counters </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.Ping"> <summary> Monitors connectivity using Ping </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PingJitter"> <summary> Monitors the Statistical Jitter value for Pings to the parent device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.POP3"> <summary> Monitors an email server using POP3 (Post Office Protocol V3) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.Port"> <summary> Monitors a network service by connecting to its TCP/IP port </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PortRange"> <summary> Monitors a network service by connecting to various TCP/IP ports </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PostgreSQL"> <summary> Monitors a database on a PostgreSQL Server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ProbeHealth"> <summary> Internal sensor used to monitor the health of a PRTG probe </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.PythonScriptAdvanced"> <summary> Runs a Python script that returns XML or JSON </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.QoSQualityofServiceOneWay"> <summary> Monitors VoIP relevant network parameters between two probes - in one direction </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.QoSQualityofServiceRoundTrip"> <summary> Monitors VoIP relevant network parameters between two probes - in both directions </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RADIUSv2"> <summary> Monitors a RADIUS server (Remote Authentication Dial-In User Service) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RDPRemoteDesktop"> <summary> Monitors remote desktop services (RDP, Terminal Services Client) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RESTCustom"> <summary> Monitors JSON and XML REST APIs </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RESTDellEMCCapacity"> <summary> Monitors the capacity of a Dell EMC storage system via the REST API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RESTDellEMCFileSystem"> <summary> Monitors a file system on a Dell EMC storage system via the REST API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RESTDellEMCLUN"> <summary> Monitors a logical unit number (LUN) on a Dell EMC storage system via the REST API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RESTDellEMCPool"> <summary> Monitors a storage pool on a Dell EMC storage system via the REST API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.RESTDellEMCSystemHealth"> <summary> Monitors the system health of a Dell EMC storage system via the REST API </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SensorFactory"> <summary> Create your own sensor with channels based on data from other sensors </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.sFlow"> <summary> Monitors a switch using sFlow V5 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.sFlowCustom"> <summary> Monitors a switch using sFlow V5 (customizable) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SFTPSecureFileTransferProtocol"> <summary> Monitors FTP servers of a Linux/Unix system using SSH File Transfer Protocol (FTP over SSH) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ShareDiskFree"> <summary> Monitors free disk space of a share (Windows/Samba) using SMB </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SIPOptionsPing"> <summary> Monitors connectivity for a SIP server using SIP options \'"Ping\'" </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SMTP"> <summary> Monitors an email server using SMTP (Simple Mail Transfer Protocol) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SMTPIMAPRoundTrip"> <summary> Monitors the time it takes for an email to reach an IMAP mailbox after being sent using SMTP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SMTPPOP3RoundTrip"> <summary> Monitors the time it takes for an email to reach a POP3 mailbox after being sent using SMTP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPAPCHardware"> <summary> Monitors performance counters on APC UPS hardware </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPBuffaloTSSystemHealth"> <summary> Monitors the system health of a Buffalo TeraStation NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoADSL"> <summary> Monitors ADSL statistics of a Cisco router using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoASAVPNConnections"> <summary> Monitors VPN connections on a Cisco Adaptive Security Appliance </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoASAVPNTraffic"> <summary> Monitors the traffic for IPsec VPN tunnels on a Cisco Adaptive Security Appliance </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoASAVPNUsers"> <summary> Monitors which users are connected to a VPN on a Cisco Adaptive Security Appliance </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoCBQoS"> <summary> Monitors network parameters using Cisco's Class Based Quality of Service via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoSystemHealth"> <summary> Monitors the system health of a Cisco device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoUCSBlade"> <summary> Monitors the health status of a blade server in a Cisco Unified Computing System device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoUCSChassis"> <summary> Monitors the health status of the chassis of a Cisco Unified Computing System device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoUCSPhysicalDisk"> <summary> Monitors the physical disk of a Cisco Unified Computing System device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCiscoUCSSystemHealth"> <summary> Monitors the system health of a Cisco Unified Computing System device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCPULoad"> <summary> Monitors the load of a CPU via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCustom"> <summary> Monitors a numerical value returned by a specific OID using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCustomAdvanced"> <summary> Monitors numerical values returned by up to 10 specific OIDs using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCustomString"> <summary> Monitors a string returned by a specific OID using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCustomStringLookup"> <summary> Monitors a string value returned by a specific OID using SNMP and lookups </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPCustomTable"> <summary> Monitors entries from a table that is provided via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDellEqualLogicLogicalDisk"> <summary> Monitors a logical disk of a Dell EqualLogic storage system </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDellEqualLogicMemberHealth"> <summary> Monitors a storage array member of a Dell EqualLogic storage system </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDellEqualLogicPhysicalDisk"> <summary> Monitors a physical disk of a Dell EqualLogic storage system </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDellHardware"> <summary> Monitors performance counters on a Dell Computer </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDellPowerEdgePhysicalDisk"> <summary> Monitors a physical disk in a Dell PowerEdge server (needs Dell Open Manage to be installed on the device) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDellPowerEdgeSystemHealth"> <summary> Monitors the system health of a Dell PowerEdge server (needs Dell OpenManage to be installed on the device) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPDiskFree"> <summary> Monitors the free disk space on a logical disk via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPFujitsuSystemHealth"> <summary> Monitors the system health of a Fujitsu PRIMERGY server via the integrated Remote Management Controller (iRMC) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHardwareStatus"> <summary> Monitors the status of a server component via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPBladeSystemBlade"> <summary> Monitors the server blades of an HP BladeSystem </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPBladeSystemEnclosureSystemHealth"> <summary> Monitors the system health of an HP BladeSystem device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPLaserJetHardware"> <summary> Monitors performance counters on an HP LaserJet printer (also works with some OfficeJet printers) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPProLiantLogicalDisk"> <summary> Monitors a logical disk in an HP server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPProLiantMemoryController"> <summary> Monitors a memory controller in an HP server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPProLiantNetworkInterface"> <summary> Monitors a network interface in an HP server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPProLiantPhysicalDisk"> <summary> Monitors a physical disk in an HP server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPHPProLiantSystemHealth"> <summary> Monitors the system health of an HP server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPIBMSystemXLogicalDisk"> <summary> Monitors a logical disk in an IBM server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPIBMSystemXPhysicalDisk"> <summary> Monitors a physical disk in an IBM server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPIBMSystemXPhysicalMemory"> <summary> Monitors the memory modules in an IBM server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPIBMSystemXSystemHealth"> <summary> Monitors the system health of an IBM device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPinterSeptorProEnvironment"> <summary> Monitors temperature and humidity on a Jacarta interSeptor Pro environmental monitoring device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPJuniperNSSystemHealth"> <summary> Monitors the system health of a Juniper NetScreen device </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLenovoEMCPhysicalDisk"> <summary> Monitors a physical disk in a LenovoEMC NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLenovoEMCSystemHealth"> <summary> Monitors the system health of a LenovoEMC NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLibrary"> <summary> Monitors a device using SNMP and compiled MIB files (\'"SNMP Libraries (oidlib)\'") </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLinuxDiskFree"> <summary> Monitors free space on disks of a Linux/Unix system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLinuxLoadAverage"> <summary> Monitors system load average of a Linux/Unix system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLinuxMeminfo"> <summary> Monitors memory usage of a Linux/Unix system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPLinuxPhysicalDisk"> <summary> Monitors IOs on disks of a Linux/Unix system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPMemory"> <summary> Monitors the memory usage via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppDiskFree"> <summary> Monitors free space on disks of a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppEnclosure"> <summary> Monitors the power supply and cooling of an enclosure that is part of a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppIO"> <summary> Monitors traffic and disk throughput (IOPS) of a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppLicense"> <summary> Monitors licenses for the services of a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppLogicalUnit"> <summary> Monitors the IO on a logical unit of a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppNetworkInterface"> <summary> Monitors a network interface on a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPNetAppSystemHealth"> <summary> Monitors key data of a NetApp storage system using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPPoseidonEnvironment"> <summary> Monitors performance counters for environmental measurements on Poseidon hardware </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPPrinter"> <summary> Monitors the status of many printers via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPQNAPLogicalDisk"> <summary> Monitors a logical disk in a QNAP NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPQNAPPhysicalDisk"> <summary> Monitors a physical disk in a QNAP NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPQNAPSystemHealth"> <summary> Monitors the system health of a QNAP NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPRMON"> <summary> Monitors a network switch port by port using SNMP and Remote Monitoring (RMON) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPSonicWallSystemHealth"> <summary> Monitors the system health of a Dell SonicWall Network Security Appliance (NSA) via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPSonicWallVPNTraffic"> <summary> Monitors the traffic of an IPsec VPN on a Dell SonicWall Network Security Appliance (NSA) via SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPSynologyLogicalDisk"> <summary> Monitors a logical disk in a Synology NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPSynologyPhysicalDisk"> <summary> Monitors a physical disk in a Synology NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPSynologySystemHealth"> <summary> Monitors the System Health of a Synology NAS using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPSystemUptime"> <summary> Monitors the uptime of a device using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPTraffic"> <summary> Monitors bandwidth and traffic on servers, PCs, switches, etc. using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPTrapReceiver"> <summary> Receives and analyzes SNMP Trap messages </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNMPWindowsService"> <summary> Monitors a Windows service using SNMP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SNTP"> <summary> Monitors an SNTP/NTP server (Simple Network Time Protocol) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHDiskFree"> <summary> Monitors available space on disks of a Linux/Unix system using SSH </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHINodesFree"> <summary> Monitors free INodes on disks of a Linux/Unix or Mac OS system using SSH </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHLoadAverage"> <summary> Monitors load average of a Linux/Unix or Mac OS system using SSH </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHMeminfo"> <summary> Monitors memory usage of a Linux/Unix or Mac OS system using SSH </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHRemotePing"> <summary> Remotely monitors the connectivity between a system running Linux/OS X and an other device, using Ping and SSH </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHSANEnclosure"> <summary> Monitors the health of an enclosure on an SAN that supports CLI over SSH, for example the HP P2000. </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHSANLogicalDisk"> <summary> Monitors a logical disk on an SAN that supports CLI over SSH, for example the HP P2000 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHSANPhysicalDisk"> <summary> Monitors a physical disk on an SAN that supports CLI over SSH, for example the HP P2000 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHSANSystemHealth"> <summary> Monitors the system health on an SAN that supports CLI over SSH, for example the HP P2000. </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHScript"> <summary> Connects to a Linux/Unix system using SSH and runs a custom script which returns a numerical value </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSHScriptAdvanced"> <summary> Connects to a Linux/Unix system using SSH and runs a custom script which returns XML or JSON </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSLCertificateSensor"> <summary> Monitors the certificate of a secure SSL/TLS connection </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SSLSecurityCheck"> <summary> Monitors the SSL connectivity of a TCP/IP port </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SyslogReceiver"> <summary> Receives and analyzes Syslog messages </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.SystemHealth"> <summary> Internal sensor used to monitor the health of the system running PRTG </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.TFTP"> <summary> Monitors a TFTP server (Trivial FTP) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.TracerouteHopCount"> <summary> Monitors the number of hops from the probe to the parent device and alerts if the route has changed </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.VMwareDatastoreSOAP"> <summary> Monitors disk usage and accessibility of a VMware datastore using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.VMwareHostHardwareWBEM"> <summary> Monitors hardware information of an ESXi server using WBEM </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.VMwareHostHardwareStatusSOAP"> <summary> Monitors the hardware health status of a VMware host server using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.VMwareHostPerformanceSOAP"> <summary> Monitors the performance of a VMware host server or VMware Workstation using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.VMwareVirtualMachineSOAP"> <summary> Monitors virtual machines on a VMware host server using SOAP </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsCPULoad"> <summary> Monitors CPU load using performance counters or WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsIIS60SMTPReceived"> <summary> Monitors number of received emails for an IIS 6.0 SMTP service (Exchange 2003) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsIIS60SMTPSent"> <summary> Monitors number of sent emails for an IIS 6.0 SMTP service (Exchange 2003) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsIISApplication"> <summary> Monitors a Microsoft Internet Information Services installation using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsMSMQQueueLength"> <summary> This sensor counts the number of messages in a Microsoft Message Queue </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsNetworkCard"> <summary> Monitors bandwidth usage and traffic of a network interface using performance counters or WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsPagefile"> <summary> Monitors Windows pagefile usage using performance counters or WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsPhysicalDiskIO"> <summary> Monitors accumulated disk data such as read/write time and bytes, average transfer time, queue length, and IOs </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsPrintQueue"> <summary> Monitors the number of jobs in a print queue </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsProcess"> <summary> Monitors performance counters of a Windows process </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsSystemUptime"> <summary> Monitors uptime of a Windows system using performance counters or WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WindowsUpdatesStatusPowerShell"> <summary> Displays Windows Updates status (last update, number of available/installed updates) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMICustom"> <summary> Performs a custom WMI query and monitors numerical values </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMICustomString"> <summary> Performs a custom WMI query and shows the returned string </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIEventLog"> <summary> Monitors Event Log entries using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIExchangeServer"> <summary> Monitors a Microsoft Exchange Server using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIExchangeTransportQueue"> <summary> Monitors the transport queue of a Microsoft Exchange Server </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIFile"> <summary> Monitors a file using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIFreeDiskSpaceMultiDisk"> <summary> Monitors free space of all or one local disk drive (one channel per disk) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIHDDHealth"> <summary> Monitors the health of IDE disk drives using SMART </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMILogicalDiskIO"> <summary> Monitors disk data such as read/write time, transfer time, IOs, queue length, and free space </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMemory"> <summary> Monitors available system memory systems using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMicrosoftSQLServer2005"> <summary> Monitors the performance of an instance of Microsoft SQL Server 2005. Might not work with the latest version of SQL Server 2005 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMicrosoftSQLServer2008"> <summary> Monitors the performance of an instance of Microsoft SQL Server 2008 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMicrosoftSQLServer2012"> <summary> Monitors the performance of an instance of Microsoft SQL Server 2012 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMicrosoftSQLServer2014"> <summary> Monitors the performance of an instance of Microsoft SQL Server 2014 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMicrosoftSQLServer2016"> <summary> Monitors the performance of an instance of Microsoft SQL Server 2016 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIMicrosoftSQLServer2017"> <summary> Monitors the performance of an instance of Microsoft SQL Server 2017 </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIRemotePing"> <summary> Remotely monitors the connectivity between a system running Windows and another device, using Ping and WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMISecurityCenter"> <summary> Monitors the status of security software on a Windows client as reported by Microsoft Security Center </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIService"> <summary> Monitors a Windows service using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIShare"> <summary> Monitors a shared resource on a Windows system using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMISharePointProcess"> <summary> Monitors processes on a Microsoft SharePoint server using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMITerminalServicesWin2008"> <summary> Monitors the number of sessions on a Windows Terminal Services server using WMI on Windows Server 2008 or later </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMITerminalServicesXPVista2k3"> <summary> Monitors the number of sessions on a Windows Terminal Services server using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIUTCTime"> <summary> Monitors the UTC Time of a device using WMI. The value is compared to the time of the PRTG Core Service </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIVitalSystemDataV2"> <summary> Monitors vital system parameters using WMI (CPU, memory, disk, network) </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WMIVolume"> <summary> Monitors free disk space on a drive, logical volume, or mount point using WMI </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.WSUSStatistics"> <summary> This sensor retrieves various WSUS statistics. WSUS 3.0 Administration Console needs to be installed on the probe system </summary> </member> <member name="F:PrtgAPI.SensorTypeInternal.ZEN"> <summary> The ZEN of PRTG </summary> </member> <member name="T:PrtgAPI.SysInfoProperty"> <summary> Specifies properties that can be retrieved on System Information Objects. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.DisplayName"> <summary> Object display name. Applies to: all <see cref="T:PrtgAPI.DeviceInfoType"/> types. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Name"> <summary> Short object name. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>, <see cref="F:PrtgAPI.DeviceInfoType.Service"/>, <see cref="F:PrtgAPI.DeviceInfoType.Software"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Description"> <summary> Object description. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>, <see cref="F:PrtgAPI.DeviceInfoType.Service"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.SerialNumber"> <summary> Object serial number. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Capacity"> <summary> Object capacity. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Class"> <summary> Object class. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Caption"> <summary> Object caption. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>, <see cref="F:PrtgAPI.DeviceInfoType.Process"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.State"> <summary> Object state. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Hardware"/>, <see cref="F:PrtgAPI.DeviceInfoType.Service"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Domain"> <summary> user domain. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.User"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.User"> <summary> Username. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.User"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.ProcessId"> <summary> Process ID. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.Process"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Key"> <summary> Property name. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.System"/>. </summary> </member> <member name="F:PrtgAPI.SysInfoProperty.Value"> <summary> Property value. Applies to: <see cref="F:PrtgAPI.DeviceInfoType.System"/>. </summary> </member> <member name="T:PrtgAPI.SystemCacheType"> <summary> <para type="description">Specifies types of caches that exist on a PRTG Network Monitor server.</para> </summary> </member> <member name="F:PrtgAPI.SystemCacheType.General"> <summary> Cached data for Geo Maps and Active Directory Authentication. </summary> </member> <member name="F:PrtgAPI.SystemCacheType.GraphData"> <summary> Cached data for displaying graph data. Note: if this cache data is cleared, PRTG will be restarted. </summary> </member> <member name="T:PrtgAPI.ConfigFileType"> <summary> <para type="description">Specifies types of config files that can be loaded by PRTG.</para> </summary> </member> <member name="F:PrtgAPI.ConfigFileType.General"> <summary> Device icons, report templates and language files. </summary> </member> <member name="F:PrtgAPI.ConfigFileType.Lookups"> <summary> Custom lookups used for customizing the display of sensor channel values. </summary> </member> <member name="T:PrtgAPI.RequestVersion"> <summary> Specifies the minimum version of PRTG a version specific request applies to. </summary> </member> <member name="F:PrtgAPI.RequestVersion.v14_4"> <summary> PRTG Network Monitor 14.4 </summary> </member> <member name="F:PrtgAPI.RequestVersion.v17_4"> <summary> PRTG Network Monitor 17.4 </summary> </member> <member name="F:PrtgAPI.RequestVersion.v18_1"> <summary> PRTG Network Monitor 18.1 </summary> </member> <member name="T:PrtgAPI.SystemInfoType"> <summary> Specifies types of system information that can be retrieved for an object. </summary> </member> <member name="F:PrtgAPI.SystemInfoType.System"> <summary> System information including IP/MAC Addresses, serial numbers and operating system versions. </summary> </member> <member name="F:PrtgAPI.SystemInfoType.Software"> <summary> Installed software information. </summary> </member> <member name="F:PrtgAPI.SystemInfoType.Hardware"> <summary> Device hardware information, including CPU, Memory, Disk and Network Adapter info. </summary> </member> <member name="F:PrtgAPI.SystemInfoType.Users"> <summary> Logged on user information. </summary> </member> <member name="F:PrtgAPI.SystemInfoType.Processes"> <summary> System process information. </summary> </member> <member name="F:PrtgAPI.SystemInfoType.Services"> <summary> System service information. </summary> </member> <member name="T:PrtgAPI.Either`2"> <summary> Represents a value that may be one of two types. </summary> <typeparam name="TLeft">The first type the value may be.</typeparam> <typeparam name="TRight">The second type the value may be.</typeparam> </member> <member name="P:PrtgAPI.Either`2.Left"> <summary> The first value that may be specified. </summary> </member> <member name="P:PrtgAPI.Either`2.Right"> <summary> The second value that may be specified. </summary> </member> <member name="P:PrtgAPI.Either`2.IsLeft"> <summary> Indicates whether the <see cref="P:PrtgAPI.Either`2.Left"/> value has been specified. If not, <see cref="P:PrtgAPI.Either`2.Right"/> is specified. </summary> </member> <member name="M:PrtgAPI.Either`2.#ctor(`0)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Either`2"/> class with a value of the first possible type. </summary> <param name="value">The value to use.</param> </member> <member name="M:PrtgAPI.Either`2.#ctor(`1)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Either`2"/> class with a value of the second possible type. </summary> <param name="value">The value to use.</param> </member> <member name="M:PrtgAPI.Either`2.op_Implicit(`0)~PrtgAPI.Either{`0,`1}"> <summary> Creates a new <see cref="T:PrtgAPI.Either`2"/> with a value of the first possible type. </summary> <param name="value">The value to use.</param> </member> <member name="M:PrtgAPI.Either`2.op_Implicit(`1)~PrtgAPI.Either{`0,`1}"> <summary> Creates a new <see cref="T:PrtgAPI.Either`2"/> with a value of the second possible type. </summary> <param name="value">The value to use.</param> </member> <member name="M:PrtgAPI.Either`2.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.LogVerboseEventArgs"> <summary> The arguments passed to an event handler when a informational debug data is logged. </summary> </member> <member name="P:PrtgAPI.LogVerboseEventArgs.Message"> <summary> Gets or sets the description of the event. </summary> </member> <member name="P:PrtgAPI.LogVerboseEventArgs.LogLevel"> <summary> Gets or sets the type of event that was logged. </summary> </member> <member name="M:PrtgAPI.LogVerboseEventArgs.#ctor(System.String,PrtgAPI.LogLevel)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.LogVerboseEventArgs"/> class. </summary> <param name="message">The description of the event.</param> <param name="logLevel">The type of event that was logged.</param> </member> <member name="T:PrtgAPI.HttpDeserializationException"> <summary> The exception that is thown when a HTTP document cannot be deserialized. </summary> </member> <member name="M:PrtgAPI.HttpDeserializationException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.HttpDeserializationException"/> class. </summary> </member> <member name="M:PrtgAPI.HttpDeserializationException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.HttpDeserializationException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.HttpDeserializationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.HttpDeserializationException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.HttpDeserializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.HttpDeserializationException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.Exceptions.Internal.InvalidExpressionException"> <summary> The exception that is thrown when an <see cref="T:System.Linq.Expressions.Expression"/> is encountered that is not valid for the specified context. </summary> </member> <member name="M:PrtgAPI.Exceptions.Internal.InvalidExpressionException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.InvalidExpressionException"/> class. </summary> </member> <member name="M:PrtgAPI.Exceptions.Internal.InvalidExpressionException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.InvalidExpressionException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.InvalidExpressionException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.InvalidExpressionException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.InvalidExpressionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.InvalidExpressionException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.Exceptions.Internal.MissingAttributeException"> <summary> The exception that is thrown when a type or property property is missing a required attribute. </summary> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingAttributeException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingAttributeException"/> class. </summary> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingAttributeException.#ctor(System.Type,System.Type)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingAttributeException"/> with the attribute that was missing and the type it was missing from. </summary> <param name="type">The type that was missing an attribute.</param> <param name="attribute">The attribute that was missing.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingAttributeException.#ctor(System.Type,System.String,System.Type)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingAttributeException"/> class with the attribute that was missing, the property it was missing from, and the type the property belonged to. </summary> <param name="type">The type whose property was missing an attribute.</param> <param name="property">The property that was missing an attribute.</param> <param name="attribute">The attribute that was missing.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingAttributeException.#ctor(System.Type,System.String,System.Type,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingAttributeException"/> class with the attribute that was missing, the property it was missing from, and the type the property belonged to and a reference to the inner exception that is the cause of this exception. </summary> <param name="type">The type whose property was missing an attribute.</param> <param name="property">The property that was missing an attribute.</param> <param name="attribute">The attribute that was missing.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingAttributeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingAttributeException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.Exceptions.Internal.MissingParameterTypeException"> <summary> The exception that is thrown when a <see cref="T:PrtgAPI.Parameter"/> is missing a <see cref="T:PrtgAPI.ParameterType"/> . </summary> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingParameterTypeException.#ctor(PrtgAPI.Parameter)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingParameterTypeException"/> class with a specified <see cref="T:PrtgAPI.Parameter"/>. </summary> <param name="parameter">The parameter missing a <see cref="T:PrtgAPI.Attributes.ParameterTypeAttribute"/> property that caused this exception.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingParameterTypeException.#ctor(PrtgAPI.Parameter,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingParameterTypeException"/> class with a specified <see cref="T:PrtgAPI.Parameter"/> and a reference to the inner exception that is the cause of this exception. </summary> <param name="parameter">The parameter missing a <see cref="T:PrtgAPI.Attributes.ParameterTypeAttribute"/> property that caused this exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.Exceptions.Internal.MissingParameterTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Exceptions.Internal.MissingParameterTypeException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.InvalidStateException"> <summary> The exception that is thrown when an object on a PRTG Server is not in a valid state. </summary> </member> <member name="M:PrtgAPI.InvalidStateException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidStateException"/> class. </summary> </member> <member name="M:PrtgAPI.InvalidStateException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidStateException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.InvalidStateException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidStateException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.InvalidStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidStateException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.ObjectResolutionException"> <summary> The exception that is thrown when an object cannot be resolved from a PRTG Server. </summary> </member> <member name="M:PrtgAPI.ObjectResolutionException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.ObjectResolutionException"/> class. </summary> </member> <member name="M:PrtgAPI.ObjectResolutionException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.ObjectResolutionException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.ObjectResolutionException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.ObjectResolutionException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.ObjectResolutionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.ObjectResolutionException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="M:PrtgAPI.Parameters.Helpers.DynamicPropertyTypeParser.ParseValue"> <summary> Validate and retrieve the serialized format of a value based on its type. </summary> <returns></returns> </member> <member name="T:PrtgAPI.Parameters.FactorySensorParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for creating a new Sensor Factory sensor. </summary> </member> <member name="M:PrtgAPI.Parameters.FactorySensorParameters.#ctor(System.Collections.Generic.IEnumerable{System.String},System.String,PrtgAPI.FactoryErrorMode,System.String,PrtgAPI.FactoryMissingDataMode)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.FactorySensorParameters"/> class. </summary> <param name="channelDefinition">The channel definition to use for the sensor.</param> <param name="sensorName">The name to use for the sensor.</param> <param name="errorMode">How the sensor should respond when a source channel is in an error state.</param> <param name="errorFormula">The custom formula to use when <paramref name="errorMode"/> is <see cref="F:PrtgAPI.FactoryErrorMode.CustomFormula"/>.</param> <param name="missingDataMode">The value a channel should use when one of its source channels is not reporting a value.</param> </member> <member name="P:PrtgAPI.Parameters.FactorySensorParameters.ChannelDefinition"> <summary> Gets or sets the channel definition to use for the factory. </summary> </member> <member name="P:PrtgAPI.Parameters.FactorySensorParameters.FactoryErrorMode"> <summary> Gets or sets how the factory should respond when one of its source sensors enters an error state. </summary> </member> <member name="P:PrtgAPI.Parameters.FactorySensorParameters.FactoryErrorFormula"> <summary> Gets or sets a custom formula to use for determining when the factory should enter an error state. </summary> </member> <member name="P:PrtgAPI.Parameters.FactorySensorParameters.FactoryMissingDataMode"> <summary> Gets or sets the value to use for channels when their source sensors are not reporting data. </summary> </member> <member name="T:PrtgAPI.Parameters.PrtgObjectParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving generic <see cref="T:PrtgAPI.PrtgObject"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.PrtgObjectParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.PrtgObjectParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.PrtgObjectParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.PrtgObjectParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="T:PrtgAPI.Parameters.PageableParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving a large number of objects over a series of smaller requests. </summary> </member> <member name="F:PrtgAPI.Parameters.PageableParameters.DefaultPageSize"> <summary> Represents the default number of items to retrieve per request when streaming. </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.StartOffset"> <summary> Gets the index of the first object of this data type.<para/> When specifying <see cref="P:PrtgAPI.Parameters.PageableParameters.Start"/>, this value should be taken into account to ensure the correct index is targeted. Based on whether the start offset is "0" or "1", a start position of "2" could be interpreted by PRTG as either "3" or "2". </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.Start"> <summary> Gets or sets the record index to start at, relative to <see cref="P:PrtgAPI.Parameters.PageableParameters.StartOffset"/>.<para/> When modifying this property, <see cref="P:PrtgAPI.Parameters.PageableParameters.StartOffset"/> should be taken into account to ensure the correct index is being targeted.<para/> If a large <see cref="P:PrtgAPI.Parameters.PageableParameters.Count"/> is specified that overlaps with the records skipped by this value, this value may be partially or completely ignored. </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.Count"> <summary> Gets or sets the number of records to return per request. If this value is null, all records will be returned.<para/> If this value is less than the total number of records available, additional records can be obtained by requesting the next <see cref="P:PrtgAPI.Parameters.PageableParameters.Page"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.Page"> <summary> Gets or sets the page of the response to return. Requests can be split over multiple pages to increase the speed of each individual request.<para/> Modifying this value increments or decrements <see cref="P:PrtgAPI.Parameters.PageableParameters.Start"/> by <see cref="P:PrtgAPI.Parameters.PageableParameters.Count"/> records. If <see cref="P:PrtgAPI.Parameters.PageableParameters.Count"/> is null, modifying this value will have no effect. </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.PageSize"> <summary> Gets or sets the number of records to retrieve per <see cref="P:PrtgAPI.Parameters.PageableParameters.Page"/> when streaming.<para/>If <see cref="P:PrtgAPI.Parameters.PageableParameters.Count"/> is lower than this value, all records will be retrieved in a single request and this value will be ignored. </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.SortBy"> <summary> Gets or sets the <see cref="T:PrtgAPI.Property"/> to sort the response by. </summary> </member> <member name="P:PrtgAPI.Parameters.PageableParameters.SortDirection"> <summary> Gets or sets the direction to sort the returned objects by. By default, when <see cref="P:PrtgAPI.Parameters.PageableParameters.SortBy"/> is specified objects are sorted ascending from lowest to highest. </summary> </member> <member name="T:PrtgAPI.Parameters.PropertyParameter`1"> <summary> Base class for parameter types that modify object properties. </summary> <typeparam name="T">The type of property manipulated by this object.</typeparam> </member> <member name="P:PrtgAPI.Parameters.PropertyParameter`1.Property"> <summary> Gets the property to process. </summary> </member> <member name="P:PrtgAPI.Parameters.PropertyParameter`1.Value"> <summary> Gets the value to set the <see cref="P:PrtgAPI.Parameters.PropertyParameter`1.Property"/> to. </summary> </member> <member name="M:PrtgAPI.Parameters.PropertyParameter`1.#ctor(`0,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.PropertyParameter`1"/> class. </summary> <param name="property">The property to process.</param> <param name="value">The value to set the specified <paramref name="property"/> to.</param> </member> <member name="T:PrtgAPI.Parameters.ChannelParameter"> <summary> Represents a single parameter for modifying a <see cref="T:PrtgAPI.ChannelProperty"/>. </summary> </member> <member name="M:PrtgAPI.Parameters.ChannelParameter.#ctor(PrtgAPI.ChannelProperty,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ChannelParameter"/> class. </summary> <param name="property"></param> <param name="value"></param> </member> <member name="T:PrtgAPI.Parameters.ScheduleParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.Schedule"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.ScheduleParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ScheduleParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.ScheduleParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ScheduleParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="T:PrtgAPI.Parameters.HttpSensorParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for creating a new HTTP sensor. </summary> </member> <member name="M:PrtgAPI.Parameters.HttpSensorParameters.#ctor(System.String,System.String,PrtgAPI.HttpRequestMethod,System.Int32,System.String,System.Boolean,System.String,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.HttpSensorParameters"/> class. </summary> <param name="url">The URL to monitor.</param> <param name="sensorName">The name to use for the sensor.</param> <param name="requestMethod">The HTTP request method to use.</param> <param name="timeout">The duration (in seconds) this sensor can run for before timing out. This value must be between 1-900.</param> <param name="postData">Data to include in requests when the HTTP request method is <see cref="F:PrtgAPI.HttpRequestMethod.POST"/>.</param> <param name="useCustomPostContent">Whether to use a custom content type in POST requests.</param> <param name="postContentType">The custom content type to use in POST requests.</param> <param name="useSNIFromUrl">Whether the Server Name Indication should be derived from the specified <see cref="P:PrtgAPI.Parameters.HttpSensorParameters.Url"/>, or from the parent device.</param> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.Url"> <summary> Gets or sets the URL to monitor. If a protocol is not specified, HTTP is used. </summary> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.Timeout"> <summary> Gets or sets the duration (in seconds) this sensor can run for before timing out. This value must be between 1-900. </summary> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.HttpRequestMethod"> <summary> Gets or sets the HTTP Request Method to use for requesting the <see cref="P:PrtgAPI.Parameters.HttpSensorParameters.Url"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.PostData"> <summary> Gets or sets the data to include in POST requests. Applies when <see cref="P:PrtgAPI.Parameters.HttpSensorParameters.HttpRequestMethod"/> is <see cref="F:PrtgAPI.HttpRequestMethod.POST"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.UseCustomPostContent"> <summary> Gets or sets whether POST requests should use a custom content type. If false, content type "application/x-www-form-urlencoded" will be used. </summary> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.PostContentType"> <summary> Gets or sets a custom content type to use for POST requests. </summary> </member> <member name="P:PrtgAPI.Parameters.HttpSensorParameters.UseSNIFromUrl"> <summary> Gets or sets whether the Server Name Indication is inherited from the parent device, or derived from the specified <see cref="P:PrtgAPI.Parameters.HttpSensorParameters.Url"/>. </summary> </member> <member name="T:PrtgAPI.Parameters.PropertyParameter"> <summary> Represents a single parameter for modifying an <see cref="T:PrtgAPI.ObjectProperty"/>. </summary> </member> <member name="M:PrtgAPI.Parameters.PropertyParameter.#ctor(PrtgAPI.ObjectProperty,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.PropertyParameter"/> class. </summary> <param name="property">The property to process.</param> <param name="value">The value to set the specified <paramref name="property"/> to.</param> </member> <member name="T:PrtgAPI.Parameters.BaseMultiActionParameters"> <summary> Base class for all parameters that perform an action against a PRTG server pertaining to one or more objects in a single request. </summary> </member> <member name="M:PrtgAPI.Parameters.BaseMultiActionParameters.#ctor(System.Int32[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.BaseActionParameters"/> class. </summary> <param name="objectIds">The IDs of the objects these parameters should apply to.</param> </member> <member name="P:PrtgAPI.Parameters.BaseMultiActionParameters.ObjectIds"> <summary> Gets or sets the IDs of the objects these parameters should apply to. </summary> </member> <member name="M:PrtgAPI.Parameters.BaseSetObjectPropertyParameters`1.RemoveDuplicateParameters"> <summary> Searches this object's <see cref="P:PrtgAPI.Parameters.BaseSetObjectPropertyParameters`1.CustomParameters"/> for any objects with a duplicate <see cref="P:PrtgAPI.Parameters.CustomParameter.Name"/> and removes all but the last one. </summary> </member> <member name="T:PrtgAPI.Parameters.ContainerSensorParameters"> <summary> <para type="description">Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding new <see cref="T:PrtgAPI.Sensor"/> objects, capable of functioning as both a <see cref="T:System.Collections.Generic.Dictionary`2"/> and a secondary container type.</para> </summary> </member> <member name="M:PrtgAPI.Parameters.ContainerSensorParameters.#ctor(System.String,System.String,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ContainerSensorParameters"/> class. </summary> <param name="sensorName">The name to use for this sensor.</param> <param name="sensorType">The type of sensor these parameters will create.</param> <param name="trimName">Whether to trim trailing underscores when doing parameter name lookups.</param> </member> <member name="P:PrtgAPI.Parameters.ContainerSensorParameters.SensorType"> <summary> Gets or sets the type of sensor these parameters will create. </summary> </member> <member name="P:PrtgAPI.Parameters.ContainerSensorParameters.Item(System.String)"> <summary> Gets or sets the value associated with the specified parameter. </summary> <param name="name">The name of the parameter to get or set.</param> <returns>When getting, if the specified parameter exiasts, the value of that parameter. If the parameter does not exist, an <see cref="T:System.InvalidOperationException"/> will be thrown.</returns> </member> <member name="T:PrtgAPI.Parameters.IMultiTargetParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> capable of targeting multiple objects in a single request. </summary> </member> <member name="T:PrtgAPI.Parameters.IParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.IParameters.Cookie"> <summary> Specifies whether to use a stored Cookie for authentication requests. If this value is false, authentication will be performed with a username and password/passhash. </summary> </member> <member name="P:PrtgAPI.Parameters.IParameters.Item(PrtgAPI.Parameter)"> <summary> Gets or sets a <see cref="T:PrtgAPI.Parameter"/> for use in a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/>. </summary> <param name="parameter">The parameter to retrieve or modify.</param> <returns>The value of the specified parameter. If the parameter does not exist, null.</returns> </member> <member name="M:PrtgAPI.Parameters.IParameters.GetParameters"> <summary> Retrieves the underlying dictionary of parameters stored in this object. </summary> <returns>The underlying dictionary of parameters.</returns> </member> <member name="T:PrtgAPI.Parameters.LogParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.Log"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.LogParameters.#ctor(System.Nullable{System.Int32},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.LogParameters"/> class for retrieving logs between two time periods. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is null or 0, logs will be retrieved from the root group.</param> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> </member> <member name="M:PrtgAPI.Parameters.LogParameters.#ctor(System.Nullable{System.Int32},PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.LogParameters"/> class for retrieving logs from a standard time period. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is null or 0, logs will be retrieved from the root group.</param> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered from newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> </member> <member name="P:PrtgAPI.Parameters.LogParameters.ObjectId"> <summary> Gets or sets the ID of the object these parameters should apply to. </summary> </member> <member name="P:PrtgAPI.Parameters.LogParameters.StartDate"> <summary> Gets or sets the start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time. </summary> </member> <member name="P:PrtgAPI.Parameters.LogParameters.EndDate"> <summary> Gets or sets the end date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs. </summary> </member> <member name="P:PrtgAPI.Parameters.LogParameters.Status"> <summary> Gets or sets log event types to retrieve records for. If no types are specified, all record types will be retrieved. </summary> </member> <member name="P:PrtgAPI.Parameters.LogParameters.RecordAge"> <summary> Gets or sets the time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered from newest to oldest. </summary> </member> <member name="T:PrtgAPI.Parameters.BaseActionParameters"> <summary> Base class for all parameters that perform an action against a PRTG server pertaining to a specific object. </summary> </member> <member name="M:PrtgAPI.Parameters.BaseActionParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.BaseActionParameters"/> class. </summary> <param name="objectOrId">The object or ID of the object these parameters should apply to.</param> </member> <member name="P:PrtgAPI.Parameters.BaseActionParameters.ObjectId"> <summary> Gets or sets the ID of the object these parameters should apply to. </summary> </member> <member name="T:PrtgAPI.Parameters.DynamicSensorParameters"> <summary> Represents a dynamic set of raw parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for creating a new sensor. </summary> </member> <member name="P:PrtgAPI.Parameters.DynamicSensorParameters.Targets"> <summary> Provides access to all sensor targets identified for this object. </summary> </member> <member name="P:PrtgAPI.Parameters.DynamicSensorParameters.Source"> <summary> Gets or sets the source device these parameters were derived from. If these parameters were not derived from a specific device this value is null. </summary> </member> <member name="M:PrtgAPI.Parameters.DynamicSensorParameters.Lock"> <summary> Locks this object's parameters, preventing new parameters from being added via its indexer. If an attempt is made to set a nonexistant parameter while this object is locked, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> </member> <member name="M:PrtgAPI.Parameters.DynamicSensorParameters.Unlock"> <summary> Unlocks this object's parameters, allowing new parameters to be added via its indexer. Attempting to retrieve the value of a nonexistant parameter will generate an <see cref="T:System.InvalidOperationException"/>. </summary> </member> <member name="M:PrtgAPI.Parameters.DynamicSensorParameters.IsLocked"> <summary> Indicates whether this object allows new properties to be added via its indexer. </summary> <returns>Whether new properties can be added</returns> </member> <member name="M:PrtgAPI.Parameters.DynamicSensorParameters.Contains(System.String,System.Boolean)"> <summary> Determines whether a parameter is in the underlying parameter set. </summary> <param name="name">The name of the parameter to locate.</param> <param name="ignoreUnderscore">Specifies whether to ignore trailing underscores of both names in the comparison.</param> <returns>True if any parameters exist with the specified name; otherwise false.</returns> </member> <member name="M:PrtgAPI.Parameters.DynamicSensorParameters.Remove(System.String,System.Boolean)"> <summary> Removes all occurrences of a specified parameter from the underlying parameter set. Applies regardless of whether this object <see cref="M:PrtgAPI.Parameters.DynamicSensorParameters.IsLocked"/>. </summary> <param name="name">The name of the parameter to remove.</param> <param name="ignoreUnderscore">Specifies whether to ignore trailing underscores of both names in the comparison.</param> <returns>True if one or more items were successfully removed. If no items exist with the specified name, this method returns false.</returns> </member> <member name="M:PrtgAPI.Parameters.DynamicSensorParameters.GetMetaObject(System.Linq.Expressions.Expression)"> <summary> Provides access to the <see cref="T:System.Dynamic.DynamicMetaObject"/> that dispatches to this object's dynamic members. </summary> <param name="parameter">The expression that represents the <see cref="T:System.Dynamic.DynamicMetaObject"/> to dispatch to the dynamic members.</param> <returns>The <see cref="T:System.Dynamic.DynamicMetaObject"/> that dispatches to this object's dynamic members.</returns> </member> <member name="P:PrtgAPI.Parameters.CloneParameters.TargetId"> <summary> The parent to clone the specified object ID to. </summary> </member> <member name="T:PrtgAPI.Parameters.NewDeviceParameters"> <summary> <para type="description">Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding new <see cref="T:PrtgAPI.Device"/> objects.</para> </summary> </member> <member name="P:PrtgAPI.Parameters.NewDeviceParameters.Host"> <summary> Gets or sets the IP Address or HostName to use to connect to this device. </summary> </member> <member name="P:PrtgAPI.Parameters.NewDeviceParameters.IPVersion"> <summary> Gets or sets the internet protocol version to use to connect to this device. </summary> </member> <member name="P:PrtgAPI.Parameters.NewDeviceParameters.AutoDiscoveryMode"> <summary> Gets or sets how thoroughly PRTG should scan for compatible sensor types when performing an auto-discovery. </summary> </member> <member name="P:PrtgAPI.Parameters.NewDeviceParameters.AutoDiscoverySchedule"> <summary> Gets or sets how often auto-discovery operations should be performed to create new sensors. </summary> </member> <member name="P:PrtgAPI.Parameters.NewDeviceParameters.DeviceTemplates"> <summary> Gets or sets the device templates to use when performing an auto-discovery. If <see cref="F:PrtgAPI.AutoDiscoveryMode.Automatic"/> or <see cref="F:PrtgAPI.AutoDiscoveryMode.AutomaticDetailed"/> is specified, all templates will be used and this parameter will be ignored.<para/> If <see cref="F:PrtgAPI.AutoDiscoveryMode.AutomaticTemplate"/> is specified, at least one template must be specified. </summary> </member> <member name="M:PrtgAPI.Parameters.NewDeviceParameters.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.NewDeviceParameters"/> class. </summary> <param name="name">The name to use for this device.</param> <param name="host">The IP Address or HostName to use to connect to this device. If the host is not specified, the <paramref name="name"/> is used as the host.</param> </member> <member name="T:PrtgAPI.Parameters.NewGroupParameters"> <summary> <para type="description">Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding new <see cref="T:PrtgAPI.Group"/> objects.</para> </summary> </member> <member name="M:PrtgAPI.Parameters.NewGroupParameters.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.NewGroupParameters"/> class. </summary> <param name="name">The name to use for this group.</param> </member> <member name="T:PrtgAPI.Parameters.NewObjectParameters"> <summary> Base class for all parameters that create new table objects. </summary> </member> <member name="P:PrtgAPI.Parameters.NewObjectParameters.ConstructorScope"> <summary> Protects the constructor from setting dependent properties when initializing the object. </summary> </member> <member name="P:PrtgAPI.Parameters.NewObjectParameters.Name"> <summary> Gets or sets the name to use for this object. </summary> </member> <member name="P:PrtgAPI.Parameters.NewObjectParameters.Tags"> <summary> Gets or sets the tags that should be applied to this object. Certain object types and subtypes (such as sensors) may have default tag values.<para/> If this value is null, the default tags based on sensor type will be used. </summary> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameter(PrtgAPI.ObjectProperty)"> <summary> Retrieves the value of a property from the underlying parameter set. </summary> <param name="property">The property whose value should be retrieved</param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterEnumXml``1(PrtgAPI.ObjectProperty)"> <summary> Retrieves the original value of a serialized enum property from the underlying parameter set. </summary> <typeparam name="T">The type of enum to retrieve.</typeparam> <param name="property">The property whose value should be retrieved.</param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterEnumXml``1(System.String)"> <summary> Retrieves the original value of a serialized enum property from the underlying parameter set, using its raw serialized name. </summary> <typeparam name="T">The type of enum to retrieve.</typeparam> <param name="name">The raw name of the parameter</param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterBool(PrtgAPI.ObjectProperty)"> <summary> Retrieves the original value of a serialized boolean property from the underlying parameter set. </summary> <param name="property">The property whose value should be retrieved.</param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterBool(System.String)"> <summary> Retrieves the original value of a serialized boolean property from the underlying parameter set, using its raw serialized name. </summary> <param name="name">The raw name of the parameter</param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterArray(PrtgAPI.ObjectProperty,System.Char)"> <summary> Retrieves the original value of a serialized array property from the underlying parameter set. </summary> <param name="property">The parameter to retrieve</param> <param name="delim">The value that was used to combine the array when originally serialized via <see cref="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterArray(PrtgAPI.ObjectProperty,System.String[],System.Char)"/> </param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterArray(System.String,System.Char)"> <summary> Retrieves the original value of a serialized array property from the underlying parameter set, using its raw serialized name. </summary> <param name="name">The raw name of the parameter</param> <param name="delim">The value that was used to combine the array when originally serialized via <see cref="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterArray(System.String,System.String[],System.Char)"/> </param> <returns>The original unserialized value.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.GetCustomParameterInternal(System.String)"> <summary> Retrieves a parameter from the underlying parameter set using its raw, serialized name. If set does not contain a value for the specified parameter, null will be returned. </summary> <param name="name">The raw name of the parameter</param> <returns>The parameter's corresponding value. If the parameter was not found in the set, this value is null</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameter(PrtgAPI.ObjectProperty,System.Object)"> <summary> Stores the value of a property in the underlying parameter set. </summary> <param name="property">The property whose value should be stored.</param> <param name="value">The value to serialize.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterEnumXml``1(PrtgAPI.ObjectProperty,``0)"> <summary> Stores the serialized value of an enum property in the underlying parameter set. </summary> <typeparam name="T">The type of enum to serialize.</typeparam> <param name="property">The property whose value should be stored.</param> <param name="enum">The enum to serialize.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterEnumXml``1(System.String,``0)"> <summary> Stores the serialized value of an enum property in the underlying parameter set, using its raw serialized name. </summary> <typeparam name="T">The type of enum to serialize.</typeparam> <param name="name">The raw name of the parameter.</param> <param name="enum">The enum to serialize.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterBool(PrtgAPI.ObjectProperty,System.Nullable{System.Boolean})"> <summary> Stores the serialized value of a boolean property in the underlying parameter set. </summary> <param name="property">The property whose value should be stored.</param> <param name="value">The bool to serialize.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterBool(System.String,System.Nullable{System.Boolean})"> <summary> Stores the serialized value of a boolean property in the underlying parameter set, using its raw serialized name. </summary> <param name="name">The raw name of the parameter.</param> <param name="value">The bool to serialize.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterArray(PrtgAPI.ObjectProperty,System.String[],System.Char)"> <summary> Stores the serialized value of an array property in the underlying parameter set. </summary> <param name="property">The property whose value should be stored.</param> <param name="value">The array to serialize.</param> <param name="delim">The character that should delimit each array entry.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterArray(System.String,System.String[],System.Char)"> <summary> Stores the serialized value of an array property in the underlying parameter set, using its raw serialized name. </summary> <param name="name">The raw name of the parameter.</param> <param name="value">The array to serialize.</param> <param name="delim">The character that should delimit each array entry.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.SetCustomParameterInternal(System.String,System.Object)"> <summary> Stores the value of a property in the underlying set, using its raw serialized name. </summary> <param name="name">The raw name of the parameter.</param> <param name="value">The value to store.</param> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.RemoveCustomParameter(PrtgAPI.ObjectProperty)"> <summary> Removes a parameter from the underlying parameter set. </summary> <param name="property">The name of the parameter to remove.</param> <returns>True if the specified parameter was found and removed. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.RemoveCustomParameter(PrtgAPI.ObjectPropertyInternal)"> <summary> Removes a parameter from the underlying parameter set. </summary> <param name="property">The name of the parameter to remove.</param> <returns>True if the specified parameter was found and removed. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.Parameters.NewObjectParameters.RemoveCustomParameterInternal(System.String)"> <summary> Removes a parameter from the underlying parameter set. </summary> <param name="name">The name of the parameter to remove.</param> <returns>True if the specified parameter was found and removed. Otherwise, false.</returns> </member> <member name="T:PrtgAPI.Parameters.WmiServiceSensorParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for creating a new WMI Service sensor. </summary> </member> <member name="M:PrtgAPI.Parameters.WmiServiceSensorParameters.#ctor(PrtgAPI.Targets.WmiServiceTarget,System.Boolean,System.Boolean,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.WmiServiceSensorParameters"/> class for creating a new set of parameters specifying a single service. </summary> <param name="service">The WMI Service to create a sensor for.</param> <param name="startStopped">Whether PRTG should automatically restart the service in the event it is stopped.</param> <param name="notifyChanged">Whether PRTG should trigger any <see cref="F:PrtgAPI.TriggerType.Change"/> notification triggers defined on the sensor in the event PRTG restarts it.</param> <param name="monitorPerformance">Whether to collect performance metrics for the service.</param> </member> <member name="M:PrtgAPI.Parameters.WmiServiceSensorParameters.#ctor(System.Collections.Generic.IEnumerable{PrtgAPI.Targets.WmiServiceTarget},System.Boolean,System.Boolean,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.WmiServiceSensorParameters"/> class for creating a new set of parameters specifying one or more services. </summary> <param name="services">One or more WMI Services to create sensors for.</param> <param name="startStopped">Whether PRTG should automatically restart the services in the event they are stopped.</param> <param name="notifyChanged">Whether PRTG should trigger any <see cref="F:PrtgAPI.TriggerType.Change"/> notification triggers defined on the sensors in the event PRTG restarts them.</param> <param name="monitorPerformance">Whether to collect performance metrics for each service.</param> </member> <member name="P:PrtgAPI.Parameters.WmiServiceSensorParameters.Services"> <summary> Gets or sets a list of services to create sensors for. </summary> </member> <member name="P:PrtgAPI.Parameters.WmiServiceSensorParameters.StartStopped"> <summary> Gets or sets whether PRTG should automatically restart the services in the event they are stopped. </summary> </member> <member name="P:PrtgAPI.Parameters.WmiServiceSensorParameters.NotifyChanged"> <summary> Gets or sets whether PRTG should trigger any <see cref="F:PrtgAPI.TriggerType.Change"/> notification triggers defined on the sensors in the event PRTG restarts them. </summary> </member> <member name="P:PrtgAPI.Parameters.WmiServiceSensorParameters.MonitorPerformance"> <summary> Gets or sets whether to collect performance metrics for each service. </summary> </member> <member name="T:PrtgAPI.Parameters.ExeXmlSensorParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for creating a new EXE/Script Advanced sensor. </summary> </member> <member name="M:PrtgAPI.Parameters.ExeXmlSensorParameters.#ctor(PrtgAPI.Targets.ExeFileTarget,System.String,System.String,System.Boolean,System.Boolean,System.String,System.Int32,PrtgAPI.DebugMode)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ExeXmlSensorParameters"/> class. </summary> <param name="exeFile">The EXE or Script this sensor will execute. Must be located in the Custom Sensors\EXEXML folder on the target device's probe server.</param> <param name="sensorName">The name to use for the sensor.</param> <param name="exeParameters">Parameters to pass to the <paramref name="exeFile"/> on each scan.</param> <param name="setExeEnvironmentVariables">Whether PRTG Environment Variables (%host, %windowsusername, etc) will be available as System Environment Variables inside the EXE/Script.</param> <param name="useWindowsAuthentication">Whether to use the Windows Credentials of the parent device to execute the specified EXE/Script file. If custom credentials are not used, the file will be executed under the credentials of the PRTG Probe Service.</param> <param name="mutex">The mutex name to use. All sensors with the same mutex name will be executed sequentially, reducing resource utilization.</param> <param name="timeout">The duration (in seconds) this sensor can run for before timing out. This value must be between 1-900.</param> <param name="debugMode">Indicates whether to store raw EXE/Script XML/JSON output for debugging purposes.</param> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.ExeFile"> <summary> Gets or sets the EXE or Script file to execute on each scan. </summary> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.ExeParameters"> <summary> Gets or sets parameters to pass to the <see cref="P:PrtgAPI.Parameters.ExeXmlSensorParameters.ExeFile"/> on each scan. </summary> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.SetExeEnvironmentVariables"> <summary> Gets or sets whether PRTG Environment Variables (%host, %windowsusername, etc) will be available as System Environment Variables inside the EXE/Script. </summary> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.UseWindowsAuthentication"> <summary> Gets or sets whether to use the Windows Credentials of the parent device to execute the specified EXE/Script file. If custom credentials are not used, the file will be executed under the credentials of the PRTG Probe Service. </summary> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.Mutex"> <summary> Gets or sets the mutex name to use. All sensors with the same mutex name will be executed sequentially, reducing resource utilization. </summary> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.Timeout"> <summary> Gets or sets the duration (in seconds) this sensor can run for before timing out. This value must be between 1-900. </summary> </member> <member name="P:PrtgAPI.Parameters.ExeXmlSensorParameters.DebugMode"> <summary> Gets or sets whether to store raw EXE/Script XML/JSON output for debugging purposes. </summary> </member> <member name="T:PrtgAPI.Parameters.NewSensorParameters"> <summary> <para type="description">Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding new <see cref="T:PrtgAPI.Sensor"/> objects.</para> </summary> </member> <member name="P:PrtgAPI.Parameters.NewSensorParameters.Priority"> <summary> Gets or sets the priority of the sensor, controlling how the sensor is displayed in table lists.<para/> If this value is null, the default value <see cref="F:PrtgAPI.Priority.Three"/> will be used. </summary> </member> <member name="P:PrtgAPI.Parameters.NewSensorParameters.InheritTriggers"> <summary> Gets or sets whether to inherit notification triggers from the parent object.<para/> If this value is null, the default value "true" will be used. </summary> </member> <member name="P:PrtgAPI.Parameters.NewSensorParameters.InheritInterval"> <summary> Gets or sets whether this sensor's scanning interval settings are inherited from its parent.<para/> If this value is null, the default value "true" will be used. </summary> </member> <member name="P:PrtgAPI.Parameters.NewSensorParameters.Interval"> <summary> Gets or sets the scanning interval of the sensor. Applies only when <see cref="P:PrtgAPI.Parameters.NewSensorParameters.InheritInterval"/> is false.<para/> If this value is null, the default value <see cref="F:PrtgAPI.ScanningInterval.SixtySeconds"/> will be used. </summary> </member> <member name="P:PrtgAPI.Parameters.NewSensorParameters.IntervalErrorMode"> <summary> Gets or sets the number of scanning intervals the sensor will wait before entering a <see cref="F:PrtgAPI.Status.Down"/> state when the sensor reports an error.<para/> If this value is null, the default value <see cref="F:PrtgAPI.IntervalErrorMode.OneWarningThenDown"/> will be used. </summary> </member> <member name="P:PrtgAPI.Parameters.NewSensorParameters.DynamicType"> <summary> Specifies whether the resulting sensor type is dynamically determined by the parameters included in the request.<para/> If this property is true, PrtgAPI will relax its sensor resolution mechanism to ensure the resultant object is retrieved. </summary> </member> <member name="M:PrtgAPI.Parameters.NewSensorParameters.#ctor(System.String,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.NewSensorParameters"/> class. </summary> <param name="name">The name to use for this sensor.</param> <param name="sensorType">The type of sensor these parameters will create.</param> </member> <member name="T:PrtgAPI.Parameters.RawSensorParameters"> <summary> Represents raw parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for creating a new sensor. </summary> </member> <member name="M:PrtgAPI.Parameters.RawSensorParameters.Contains(System.String)"> <summary> Determines whether a parameter is in the underlying parameter set. </summary> <param name="name">The name of the parameter to locate.</param> <returns>True if any parameters exist with the specified name; otherwise false.</returns> </member> <member name="M:PrtgAPI.Parameters.RawSensorParameters.Remove(System.String)"> <summary> Removes all occurrences of a specified parameter from the underlying parameter set. </summary> <param name="name">The name of the parameter to remove.</param> <returns>True if one or more items were successfully removed. If no items exist with the specified name, this method returns false.</returns> </member> <member name="M:PrtgAPI.Parameters.RawSensorParameters.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.RawSensorParameters"/> class. </summary> <param name="sensorName">The name to use for this sensor.</param> <param name="sensorType">The type of sensor these parameters will create.</param> </member> <member name="P:PrtgAPI.Parameters.RawSensorParameters.Parameters"> <summary> Gets the underlying custom parameters of this object. </summary> </member> <member name="T:PrtgAPI.Parameters.SensorParametersInternal"> <summary> Base class for defining type-safe parameter types used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding new <see cref="T:PrtgAPI.Sensor"/> objects. </summary> </member> <member name="P:PrtgAPI.Parameters.SensorParametersInternal.Source"> <summary> Gets the source device these parameters were derived from. If these parameters were not derived from a specific device this value is null. </summary> </member> <member name="M:PrtgAPI.Parameters.SensorParametersInternal.#ctor(System.String,PrtgAPI.SensorType)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SensorParametersInternal"/> class. </summary> <param name="sensorName">The name to use for this sensor.</param> <param name="sensorType">The type of sensor these parameters will create.</param> </member> <member name="P:PrtgAPI.Parameters.SensorParametersInternal.SensorType"> <summary> Gets or sets the type of sensor these parameters will create. </summary> </member> <member name="T:PrtgAPI.Parameters.ChangeTriggerParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding/modifying <see cref="F:PrtgAPI.TriggerType.Change"/> <see cref="T:PrtgAPI.NotificationTrigger"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.ChangeTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ChangeTriggerParameters"/> class for creating a new notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> </member> <member name="M:PrtgAPI.Parameters.ChangeTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ChangeTriggerParameters"/> class for editing an existing notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger is applied to. Note: if the trigger is inherited, the ParentId should be specified.</param> <param name="triggerId">The sub ID of the trigger on its parent object.</param> </member> <member name="M:PrtgAPI.Parameters.ChangeTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ChangeTriggerParameters"/> class for creating a new trigger from an existing <see cref="F:PrtgAPI.TriggerType.Change"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="M:PrtgAPI.Parameters.ChangeTriggerParameters.#ctor(PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ChangeTriggerParameters"/> class for editing an existing <see cref="F:PrtgAPI.TriggerType.Change"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="T:PrtgAPI.Parameters.SpeedTriggerParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding/modifying <see cref="F:PrtgAPI.TriggerType.Speed"/> <see cref="T:PrtgAPI.NotificationTrigger"/> objects. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.OffNotificationAction"> <summary> Gets or sets the <see cref="T:PrtgAPI.NotificationAction"/> to execute when the trigger's active state clears. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.Channel"> <summary> Gets or sets the channel of the sensor this trigger should apply to. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.Latency"> <summary> Gets or sets the delay (in seconds) this trigger should wait before executing its <see cref="P:PrtgAPI.Parameters.TriggerParameters.OnNotificationAction"/> once activated. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.Condition"> <summary> Gets or sets the condition that controls when the <see cref="P:PrtgAPI.Parameters.SpeedTriggerParameters.Threshold"/> is activated. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.Threshold"> <summary> Gets or sets the value which, once reached, will cause this trigger will activate. Used in conjunction with <see cref="P:PrtgAPI.Parameters.SpeedTriggerParameters.Condition"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.UnitTime"> <summary> Gets or sets the time component of the data rate that causes this trigger to activate. </summary> </member> <member name="P:PrtgAPI.Parameters.SpeedTriggerParameters.UnitSize"> <summary> Gets or sets the unit component of the data rate that causes this trigger to activate. </summary> </member> <member name="M:PrtgAPI.Parameters.SpeedTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SpeedTriggerParameters"/> class for creating a new notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> </member> <member name="M:PrtgAPI.Parameters.SpeedTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SpeedTriggerParameters"/> class for editing an existing notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger is applied to. Note: if the trigger is inherited, the ParentId should be specified.</param> <param name="triggerId">The sub ID of the trigger on its parent object.</param> </member> <member name="M:PrtgAPI.Parameters.SpeedTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SpeedTriggerParameters"/> class for creating a new trigger from an existing <see cref="F:PrtgAPI.TriggerType.Speed"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="M:PrtgAPI.Parameters.SpeedTriggerParameters.#ctor(PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SpeedTriggerParameters"/> class for editing an existing <see cref="F:PrtgAPI.TriggerType.Speed"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="T:PrtgAPI.Parameters.StateTriggerParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding/modifying <see cref="F:PrtgAPI.TriggerType.State"/> <see cref="T:PrtgAPI.NotificationTrigger"/> objects. </summary> </member> <member name="P:PrtgAPI.Parameters.StateTriggerParameters.OffNotificationAction"> <summary> Gets or sets the <see cref="T:PrtgAPI.NotificationAction"/> to execute when the trigger's active state clears. </summary> </member> <member name="P:PrtgAPI.Parameters.StateTriggerParameters.EscalationNotificationAction"> <summary> Gets or sets the <see cref="T:PrtgAPI.NotificationAction"/> to fire if this trigger remains in an active state for an extended period of time. </summary> </member> <member name="P:PrtgAPI.Parameters.StateTriggerParameters.Latency"> <summary> Gets or sets the delay (in seconds) this trigger should wait before executing its <see cref="P:PrtgAPI.Parameters.TriggerParameters.OnNotificationAction"/> once activated. </summary> </member> <member name="P:PrtgAPI.Parameters.StateTriggerParameters.EscalationLatency"> <summary> Gets or sets the delay (in seconds) this trigger should wait before executing its <see cref="P:PrtgAPI.Parameters.StateTriggerParameters.EscalationNotificationAction"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.StateTriggerParameters.RepeatInterval"> <summary> Gets or sets the interval (in minutes) with which the <see cref="P:PrtgAPI.Parameters.StateTriggerParameters.EscalationNotificationAction"/> should be re-executed. </summary> </member> <member name="P:PrtgAPI.Parameters.StateTriggerParameters.State"> <summary> Gets or sets the object state that will cause this trigger to activate. </summary> </member> <member name="M:PrtgAPI.Parameters.StateTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.StateTriggerParameters"/> class for creating a new notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> </member> <member name="M:PrtgAPI.Parameters.StateTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.StateTriggerParameters"/> class for editing an existing notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger is applied to. Note: if the trigger is inherited, the ParentId should be specified.</param> <param name="triggerId">The sub ID of the trigger on its parent object.</param> </member> <member name="M:PrtgAPI.Parameters.StateTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.StateTriggerParameters"/> class for creating a new trigger from an existing <see cref="F:PrtgAPI.TriggerType.State"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="M:PrtgAPI.Parameters.StateTriggerParameters.#ctor(PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.StateTriggerParameters"/> class for editing an existing <see cref="F:PrtgAPI.TriggerType.State"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="T:PrtgAPI.Parameters.ThresholdTriggerParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding/modifying <see cref="F:PrtgAPI.TriggerType.Threshold"/> <see cref="T:PrtgAPI.NotificationTrigger"/> objects. </summary> </member> <member name="P:PrtgAPI.Parameters.ThresholdTriggerParameters.OffNotificationAction"> <summary> Gets or sets the <see cref="T:PrtgAPI.NotificationAction"/> to execute when the trigger's active state clears. </summary> </member> <member name="P:PrtgAPI.Parameters.ThresholdTriggerParameters.Latency"> <summary> Gets or sets the delay (in seconds) this trigger should wait before executing its <see cref="P:PrtgAPI.Parameters.TriggerParameters.OnNotificationAction"/> once activated. </summary> </member> <member name="P:PrtgAPI.Parameters.ThresholdTriggerParameters.Threshold"> <summary> Gets or sets the value which, once reached, will cause this trigger will activate. Used in conjunction with <see cref="P:PrtgAPI.Parameters.ThresholdTriggerParameters.Condition"/>. </summary> </member> <member name="P:PrtgAPI.Parameters.ThresholdTriggerParameters.Condition"> <summary> Gets or sets the condition that controls when the <see cref="P:PrtgAPI.Parameters.ThresholdTriggerParameters.Threshold"/> is activated. </summary> </member> <member name="P:PrtgAPI.Parameters.ThresholdTriggerParameters.Channel"> <summary> Gets or sets the channel of the sensor this trigger should apply to. </summary> </member> <member name="M:PrtgAPI.Parameters.ThresholdTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ThresholdTriggerParameters"/> class for creating a new notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> </member> <member name="M:PrtgAPI.Parameters.ThresholdTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ThresholdTriggerParameters"/> class for editing an existing notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger is applied to. Note: if the trigger is inherited, the ParentId should be specified.</param> <param name="triggerId">The sub ID of the trigger on its parent object.</param> </member> <member name="M:PrtgAPI.Parameters.ThresholdTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ThresholdTriggerParameters"/> class for creating a new trigger from an existing <see cref="F:PrtgAPI.TriggerType.Threshold"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="M:PrtgAPI.Parameters.ThresholdTriggerParameters.#ctor(PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ThresholdTriggerParameters"/> class for editing an existing <see cref="F:PrtgAPI.TriggerType.Threshold"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="sourceTrigger">The notification trigger to modify.</param> </member> <member name="T:PrtgAPI.Parameters.TriggerParameters"> <summary> <para type="description">Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding/modifying <see cref="T:PrtgAPI.NotificationTrigger"/> objects.</para> </summary> </member> <member name="P:PrtgAPI.Parameters.TriggerParameters.ObjectId"> <summary> Gets the ID of the object this trigger applies to. </summary> </member> <member name="P:PrtgAPI.Parameters.TriggerParameters.SubId"> <summary> Gets the sub ID of the trigger these parameters apply to. If these parameters are being used to create a new trigger, this value is null. </summary> </member> <member name="P:PrtgAPI.Parameters.TriggerParameters.Action"> <summary> Gets whether these parameters will create a new trigger or modify an existing one. </summary> </member> <member name="P:PrtgAPI.Parameters.TriggerParameters.Type"> <summary> Gets the type of notification trigger these triggers will manipulate. </summary> </member> <member name="P:PrtgAPI.Parameters.TriggerParameters.OnNotificationAction"> <summary> Gets or sets the <see cref="T:PrtgAPI.NotificationAction"/> to execute when the trigger activates. </summary> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.#ctor(PrtgAPI.TriggerType,PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Nullable{System.Int32},PrtgAPI.ModifyAction)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> class. </summary> <param name="type">The type of notification trigger this object will manipulate.</param> <param name="objectOrId">The object or object ID the trigger will apply to.</param> <param name="subId">If this trigger is being edited, the trigger's sub ID. If the trigger is being added, this value is null.</param> <param name="action">Whether to add a new trigger or modify an existing one.</param> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.#ctor(PrtgAPI.TriggerType,PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.NotificationTrigger,PrtgAPI.ModifyAction)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.TriggerParameters"/> class for creating a new <see cref="T:PrtgAPI.NotificationTrigger"/> from an existing one. </summary> <param name="type">The type of notification trigger these parameters will manipulate.</param> <param name="objectOrId">The object or ID of the object the notification trigger will apply to.</param> <param name="sourceTrigger">The notification trigger whose properties should be used as the basis of this trigger.</param> <param name="action">Whether these parameters will create a new trigger or edit an existing one.</param> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.GetNotificationAction(PrtgAPI.TriggerProperty)"> <summary> Retrieves a <see cref="T:PrtgAPI.NotificationAction"/> from this object's <see cref="P:PrtgAPI.Parameters.TriggerParameters.Parameters"/>. If the specified action type does not exist, an empty notification action is returned. </summary> <param name="actionType">The type of notification action to retrieve.</param> <returns>If the notification action exists, the notification action. Otherwise, an empty notification action.</returns> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.SetNotificationAction(PrtgAPI.TriggerProperty,PrtgAPI.NotificationAction)"> <summary> Updates a <see cref="T:PrtgAPI.NotificationAction"/> in this object's <see cref="P:PrtgAPI.Parameters.TriggerParameters.Parameters"/>. If the notification action is null, an empty notification action is inserted. </summary> <param name="actionType">The type of notification action to insert.</param> <param name="value">The notification action to insert. If this value is null, an empty notification action is inserted.</param> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.GetCustomParameterValue(PrtgAPI.TriggerProperty)"> <summary> Retrieves the value of a trigger property from this object's <see cref="P:PrtgAPI.Parameters.TriggerParameters.Parameters"/>. </summary> <param name="property">The property to retrieve.</param> <returns>The value of this property. If the property does not exist, this method returns null.</returns> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.UpdateCustomParameter(PrtgAPI.TriggerProperty,System.Object,System.Boolean)"> <summary> Updates the value of a trigger property in this object's <see cref="P:PrtgAPI.Parameters.TriggerParameters.Parameters"/>. If the trigger property does not exist, it will be added. </summary> <param name="property">The property whose value will be updated.</param> <param name="value">The value to insert.</param> <param name="requireValue">Indicates whether null is allowed for the specified property.</param> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.GetCustomParameterEnumXml``1(PrtgAPI.TriggerProperty)"> <summary> Retrieves the enum value of a trigger property from this object's <see cref="P:PrtgAPI.Parameters.TriggerParameters.Parameters"/> that has been stored using its XML representation. </summary> <typeparam name="T">The type of enum stored in the property</typeparam> <param name="property">The property to retrieve.</param> <returns>The value of this property. If the property does not exist, this method returns null.</returns> </member> <member name="M:PrtgAPI.Parameters.TriggerParameters.GetCustomParameterEnumInt``1(PrtgAPI.TriggerProperty)"> <summary> Retrieves the enum value of a trigger property from this object's <see cref="P:PrtgAPI.Parameters.TriggerParameters.Parameters"/> that has been stored as an integer. </summary> <typeparam name="T">The type of enum to retrieve.</typeparam> <param name="property">The trigger property whose value should be retrieved.</param> <returns>If the trigger property has a value, a value of type T. Otherwise, a null value of type T?</returns> </member> <member name="T:PrtgAPI.Parameters.NotificationActionParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.NotificationAction"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.NotificationActionParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.NotificationActionParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.NotificationActionParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.NotificationActionParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="T:PrtgAPI.Parameters.VolumeTriggerParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for adding/modifying <see cref="F:PrtgAPI.TriggerType.Volume"/> <see cref="T:PrtgAPI.NotificationTrigger"/> objects. </summary> </member> <member name="P:PrtgAPI.Parameters.VolumeTriggerParameters.Channel"> <summary> Gets or sets the channel of the sensor this trigger should apply to. </summary> </member> <member name="P:PrtgAPI.Parameters.VolumeTriggerParameters.Threshold"> <summary> Gets or sets the value which, once reached, will cause this trigger will activate. </summary> </member> <member name="P:PrtgAPI.Parameters.VolumeTriggerParameters.Period"> <summary> Gets or sets the time component of the volume limit that causes this trigger to activate. </summary> </member> <member name="P:PrtgAPI.Parameters.VolumeTriggerParameters.UnitSize"> <summary> Gets or sets the unit component of the volume limit that causes this trigger to activate. </summary> </member> <member name="M:PrtgAPI.Parameters.VolumeTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.VolumeTriggerParameters"/> class for creating a new notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> </member> <member name="M:PrtgAPI.Parameters.VolumeTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.VolumeTriggerParameters"/> class for editing an existing notification trigger. </summary> <param name="objectOrId">The object or object ID the trigger is applied to. Note: if the trigger is inherited, the ParentId should be specified.</param> <param name="triggerId">The sub ID of the trigger on its parent object.</param> </member> <member name="M:PrtgAPI.Parameters.VolumeTriggerParameters.#ctor(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.VolumeTriggerParameters"/> class for creating a new trigger from an existing <see cref="F:PrtgAPI.TriggerType.Volume"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="objectOrId">The object or object ID the trigger will apply to.</param> <param name="sourceTrigger">The notification trigger whose properties should be used.</param> </member> <member name="M:PrtgAPI.Parameters.VolumeTriggerParameters.#ctor(PrtgAPI.NotificationTrigger)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.VolumeTriggerParameters"/> class for editing an existing <see cref="F:PrtgAPI.TriggerType.Volume"/> <see cref="T:PrtgAPI.NotificationTrigger"/>. </summary> <param name="sourceTrigger">The notification trigger to modify.</param> </member> <member name="T:PrtgAPI.Parameters.ContentParameters`1"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving data with a known <see cref="P:PrtgAPI.Parameters.ContentParameters`1.Content"/> type. </summary> <typeparam name="T">The type of PRTG Object to retrieve.</typeparam> </member> <member name="P:PrtgAPI.Parameters.ContentParameters`1.Content"> <summary> Gets the type of content this request will retrieve. </summary> </member> <member name="P:PrtgAPI.Parameters.ContentParameters`1.Properties"> <summary> Gets the properties that will be retrieved for the objects returned from this request. </summary> </member> <member name="M:PrtgAPI.Parameters.ContentParameters`1.#ctor(PrtgAPI.Content)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ContentParameters`1"/> class. </summary> </member> <member name="T:PrtgAPI.Parameters.CustomParameter"> <summary> Allows inserting custom parameters not supported by PrtgAPI. </summary> </member> <member name="P:PrtgAPI.Parameters.CustomParameter.Name"> <summary> Gets or sets the name of the parameter. </summary> </member> <member name="P:PrtgAPI.Parameters.CustomParameter.Value"> <summary> Gets or sets the value of the parameter. </summary> </member> <member name="P:PrtgAPI.Parameters.CustomParameter.ParameterType"> <summary> Gets or sets how the <see cref="P:PrtgAPI.Parameters.CustomParameter.Value"/> should be formatted when it contains a value that is <see cref="T:System.Collections.IEnumerable"/>. </summary> </member> <member name="M:PrtgAPI.Parameters.CustomParameter.#ctor(System.String,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.CustomParameter"/> class. </summary> <param name="name">The name of the parameter.</param> <param name="value">The value of the parameter. The caller is responsible for ensuring the value and type contains the correct capitalization and is formatted corectly when converted <see cref="M:PrtgAPI.Parameters.CustomParameter.ToString"/>.</param> </member> <member name="M:PrtgAPI.Parameters.CustomParameter.#ctor(System.String,System.Object,PrtgAPI.ParameterType)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.CustomParameter"/> class with a specified parameter type. </summary> <param name="name">The name of the parameter</param> <param name="value">The value of the parameter. The caller is responsible for ensuring the value and type contains the correct capitalization and is formatted corectly when converted <see cref="M:PrtgAPI.Parameters.CustomParameter.ToString"/>.</param> <param name="parameterType">How the <paramref name="value"/> should be formatted if it contains a string.</param> </member> <member name="M:PrtgAPI.Parameters.CustomParameter.ToString"> <summary> Returns a string representation of the current object based on how it will be likely formatted when used in a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/>. </summary> <returns>The formatted representation of this parameter.</returns> </member> <member name="T:PrtgAPI.Parameters.ProbeParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.Probe"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.ProbeParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ProbeParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.ProbeParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.ProbeParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="T:PrtgAPI.Parameters.BaseParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/>. </summary> </member> <member name="M:PrtgAPI.Parameters.BaseParameters.GetParameters"> <summary> Retrieves the underlying dictionary of parameters stored in this object. </summary> <returns>The underlying dictionary of parameters.</returns> </member> <member name="P:PrtgAPI.Parameters.BaseParameters.Item(PrtgAPI.Parameter)"> <summary> Gets or sets a <see cref="T:PrtgAPI.Parameter"/> for use in a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/>. </summary> <param name="parameter">The parameter to retrieve or modify.</param> <returns>The value of the specified parameter. If the parameter does not exist, null.</returns> </member> <member name="T:PrtgAPI.Parameters.TableParameters`1"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving data stored in tables. </summary> <typeparam name="T">The type of PRTG Object to retrieve.</typeparam> </member> <member name="P:PrtgAPI.Parameters.TableParameters`1.SearchFilters"> <summary> Gets or sets a collection of search filters used to limit search results to those that match certain criteria. This property is self initializing. </summary> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.AddFilters(PrtgAPI.SearchFilter[])"> <summary> Adds one or more filters to the list of filters included in the parameter set. </summary> <param name="filters">One or more filters to add to the parameter set.</param> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.RemoveFilters(PrtgAPI.SearchFilter[])"> <summary> Removes one or filters from the list of filters included in the parameter set. </summary> <param name="filters">One or more filters to remove from the parameter set.</param> <returns>True if any filters were removed. otherwise, false.</returns> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.#ctor(PrtgAPI.Content)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.TableParameters`1"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.SetFilterValue(PrtgAPI.Property,System.Object)"> <summary> Sets the value of a filter for a property. </summary> <param name="property">The property to set the value of.</param> <param name="value">The value to filter for. If this value is null the filter will be removed.</param> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.GetFilterValue(PrtgAPI.Property)"> <summary> Retrieves the value of a filter for a property. </summary> <param name="property">The property to retrieve the value of.</param> <returns></returns> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.SetMultiParameterFilterValue``1(PrtgAPI.Property,``0[])"> <summary> Sets the value of a <see cref="F:PrtgAPI.ParameterType.MultiParameter"/> property. </summary> <typeparam name="TArray">The type of array to store.</typeparam> <param name="property">The property to set the value of.</param> <param name="value">The values to filter for. If this value is null the filters will be removed.</param> </member> <member name="M:PrtgAPI.Parameters.TableParameters`1.GetMultiParameterFilterValue``1(PrtgAPI.Property)"> <summary> Retrieves the value of a <see cref="F:PrtgAPI.ParameterType.MultiParameter"/> property. </summary> <typeparam name="TArray">The type of array that was previously stored.</typeparam> <param name="property">The property to retrieve the value of.</param> <returns></returns> </member> <member name="T:PrtgAPI.Parameters.DeviceParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.Device"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.DeviceParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.DeviceParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.DeviceParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.DeviceParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="T:PrtgAPI.Parameters.GroupParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.Group"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.GroupParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.GroupParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.GroupParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.GroupParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="T:PrtgAPI.Parameters.SensorParameters"> <summary> Represents parameters used to construct a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> for retrieving <see cref="T:PrtgAPI.Sensor"/> objects. </summary> </member> <member name="M:PrtgAPI.Parameters.SensorParameters.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SensorParameters"/> class. </summary> </member> <member name="M:PrtgAPI.Parameters.SensorParameters.#ctor(PrtgAPI.SearchFilter[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Parameters.SensorParameters"/> class with one or more conditions to filter results by. </summary> <param name="filters">A list of conditions to filter results by.</param> </member> <member name="P:PrtgAPI.Parameters.SensorParameters.Status"> <summary> Gets or sets a collection of search filters used to limit results according to one or more sensor statuses. </summary> </member> <member name="M:PrtgAPI.Request.Serialization.SysInfoJsonCleaner.CleanValue(System.Collections.Generic.List{System.Text.RegularExpressions.Match},System.Text.RegularExpressions.Match,System.Int32)"> <summary> Adds missing quotes from values </summary> <param name="properties">A list of matches for the string "": or "_raw":. Position is relative within <paramref name="obj"/>.</param> <param name="obj">The current object {"":"val1","":"val2"}</param> <param name="propertyIndex">The index of this property within <paramref name="obj"/> after excluding all _raw properties</param> </member> <member name="M:PrtgAPI.Request.Serialization.TypeHelpers.StrToInt(System.String)"> <summary> Converts a <see cref="T:System.String"/> to an <see cref="T:System.Int32"/>. If the specified value is null or empty, returns 0. </summary> <param name="value">The value to convert.</param> <returns>If the string is not null or empty, the value as an integer. Otherwise, 0.</returns> </member> <member name="M:PrtgAPI.Request.Serialization.TypeHelpers.ConvertFromPrtgDateTime(System.Double)"> <summary> Convert a PRTG OLE Automation style DateTime to local time. </summary> <param name="datetime">An OLE Automation style DateTime.</param> <returns>If <paramref name="datetime"/> contains a value, the PRTG DateTime formatted for the local timezone. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.Request.Serialization.TypeHelpers.ConvertFromPrtgTimeSpan(System.Double)"> <summary> Convert a PRTG TimeSpan to a <see cref="T:System.TimeSpan"/> object. </summary> <param name="timeSpan">PRTG TimeSpan representing the number of seconds since an event occurred. If this value is null, this method will return null.</param> <returns></returns> </member> <member name="T:PrtgAPI.Request.Serialization.TableData`1"> <summary> Represents an object contained in a table data response. </summary> <typeparam name="TObject">The type of object contained in the response.</typeparam> </member> <member name="P:PrtgAPI.Request.Serialization.TableData`1.TotalCount"> <summary> Total number of objects returned by the request. </summary> </member> <member name="P:PrtgAPI.Request.Serialization.TableData`1.Version"> <summary> Version of PRTG running on the server. </summary> </member> <member name="P:PrtgAPI.Request.Serialization.TableData`1.Items"> <summary> List of objects of type <typeparamref name="TObject"/> returned from the request. </summary> </member> <member name="T:PrtgAPI.Request.ObjectEngine"> <summary> Handles constructing requests for retrieving objects and deserializing their responses </summary> </member> <member name="F:PrtgAPI.Request.ObjectEngine.SerialStreamThreshold"> <summary> The maximum number of objects that may be requested in parallel before objects should be requested serially to prevent web request timeouts. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.TotalExist"> <summary> Total number of objects that exist on the server. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.TotalRequested"> <summary> Total number of objects requested in the <see cref="T:PrtgAPI.Parameters.PageableParameters"/>. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.TotalRequestedThatExist"> <summary> Maximum number of items that were requested that actually exist. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.RequestedStartPosition"> <summary> Start position specified in the <see cref="T:PrtgAPI.Parameters.PageableParameters"/>. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.TotalToRetrieve"> <summary> Total number of objects to retrieve after adjusting the <see cref="P:PrtgAPI.Request.StreamManager`2.TotalRequested"/> and <see cref="P:PrtgAPI.Request.StreamManager`2.RequestedStartPosition"/> according to the <see cref="P:PrtgAPI.Request.StreamManager`2.TotalExist"/>. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.RequestedSkippedRecords"> <summary> Indicates whether there are not enough free records remaining to fulfil the specified <see cref="P:PrtgAPI.Request.StreamManager`2.TotalRequested"/>, causing PRTG to also include records inside the <see cref="P:PrtgAPI.Request.StreamManager`2.RequestedStartPosition"/>. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.RequestParameters"> <summary> A clone of the <see cref="P:PrtgAPI.Request.StreamManager`2.SourceParameters"/> to use for executing the request. </summary> </member> <member name="P:PrtgAPI.Request.StreamManager`2.SourceParameters"> <summary> The original request parameters that were passed to a <see cref="T:PrtgAPI.PrtgClient"/>. </summary> </member> <member name="M:PrtgAPI.Request.RequestParser.ExtractActionXml(System.Xml.Linq.XDocument,System.Xml.Linq.XElement,System.Int32)"> <summary> Extracts the XML of a single notification action from an XML document containing many notification actions. </summary> <param name="normal">The XML to extract the notification action from</param> <param name="properties">The properties to extract</param> <param name="id">The ID of the notification action to extract the properties for.</param> <returns>A XML document containing the specified properties of the specified object.</returns> </member> <member name="M:PrtgAPI.Request.ResponseParser.Amend``1(System.Collections.Generic.List{``0},System.Action{``0})"> <summary> Apply a modification function to each element of a response. </summary> <typeparam name="T">The type of objects returned by the response.</typeparam> <param name="objects">The collection of objects to amend.</param> <param name="action">A modification function to apply to each element of the collection.</param> <returns>A collection of modified objects.</returns> </member> <member name="M:PrtgAPI.Request.ResponseParser.Amend``1(``0,System.Action{``0})"> <summary> Apply a modification function to the properties of an object. </summary> <typeparam name="T">The type of object returned by the response.</typeparam> <param name="obj">The object to amend.</param> <param name="action">A modification function to apply to the object.</param> <returns></returns> </member> <member name="M:PrtgAPI.Request.ResponseParser.Amend``2(``0,System.Func{``0,``1})"> <summary> Apply a modification action to a response, transforming the response to another type. </summary> <typeparam name="TSource">The type of object to transform.</typeparam> <typeparam name="TRet">The type of object to return.</typeparam> <param name="obj">The object to transform.</param> <param name="action">A modification function that transforms the response from one type to another.</param> <returns></returns> </member> <member name="T:PrtgAPI.Request.ISerializable"> <summary> Represents a type whose value when serialized is different from its typical string representation. </summary> </member> <member name="M:PrtgAPI.Request.ISerializable.GetSerializedFormat"> <summary> Gets the string format of this type for use in serialization requests. </summary> <returns></returns> </member> <member name="T:PrtgAPI.Request.PrtgTargetHelper"> <summary> Provides methods for retrieving dynamic sensor targets used for creating and modifying sensors. </summary> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetExeXmlFiles(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Retrieves all EXE/Script files that can be used for creating an EXE/Script Advanced sensor on a specified device. </summary> <param name="deviceOrId">The device or ID of the device to retrieve EXE/Script files for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a list of EXE/Script files. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetExeXmlFilesAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all EXE/Script files that can be used for creating an EXE/Script Advanced sensor on a specified device. </summary> <param name="deviceOrId">The device or ID of the device to retrieve EXE/Script files for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a list of EXE/Script files. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetWmiServices(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Retrieves all WMI Services that can be used for creating a WMI Service sensor on a specified device.<para/> If the device does not have any Windows Credentials defined on it (either explicitly or through inheritance) this method will throw a <see cref="T:PrtgAPI.PrtgRequestException"/>. </summary> <param name="deviceOrId">The device or ID of the device to retrieve WMI Services for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a list of WMI Services. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetWmiServicesAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all WMI Services that can be used for creating a WMI Service sensor on a specified device.<para/> If the device does not have any Windows Credentials defined on it (either explicitly or through inheritance) this method will throw a <see cref="T:PrtgAPI.PrtgRequestException"/>. </summary> <param name="deviceOrId">The device or ID of the device to retrieve WMI Services for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a list of WMI Services. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetSqlServerQueries(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Retrieves all SQL Query files that can be used for querying a Microsoft SQL Server on a specified device. </summary> <param name="deviceOrId">The device or ID of the device to retrieve SQL Query files for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a list of SQL Query files. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetSqlServerQueriesAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all SQL Query files that can be used for querying a Microsoft SQL Server on a specified device. </summary> <param name="deviceOrId">The device or ID of the device to retrieve SQL Query files for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a list of SQL Query files. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetSensorTargets(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Retrieves all sensor targets of a sensor type not currently supported by PrtgAPI. </summary> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets for.</param> <param name="sensorType">The type of sensor to retrieve sensor targets for.</param> <param name="tableName">The name of the Dropdown List or Checkbox Group the sensor targets belong to. If this value is null, PrtgAPI will attempt to guess the name of the table. If this value cannot be guessed or is not valid, an <see cref="T:System.ArgumentException"/> will be thrown listing all possible values.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a generic list of sensor targets. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="M:PrtgAPI.Request.PrtgTargetHelper.GetSensorTargetsAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously rtrieves all sensor targets of a sensor type not currently supported by PrtgAPI. </summary> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets for.</param> <param name="sensorType">The type of sensor to retrieve sensor targets for.</param> <param name="tableName">The name of the Dropdown List or Checkbox Group the sensor targets belong to. If this value is null, PrtgAPI will attempt to guess the name of the table. If this value cannot be guessed or is not valid, an <see cref="T:System.ArgumentException"/> will be thrown listing all possible values.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <exception cref="T:System.TimeoutException">Sensor targets failed to resolve within the specified timespan.</exception> <returns>If the request is allowed to run to completion, a generic list of sensor targets. If the request is aborted from the progress callback, this method returns null.</returns> </member> <member name="T:PrtgAPI.Request.RequestEngine"> <summary> Handles constructing requests from parameter objects and executing them against a HTTP Client. </summary> </member> <member name="P:PrtgAPI.Request.RequestEngine.IsDirty"> <summary> Indicates whether a response has been received containing an invalid character (e.g. \0 in XML) and that future requests should use safe parsing heuristics. </summary> </member> <member name="M:PrtgAPI.Request.VersionClient18_1.GetGroupedLimitChannels(System.Collections.Generic.ICollection{PrtgAPI.Channel},PrtgAPI.Parameters.ChannelParameter[])"> <summary> Group the channels we're modifying together based the value and field that contains an existing limit value. </summary> <param name="channels">The list of channels to group.</param> <param name="parameters">The parameters to add.</param> <returns></returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.ProcessCustomParameter(System.Object)"> <summary> Serialize one or more <see cref="T:PrtgAPI.Parameters.CustomParameter"/> objects. </summary> <param name="value">The value to serialize</param> <returns></returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.FormatSingleParameterWithValEncode(System.String,System.Object,System.Boolean)"> <summary> Formats a parameter in the format name=value with a URL encoded value. </summary> <param name="name">The name to use for the parameter</param> <param name="val">The value to assign to the parameter</param> <param name="isEnum">Whether the specified value is an <see cref="T:System.Enum"/></param> <returns></returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.FormatSingleParameterWithoutValEncode(System.String,System.Object,System.Boolean)"> <summary> Formats a parameter in the format name=value without URL encoding the specified value. </summary> <param name="name">The name to use for the parameter</param> <param name="val">The value to assign to the parameter</param> <param name="isEnum">Whether the specified value is an <see cref="T:System.Enum"/> </param> <returns></returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.GetMultiValueStr(System.Collections.IEnumerable)"> <summary> Retrieves the value of a <see cref="F:PrtgAPI.ParameterType.MultiValue"/> parameter. Result is in the form val1,val2,val3 </summary> <param name="enumerable">The values to assign to the parameter</param> <returns></returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.FormatMultiParameter(System.Collections.IEnumerable,System.String)"> <summary> Formats a <see cref="F:PrtgAPI.ParameterType.MultiParameter"/>. Result is in the form name=val1&name=val2&name=val3 </summary> <param name="enumerable">The values to assign to the parameter</param> <param name="description">The serialized name of the parameter</param> <returns></returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.FormatFlagEnum(System.Enum,System.Func{System.Enum,System.String})"> <summary> Split a bitmask enum into multiple parameters, for use with <see cref="F:PrtgAPI.ParameterType.MultiParameter"/> parameters. </summary> <param name="e">The enumeration to split</param> <param name="formatter">A function that defines how the enumeration value should be serialized</param> <returns>A sequence of one or more URL queries, in the format name=val1&name=val2&name=val3</returns> </member> <member name="M:PrtgAPI.Request.PrtgRequestMessage.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.Utilities.EnumExtensions.GetUnderlyingFlags(System.Enum)"> <summary> Get the underlying flags of an enum element. If the enum has no underlying elements, an empty list is returned. Note: using the enum with value 0 is not supported. Start enum values at 1 instead.. </summary> <param name="element">The value to get the underlying flags of.</param> <returns>The underlying flags of the enum, or an empty list.</returns> </member> <member name="T:PrtgAPI.Linq.SerialObjectGenerator`1"> <summary> Transforms an ordered enumeration of tasks into an <see cref="T:System.Collections.Generic.IEnumerable`1"/> </summary> <typeparam name="T"></typeparam> </member> <member name="P:PrtgAPI.Linq.SerialObjectGenerator`1.Current"> <summary> Gets the element in the collection at the current position of the enumerator. </summary> </member> <member name="M:PrtgAPI.Linq.SerialObjectGenerator`1.#ctor(System.Collections.Generic.IEnumerable{System.Threading.Tasks.Task{`0}})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Linq.SerialObjectGenerator`1"/> class. </summary> </member> <member name="M:PrtgAPI.Linq.SerialObjectGenerator`1.MoveNext"> <summary> Advances the enumerator to the next element of the collection and executes the task within. </summary> <returns>True if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.</returns> </member> <member name="M:PrtgAPI.Linq.SerialObjectGenerator`1.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>An enumerator that can be used to iterate through the collection.</returns> </member> <member name="M:PrtgAPI.Linq.SerialObjectGenerator`1.Reset"> <summary> Sets the enumerator to its initial position, which is before the first element in the collection. </summary> </member> <member name="M:PrtgAPI.Linq.SerialObjectGenerator`1.Dispose"> <summary> Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.ExpressionHelpers.NullConditional(System.Linq.Expressions.Expression,System.Linq.Expressions.Expression)"> <summary> If <paramref name="value"/> is a nullable type, creates an expression like (value == null ? null : action). If <paramref name="value"/> is not nullable, returns the expression (action). </summary> <param name="value">The value to check for null.</param> <param name="ifNotNull">The action to execute if not null.</param> <returns>If the specified value is nullable, a null conditional expression wrapping the specified action. Otherwise, simply returns the specified action.</returns> </member> <member name="T:PrtgAPI.Linq.Expressions.Serialization.LadderCondition"> <summary> Construct an expression like if(!flagArray[0] && reader.Name == objid) { obj.Name = reader.ReadElementString(); flagArray[0] = true; } </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.LadderCondition.MakeElementCheckCondition(System.Int32@)"> <summary> Create an expression like !flagsArray[0] && (object)reader.Name == nameArray[0] </summary> <param name="mappingNameIndex">Index of the mapping name being analyzed.</param> <returns>The condition to check against and the flag of the flagArray that was used.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.LadderCondition.GeneratePropertyBlock(System.Linq.Expressions.Expression)"> <summary> Generate an expression like { obj.Name = "Ping"; flagsArray[0] = true; } </summary> <param name="flag">Flag that should be set.</param> <returns>An expression that represents the operation.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.LadderCondition.InitializeListIfNull(System.Linq.Expressions.Expression,PrtgAPI.Request.Serialization.XmlMapping)"> <summary> Generate an expression like if (obj.Items == null) obj.Items = new List(); </summary> <param name="target">The object containing an item property.</param> <param name="mapping">The mapping for the list property.</param> <returns>An expression for initializing an list of items.</returns> </member> <member name="F:PrtgAPI.Linq.Expressions.Serialization.ValueDeserializer.lambdaMap"> <summary> Maps enums, value converters and nullable types to their corresponding lambdas. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Serialization.LadderBuilder"> <summary> Construct an expression like if (!flagArray[0] && reader.Name == objid) { obj.Name = reader.ReadElementString(); flagArray[0] = true; } else if (...) { ... } ... </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.XmlSerializerGenerator.Get(System.Type)"> <summary> Retrieves the dynamic lambda expression for deserializing the specified type, generating it if it does not already exist. </summary> <param name="type">The type to deserialize.</param> <returns>A lambda expression capable of deserializing the specified type.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.XmlSerializerGenerator.MakeLambda(System.Type,System.Type,System.Boolean)"> <summary> Construct an expression like if (reader.NodeType == XmlNodeType.Element { return ProcessTableDataInternal(); } else { SkipUnknownNode(); return null; } </summary> <param name="delegateType">The type of object that will be returned by the delegate.</param> <param name="trueType">The type of object the delegate will actually manipulate. If this object is null, <paramref name="delegateType"/> is used.</param> <param name="update">Whether this delegate will be used for constructing a new object or updating an existing one.</param> <returns></returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.XmlSerializerGenerator.MakeReadElement(System.Boolean,PrtgAPI.Reflection.Cache.PropertyCache)"> <summary> Construct an expression like var obj = new Obj(); while(ReadAttribute()) { ... } while(ReadElement()) { ... } return obj; </summary> <param name="first">Whether this is the outer object being deserialized.</param> <param name="parentProperty">The property on our parent object this object will be deserialized to.</param> <returns></returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.XmlSerializerGenerator.SkipOrProcessElement"> <summary> Generate an expression like if (reader.IsEmptyElement) { reader.Skip(); return obj; } [Process Element] return obj; </summary> <returns>An expression that skips or processes an element.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.XmlSerializerGenerator.SkipElement"> <summary> Generate an expression like if (reader.IsEmptyElement) { reader.Skip(); return obj; } </summary> <returns>An expression that skips an element.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Serialization.XmlSerializerGenerator.PopulateNameTable(PrtgAPI.Reflection.Cache.PropertyCache)"> <summary> Generate an expression like void InitSensor(object[] nameArray, XmlReader reader) { nameArray[0] = reader.NameTable.Add("name"); nameArray[1] = reader.NameTable.Add("objid"); } </summary> <returns>The invocation of the generated lambda.</returns> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.ClientTreeBuilder"> <summary> Constructs an <see cref="T:System.Linq.Expressions.Expression"/> tree suitable for executing client side, stripping out any expressions that may only be applicable server side (or should not be executed twice) </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.ConditionReducer.FlipExpr(System.Linq.Expressions.Expression,System.Linq.Expressions.Expression,System.Linq.Expressions.ExpressionType)"> <summary> Flip an expression like ((A == B) == false) to (A != B) </summary> <param name="expr">The condition of the expression whose <see cref="T:System.Linq.Expressions.ExpressionType"/> should be flipped.</param> <param name="otherExpr">The part of the expression that is is causing the flippage.</param> <param name="type">The new type to use for the expression.</param> <returns></returns> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.ExtensionReducer"> <summary> Conditionally reduces <see cref="F:System.Linq.Expressions.ExpressionType.Extension"/> <see cref="T:System.Linq.Expressions.Expression"/> nodes based on whether these nodes actually support reduction. If the node cannot be reduced, it is returned as is. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.LinqSourceExpressionVisitor"> <summary> Represents a visitor or rewriter for LINQ expression tree sources.<para/> This type does not visit the <see cref="T:System.Linq.Expressions.LambdaExpression"/> of a specified <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/>. In order to visit additional expression members, override the corresponding visit method. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.ParameterCleaner"> <summary> Replaces all <see cref="T:System.Linq.Expressions.ParameterExpression"/> references in merged expressions with references to a specified input <see cref="T:System.Linq.Expressions.ParameterExpression"/>.<para/> (for example, (s => s.Id == 1 AND t.Active) -> (s => s.Id == 1 AND s.Active)) </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.ConditionExpander"> <summary> Expands a <see cref="T:System.Linq.Expressions.BinaryExpression"/> like ((A) xx (B == v)) to ((A == true) xx ((B == v) == true)).<para/> Extraneous checks against true will be removed later by <see cref="T:PrtgAPI.Linq.Expressions.Visitors.ConditionReducer"/>. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.Parameters.SortExpressionParser"> <summary> Identifies the expression that specifies the property and direction to <see cref="F:PrtgAPI.Parameter.SortBy"/>, replacing processed <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/>s with their underlying <see cref="T:System.Linq.Expressions.MethodCallExpression"/>. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.Parameters.FilterExpressionParser"> <summary> Identifies a list of expressions that can be used to generate a <see cref="T:PrtgAPI.SearchFilter"/>., replacing processed <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/>s with their underlying <see cref="T:System.Linq.Expressions.MethodCallExpression"/>. </summary> </member> <member name="P:PrtgAPI.Linq.Expressions.Visitors.Parameters.FilterExpressionParser.Conditions"> <summary> The legal conditions to filter on in the initial API request. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.Parameters.FilterExpressionParser.VisitBinary(System.Linq.Expressions.BinaryExpression)"> <summary> Identifies conditions to include from a <see cref="T:PrtgAPI.Linq.Expressions.WhereLinqExpression"/>. </summary> <param name="node">The binary expression to analyze.</param> <returns>The original binary expression.</returns> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.Parameters.ColumnExpressionParser"> <summary> Identifies a list of expressions that can be used with <see cref="F:PrtgAPI.Parameter.Columns"/>, replacing processed <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/>s with their underlying <see cref="T:System.Linq.Expressions.MethodCallExpression"/>. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.PropertyExpressionVisitor"> <summary> Represents a visitor capable selectively visiting a <see cref="T:PrtgAPI.Linq.Expressions.PropertyExpression"/> of a specified <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/> type.<para/> By default, this type will only visit the sources of a <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/> tree. Override the visitor for the specified <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/> type in order to visit its <see cref="T:PrtgAPI.Linq.Expressions.PropertyExpression"/>. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.PropertyFlagger"> <summary> Flags properties as being mandatory and exclusive or. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.PropertyEvaluator`1"> <summary> Identifies references to <see cref="T:PrtgAPI.Linq.Query`1"/> properties with a corresponding <see cref="T:PrtgAPI.Linq.Expressions.PropertyExpression"/>. References are traced through intermediate transformations (such as anonymous types) back to their original sources. </summary> <typeparam name="T">The type of object to evaluate properties for.</typeparam> </member> <member name="F:PrtgAPI.Linq.Expressions.Visitors.PropertyEvaluator`1.parameterInitializer"> <summary> Maps a parameter passed to a Select method to a <see cref="T:System.Linq.Expressions.MemberInitExpression"/> or <see cref="T:System.Linq.Expressions.NewExpression"/> used to instantiate the incoming object. </summary> </member> <member name="F:PrtgAPI.Linq.Expressions.Visitors.PropertyEvaluator`1.propertyCache"> <summary> The property cache of this <typeparamref name="T"/>. Each <typeparamref name="T"/> has its own property cache. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor"> <summary> Represents a visitor or rewriter for LINQ expression trees. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitAny(PrtgAPI.Linq.Expressions.AnyLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.AnyLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.AnyLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitCount(PrtgAPI.Linq.Expressions.CountLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.CountLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.CountLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitFirst(PrtgAPI.Linq.Expressions.FirstLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.FirstLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.FirstLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitLast(PrtgAPI.Linq.Expressions.LastLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.LastLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.LastLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitOrderBy(PrtgAPI.Linq.Expressions.OrderByLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.OrderByLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.OrderByLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitSelect(PrtgAPI.Linq.Expressions.SelectLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.SelectLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.SelectLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitSelectMany(PrtgAPI.Linq.Expressions.SelectManyLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.SelectManyLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.SelectManyLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitSkip(PrtgAPI.Linq.Expressions.SkipLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.SkipLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.SkipLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitTake(PrtgAPI.Linq.Expressions.TakeLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.TakeLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.TakeLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.Visitors.LinqExpressionVisitor.VisitWhere(PrtgAPI.Linq.Expressions.WhereLinqExpression)"> <summary> Visits the children of a <see cref="T:PrtgAPI.Linq.Expressions.WhereLinqExpression"/>. </summary> <param name="node">The expression to visit.</param> <returns>If any children were modified, a new <see cref="T:PrtgAPI.Linq.Expressions.WhereLinqExpression"/>. Otherwise, the original expression.</returns> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.LinqQueryMerger"> <summary> Merges the <see cref="T:System.Linq.Expressions.LambdaExpression"/>s of two sequential <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/> calls into a single <see cref="T:System.Linq.Expressions.LambdaExpression"/>. e.g. (Where(a => b.Active).Where(b => b.Id == 1001)) => (Where(a => a.Active AND a.Id == 1001)) </summary> </member> <member name="F:PrtgAPI.Linq.Expressions.Visitors.LinqQueryMerger.combinedQueryTarget"> <summary> Maps a <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/> <see cref="T:System.Type"/> to the <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/> instance that will contain the merged expression. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.LocalExpressionAnalyzer"> <summary> Identifies subexpressions that can be pre-evaluated locally and do not have a dependency on data returned from PRTG. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.LocalExpressionEvaluator"> <summary> Pre-evaluates subexpressions that do not depend on data returned from PRTG. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.SupportedExpressionValidator"> <summary> Validates whether an <see cref="T:System.Linq.Expressions.Expression"/> contains any child nodes that cannot be properly parsed.<para/> Generally speaking, any expression considered illegal by the compiler is blacklisted here (just in case the expression was constructed manually) </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.Visitors.UnaryFixer"> <summary> Substitutes <see cref="T:System.Linq.Expressions.UnaryExpression"/>s with an equivalent expression more easily parsable, such as !val -> val == false </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.AnyLinqExpression"> <summary> Represents a <see cref="M:System.Linq.Queryable.Any``1(System.Linq.IQueryable{``0})"/> or <see cref="M:System.Linq.Queryable.Any``1(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})"/> method call. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.ConditionLinqExpression.Reduce(System.Linq.Expressions.Expression)"> <summary> Reduces this expression to its underlying <see cref="T:System.Linq.Expressions.MethodCallExpression"/> using a specified source (that has potentially already been reduced). </summary> <param name="source">The TSource of the method.</param> <returns>A <see cref="T:System.Linq.Expressions.MethodCallExpression"/> representing a call to the original Queryable</returns> </member> <member name="T:PrtgAPI.Linq.Expressions.FirstLinqExpression"> <summary> Represents a <see cref="M:System.Linq.Queryable.First``1(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})"/> or <see cref="M:System.Linq.Queryable.FirstOrDefault``1(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})"/> method call. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.LinqExpression.Reduce"> <summary> Reduces the expression to its <see cref="T:System.Linq.Expressions.MethodCallExpression"/>. If no sub-expressions have changed, returns the original <see cref="T:System.Linq.Expressions.MethodCallExpression"/>. </summary> <returns></returns> </member> <member name="M:PrtgAPI.Linq.Expressions.OrderByLinqExpression.Reduce(System.Linq.Expressions.Expression)"> <summary> Reduces this expression to its underlying <see cref="T:System.Linq.Expressions.MethodCallExpression"/> using a specified source (that has potentially already been reduced). </summary> <param name="source">The TSource of the method.</param> <returns>A <see cref="T:System.Linq.Expressions.MethodCallExpression"/> representing a call to Queryable.OrderBy / Queryable.OrderByDescending</returns> </member> <member name="M:PrtgAPI.Linq.Expressions.SearchFilterToExpression.Constant(System.Object,System.Type)"> <summary> Creates a <see cref="T:System.Linq.Expressions.ConstantExpression"/> from a <paramref name="value"/>, wrapping it in a cast to a <see cref="T:System.Nullable"/> type (resulting in a <see cref="T:System.Linq.Expressions.UnaryExpression"/>) based on the type of the <paramref name="memberType"/>. </summary> <param name="value">The value to wrap in an expression.</param> <param name="memberType">The member the value should be compared against.</param> <returns>A <see cref="T:System.Linq.Expressions.ConstantExpression"/> if the member type is not nullable; otherwise a <see cref="T:System.Linq.Expressions.UnaryExpression"/>.</returns> </member> <member name="P:PrtgAPI.Linq.Expressions.PropertyExpression.ExclusiveOr"> <summary> Indicates the property can only be specified on one side of a <see cref="F:System.Linq.Expressions.ExpressionType.OrElse"/>. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.SelectLinqExpression.Reduce(System.Linq.Expressions.Expression)"> <summary> Reduces this expression to its underlying <see cref="T:System.Linq.Expressions.MethodCallExpression"/> using a specified source (that has potentially already been reduced). </summary> <param name="source">The TSource of the method.</param> <returns>A <see cref="T:System.Linq.Expressions.MethodCallExpression"/> representing a call to Queryable.Select</returns> </member> <member name="T:PrtgAPI.Linq.Expressions.LinqInitializer"> <summary> Helper class for constructing new <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/>s.<para/> Wraps the <see cref="T:System.Linq.Expressions.ExpressionVisitor"/> that is trying to construct the <see cref="T:PrtgAPI.Linq.Expressions.LinqExpression"/>, as well the <see cref="T:PrtgAPI.Linq.Expressions.Visitors.PropertyEvaluator`1"/> evaluator used to construct <see cref="T:System.Linq.Expressions.ParameterExpression"/>s. </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.IllegalBinaryReducer"> <summary> Reduces <see cref="F:System.Linq.Expressions.ExpressionType.AndAlso"/> and <see cref="F:System.Linq.Expressions.ExpressionType.OrElse"/> <see cref="T:System.Linq.Expressions.BinaryExpression"/> objects to a form that is considered valid by PRTG (A AND B), (A1 OR A2) </summary> </member> <member name="T:PrtgAPI.Linq.Expressions.SubstituteExpression"> <summary> Represents the substitution of the original body of a <see cref="T:System.Linq.Expressions.LambdaExpression"/> before being parsed by a <see cref="T:PrtgAPI.Linq.Expressions.Visitors.PropertyEvaluator`1"/>. </summary> </member> <member name="M:PrtgAPI.Linq.Expressions.SubstituteExpression.Reduce"> <summary> Returns the original body of the <see cref="T:System.Linq.Expressions.LambdaExpression"/>. </summary> <returns></returns> </member> <member name="T:PrtgAPI.Linq.Expressions.WhereLinqExpression"> <summary> Represents a <see cref="M:System.Linq.Queryable.Where``1(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})"/> or <see cref="M:System.Linq.Queryable.Where``1(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Int32,System.Boolean}})"/> method call. </summary> </member> <member name="F:PrtgAPI.Linq.TableQueryProvider`2.strict"> <summary> Specifies that PrtgAPI should throw exceptions upon encountering unsupported expressions, rather than executing client side. </summary> </member> <member name="M:PrtgAPI.Linq.TakeIterator`2.#ctor(System.Int32,`1,System.Func{`1,System.Func{System.Int32},System.Collections.Generic.IEnumerable{`0}},System.Func{System.Int32},System.Func{System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`0}},System.Func{System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`0}},System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Linq.TakeIterator`2"/> class. </summary> <param name="takeCount">The desired number of objects to retrieve.</param> <param name="parameters">The parameters to use for the request.</param> <param name="streamer">A function that retrieves results from the server.</param> <param name="getCount">A function that retrieves the total number of records that match the specified parameters.</param> <param name="postProcessor">A post processing function that filters the retrieved results.</param> <param name="postProcessorSorter">A post processing sorting function that sorts the taken records. Only applies if <paramref name="stream"/> is false.</param> <param name="stream">Whether to stream the records across multiple requests or request all of the objects at once.</param> </member> <member name="T:PrtgAPI.Linq.ParallelObjectGenerator`1"> <summary> Transforms an unordered parallel task into an <see cref="T:System.Collections.Generic.IEnumerable`1"/> </summary> <typeparam name="T">The type of object returned by this generator.</typeparam> </member> <member name="P:PrtgAPI.Linq.ParallelObjectGenerator`1.Current"> <summary> Gets the element in the collection at the current position of the enumerator. </summary> </member> <member name="M:PrtgAPI.Linq.ParallelObjectGenerator`1.#ctor(System.Threading.Tasks.Task{System.Threading.Tasks.Task{`0}}[])"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Linq.ParallelObjectGenerator`1"/> class. </summary> </member> <member name="M:PrtgAPI.Linq.ParallelObjectGenerator`1.MoveNext"> <summary> Advances the enumerator to the next element of the collection.<para />If this is the first time the enumerator has been advanced, the enumerator's task will be initialized and begin generating results in parallel for subsequent requests to <see cref="M:PrtgAPI.Linq.ParallelObjectGenerator`1.MoveNext"/>. </summary> <returns>True if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.</returns> </member> <member name="M:PrtgAPI.Linq.ParallelObjectGenerator`1.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>An enumerator that can be used to iterate through the collection.</returns> </member> <member name="M:PrtgAPI.Linq.ParallelObjectGenerator`1.Reset"> <summary> Sets the enumerator to its initial position, which is before the first element in the collection. </summary> </member> <member name="M:PrtgAPI.Linq.ParallelObjectGenerator`1.Dispose"> <summary> Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. </summary> </member> <member name="T:PrtgAPI.IObjectExtensions"> <summary> Extension methods for interacting with <see cref="T:PrtgAPI.IObject"/> types. </summary> </member> <member name="M:PrtgAPI.IObjectExtensions.GetId(PrtgAPI.IObject)"> <summary> Retrieves the Object ID of an unspecified <see cref="T:PrtgAPI.IObject"/> type. </summary> <param name="obj">The instance to retrieve the Object ID of.</param> <returns>The object's Object ID.</returns> </member> <member name="M:PrtgAPI.IObjectExtensions.GetTypeDescription(System.Type)"> <summary> Retrieves the value of a <see cref="T:System.ComponentModel.DescriptionAttribute"/> of the specified type. If the type does not have a <see cref="T:System.ComponentModel.DescriptionAttribute"/>, its name is used instead. </summary> <param name="type">The type whose description should be retrieved.</param> <returns>The type's name or description.</returns> </member> <member name="T:PrtgAPI.Reflection.ReflectionExtensions"> <summary> Defines helper extension methods used for performing reflection. </summary> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetUnderlyingType(System.Type)"> <summary> Returns the underlying type of this type is <see cref="T:System.Nullable"/>; otherwise, returns this type. </summary> <param name="type"></param> <returns></returns> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetInternalProperty(System.Object,System.String)"> <summary> Retrieve the value of an internal property of an object. </summary> <param name="obj">The object to retrieve the property from.</param> <param name="name">The name of the property whose value should be retrieved.</param> <returns>The value of the retrieved property.</returns> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetInternalPropertyInfo(System.Object,System.String)"> <summary> Retrieve the property info metadata of an internal property. </summary> <param name="obj">The object to retrieve the property from.</param> <param name="name">The name of the property whose info should be retrieved.</param> <returns>The property info of the specified property. If the property cannot be found or is not internal, this method returns null.</returns> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetInternalField(System.Object,System.String)"> <summary> Retrieve the value of an internal field of an object. </summary> <param name="obj">The object to retrieve the field from.</param> <param name="name">The name of the field whose value should be retrieved.</param> <returns>The value of the retrieved field.</returns> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetInternalFieldInfo(System.Object,System.String)"> <summary> Retrieve the field info metadata of an internal field. </summary> <param name="obj">The object to retrieve the field from.</param> <param name="name">The name of the field whose info should be retrieved.</param> <returns>The field info of the specified field. If the field cannot be found or is not internal, this method returns null.</returns> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetInternalMethod(System.Object,System.String)"> <summary> Retrieve an internal method from an object. </summary> <param name="obj">The object to retrieve the method from.</param> <param name="name">The name of the method to retrieve.</param> <returns>The method info of the specified method. If the specified method cannot be found or is not internal, this method returns null.<para/> If more than one method is found with the specified name, this method throws a <see cref="T:System.Reflection.AmbiguousMatchException"/></returns> </member> <member name="M:PrtgAPI.Reflection.ReflectionExtensions.GetNormalProperties(System.Type)"> <summary> Retrieve all properties from a type, excluding those that are not writable or are internal properties used by indexers </summary> <param name="type">The type to retrieve properties for.</param> <returns></returns> </member> <member name="T:PrtgAPI.Reflection.Cache.EnumXmlCache"> <summary> Maps <see cref="T:System.Xml.Serialization.XmlEnumAttribute"/> and <see cref="T:PrtgAPI.Attributes.XmlEnumAlternateName"/> values to their corresponding <see cref="T:System.Enum"/> values. </summary> </member> <member name="T:PrtgAPI.Schedules.TimeSlot"> <summary> Represents an individual cell of a <see cref="T:PrtgAPI.Schedules.TimeTable"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlot.Hour"> <summary> The hour this timeslot applies to. Ranges from 0-23. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlot.Day"> <summary> The day of the week this timeslot applies to. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlot.Active"> <summary> Whether monitoring should be active in the timespan specified by this timeslot. </summary> </member> <member name="M:PrtgAPI.Schedules.TimeSlot.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects have the same day, hour and active state. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlot.Equals(PrtgAPI.Schedules.TimeSlot)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects have the same day, hour and active state. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlot.GetHashCode"> <summary> Returns a hash code for this object. If two time slots have the same day, hour and active state, they have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlot.CompareTo(System.Object)"> <summary> Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. </summary> <param name="other">The object to compare with this instance.</param> <returns>A value that indicates the relative order of the objects being compared.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlot.CompareTo(PrtgAPI.Schedules.TimeSlot)"> <summary> Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. </summary> <param name="other">The object to compare with this instance.</param> <returns>A value that indicates the relative order of the objects being compared.</returns> </member> <member name="T:PrtgAPI.Schedules.TimeSlotRow"> <summary> Provides a view of a <see cref="T:PrtgAPI.Schedules.TimeTable"/> hour across all days of the week. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Time"> <summary> The display hour this view applies to. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Hour"> <summary> The hour this view applies to. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Monday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Monday"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Tuesday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Tuesday"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Wednesday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Wednesday"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Thursday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Thursday"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Friday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Friday"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Saturday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Saturday"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeSlotRow.Sunday"> <summary> Whether monitoring is active on <see cref="F:System.DayOfWeek.Sunday"/>. </summary> </member> <member name="M:PrtgAPI.Schedules.TimeSlotRow.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlotRow.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects have the same hour and are active on the same days of the week. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlotRow.Equals(PrtgAPI.Schedules.TimeSlotRow)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects have the same hour and are active on the same days of the week. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlotRow.GetHashCode"> <summary> Returns a hash code for this object. If two time slots rows have the same time, and are active on the same days of the week they have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlotRow.CompareTo(System.Object)"> <summary> Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. </summary> <param name="other">The object to compare with this instance.</param> <returns>A value that indicates the relative order of the objects being compared.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeSlotRow.CompareTo(PrtgAPI.Schedules.TimeSlotRow)"> <summary> Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. </summary> <param name="other">The object to compare with this instance.</param> <returns>A value that indicates the relative order of the objects being compared.</returns> </member> <member name="T:PrtgAPI.Schedules.TimeTable"> <summary> Describes the times a <see cref="T:PrtgAPI.Schedule"/> is active. When a schedule is inactive, all objects objects affected by it are <see cref="F:PrtgAPI.Status.PausedBySchedule"/>. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Grid"> <summary> Represents the individual cells and provides a day-centric view of the timetable. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Rows"> <summary> Provides an hour-centric view of the timetable. </summary> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Item(System.Int32)"> <summary> Retrieves all time slots associated with a particular hour across the entire week. </summary> <param name="hour">The hour to retrieve time slots for. Must be a value between 0-23.</param> <returns>All time slots for the specified hour across the entire week.</returns> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Item(System.TimeSpan)"> <summary> Retrieves all time slots associated with a particular time of day across the entire week. </summary> <param name="time">The time of day. Must have a <see cref="P:System.TimeSpan.TotalHours"/> less than 24.</param> <returns>All time slots for the specified time of day across the entire week.</returns> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Item(System.DayOfWeek)"> <summary> Retrieves all time slots present in a single 24-hour day. </summary> <param name="day">The day to retrieve time slots for.</param> <returns>All time slots present in a single day.</returns> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Item(System.Int32,System.DayOfWeek)"> <summary> Retrieves the time slot of a specified hour and day of the week. </summary> <param name="hour">The hour to retrieve. Must be a value between 0-23.</param> <param name="day">The day to retrieve.</param> <returns>The time slot associated with the specified hour and day.</returns> </member> <member name="P:PrtgAPI.Schedules.TimeTable.Item(System.TimeSpan,System.DayOfWeek)"> <summary> Retrieves the time slot of a specified hour and day of the week. </summary> <param name="time">The time of day. Must have a <see cref="P:System.TimeSpan.TotalHours"/> less than 24.</param> <param name="day">The day to retrieve.</param> <returns>The time slot associated with the specified hour and day.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeTable.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>An enumerator that can be used to iterate through the collection.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeTable.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects are timetables that are active at the same times of the week. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeTable.Equals(PrtgAPI.Schedules.TimeTable)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects are timetables that are active at the same times of the week. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedules.TimeTable.GetHashCode"> <summary> Returns a hash code for this object. If two timetables are active at the same times of the week they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="T:PrtgAPI.DeviceHardwareInfo"> <summary> Describes a hardware component found on a device. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.Name"> <summary> Name of the component. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.Description"> <summary> Description of the component. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.Class"> <summary> Hardware category of the component. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.Caption"> <summary> Caption of the component. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.State"> <summary> Health state of the component. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.SerialNumber"> <summary> Serial number of the component. </summary> </member> <member name="P:PrtgAPI.DeviceHardwareInfo.Capacity"> <summary> Capacity of the component. For example, total RAM capacity. Typically measured in bytes. </summary> </member> <member name="T:PrtgAPI.DeviceInfo"> <summary> Represents an abstract piece of system information. </summary> </member> <member name="P:PrtgAPI.DeviceInfo.DeviceId"> <summary> ID of the device this information applies to. </summary> </member> <member name="P:PrtgAPI.DeviceInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceInfo.LastUpdated"> <summary> Time this information was last received by PRTG from the target device </summary> </member> <member name="P:PrtgAPI.DeviceInfo.DisplayName"> <summary> Display name of this object. </summary> </member> <member name="P:PrtgAPI.DeviceInfo.Name"> <summary> Name of this object. </summary> </member> <member name="M:PrtgAPI.DeviceInfo.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.DeviceProcessInfo"> <summary> Represents a process running on a device. </summary> </member> <member name="P:PrtgAPI.DeviceProcessInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceProcessInfo.ProcessId"> <summary> Process ID of the process. </summary> </member> <member name="P:PrtgAPI.DeviceProcessInfo.Caption"> <summary> Caption of the process. </summary> </member> <member name="P:PrtgAPI.DeviceProcessInfo.CreationDate"> <summary> DateTime the process was created. </summary> </member> <member name="P:PrtgAPI.DeviceProcessInfo.Name"> <summary> Name of the process. </summary> </member> <member name="M:PrtgAPI.DeviceProcessInfo.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.DeviceServiceInfo"> <summary> Represents a service installed on a device. </summary> </member> <member name="P:PrtgAPI.DeviceServiceInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceServiceInfo.Name"> <summary> Name of the service. </summary> </member> <member name="P:PrtgAPI.DeviceServiceInfo.Description"> <summary> Description of the service. </summary> </member> <member name="P:PrtgAPI.DeviceServiceInfo.User"> <summary> User account the service runs as. </summary> </member> <member name="P:PrtgAPI.DeviceServiceInfo.StartMode"> <summary> Startup mode of the service. </summary> </member> <member name="P:PrtgAPI.DeviceServiceInfo.State"> <summary> Running state of the service. </summary> </member> <member name="T:PrtgAPI.DeviceSoftwareInfo"> <summary> Represents an application installed on a device. </summary> </member> <member name="P:PrtgAPI.DeviceSoftwareInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceSoftwareInfo.Name"> <summary> Name of the application. </summary> </member> <member name="P:PrtgAPI.DeviceSoftwareInfo.Vendor"> <summary> Vendor that authored the application. </summary> </member> <member name="P:PrtgAPI.DeviceSoftwareInfo.Version"> <summary> Version of the software that is installed. </summary> </member> <member name="P:PrtgAPI.DeviceSoftwareInfo.InstallDate"> <summary> Date the software was installed. </summary> </member> <member name="P:PrtgAPI.DeviceSoftwareInfo.Size"> <summary> Installed size of the application (in kilobytes). </summary> </member> <member name="T:PrtgAPI.DeviceSystemInfo"> <summary> Represents core system snformation of a device. </summary> </member> <member name="P:PrtgAPI.DeviceSystemInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceSystemInfo.Name"> <summary> Name of the property. </summary> </member> <member name="P:PrtgAPI.DeviceSystemInfo.Property"> <summary> Name of the sub-property (if applicable). </summary> </member> <member name="P:PrtgAPI.DeviceSystemInfo.Value"> <summary> Value of the property. </summary> </member> <member name="P:PrtgAPI.DeviceSystemInfo.Id"> <summary> Instance of the property. </summary> </member> <member name="P:PrtgAPI.DeviceSystemInfo.Adapter"> <summary> Adapter name. </summary> </member> <member name="T:PrtgAPI.DeviceUserInfo"> <summary> Represents a user that is logged into a device. </summary> </member> <member name="P:PrtgAPI.DeviceUserInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.DeviceUserInfo.Domain"> <summary> Name of the domain the user belongs to. </summary> </member> <member name="P:PrtgAPI.DeviceUserInfo.User"> <summary> Name of the user. </summary> </member> <member name="P:PrtgAPI.DeviceUserInfo.Name"> <summary> Full name of the user. </summary> </member> <member name="T:PrtgAPI.IDeviceInfo"> <summary> Represents an abstract piece of system information. </summary> </member> <member name="P:PrtgAPI.IDeviceInfo.DeviceId"> <summary> ID of the device this object applies to. </summary> </member> <member name="P:PrtgAPI.IDeviceInfo.Type"> <summary> Type of system information represented by this object. </summary> </member> <member name="P:PrtgAPI.IDeviceInfo.LastUpdated"> <summary> Time this information was last received by PRTG from the target device. </summary> </member> <member name="P:PrtgAPI.IDeviceInfo.DisplayName"> <summary> Display name of this object. </summary> </member> <member name="T:PrtgAPI.SystemInfo"> <summary> Represents System Information used to describe the state of a device. </summary> </member> <member name="P:PrtgAPI.SystemInfo.DeviceId"> <summary> ID of the device this information applies to. </summary> </member> <member name="P:PrtgAPI.SystemInfo.System"> <summary> Core system information of a device. </summary> </member> <member name="P:PrtgAPI.SystemInfo.Hardware"> <summary> Hardware installed in a device. </summary> </member> <member name="P:PrtgAPI.SystemInfo.Software"> <summary> Software installed on a device. </summary> </member> <member name="P:PrtgAPI.SystemInfo.Processes"> <summary> Processes running on a device. </summary> </member> <member name="P:PrtgAPI.SystemInfo.Services"> <summary> Services installed on a device. </summary> </member> <member name="P:PrtgAPI.SystemInfo.Users"> <summary> Users logged into a device. </summary> </member> <member name="M:PrtgAPI.SystemInfo.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.PrtgClient"> <summary> <para type="description">Provides methods for generating API requests against PRTG Network Monitor.</para> </summary> </member> <member name="M:PrtgAPI.PrtgClient.GetObject(System.Int32,System.Boolean)"> <summary> Retrieves an object of an unspecified type based on its object ID.<para/> If an object with the specified object ID does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> exception is thrown. </summary> <param name="id">The ID of the object to retrieve.</param> <param name="resolve">Whether to resolve the resultant object to its most derived <see cref="T:PrtgAPI.PrtgObject"/> type. If the object type is not supported by PrtgAPI, the original <see cref="T:PrtgAPI.PrtgObject"/> is returned.</param> <exception cref="T:System.InvalidOperationException">The specified object does not exist or multiple objects were resolved with the specified ID.</exception> <returns>The object with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectAsync(System.Int32,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves an object of an unspecified type based on its object ID.<para/> If an object with the specified object ID does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> exception is thrown. </summary> <param name="id">The ID of the object to retrieve.</param> <param name="resolve">Whether to resolve the resultant object to its most derived <see cref="T:PrtgAPI.PrtgObject"/> type. If the object type is not supported by PrtgAPI, the original <see cref="T:PrtgAPI.PrtgObject"/> is returned.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified object does not exist or multiple objects were resolved with the specified ID.</exception> <returns>The object with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjects"> <summary> Retrieves all uniquely identifiable objects from a PRTG Server. </summary> <returns>A list of all objects on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync"> <summary> Asynchronously retrieves all uniquely identifiable objects from a PRTG Server. </summary> <returns>A list of all objects on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all uniquely identifiable objects from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all objects on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamObjects(System.Boolean)"> <summary> Streams all uniquely identifiable objects from a PRTG Server.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjects(PrtgAPI.Property,System.Object)"> <summary> Retrieves uniquely identifiable objects from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamObjects(PrtgAPI.Property,System.Object)"> <summary> Streams uniquely identifiable objects from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjects(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Retrieves uniquely identifiable objects from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamObjects(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Streams uniquely identifiable objects from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjects(PrtgAPI.SearchFilter[])"> <summary> Retrieves uniquely identifiable objects from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of objects that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamObjects(PrtgAPI.SearchFilter[])"> <summary> Streams uniquely identifiable objects from a PRTG Server, filtering for objects based on one or more conditions.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjects(PrtgAPI.Parameters.PrtgObjectParameters)"> <summary> Retrieves uniquely identifiable objects from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Objects.</param> <returns>A list of objects that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.Parameters.PrtgObjectParameters)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Objects.</param> <returns>A list of objects that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamObjects(PrtgAPI.Parameters.PrtgObjectParameters,System.Boolean)"> <summary> Streams uniquely identifiable objects from a PRTG Server using a custom set of parameters.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Objects.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjects(PrtgAPI.Parameters.PrtgObjectParameters,System.Threading.CancellationToken)"> <summary> Retrieves uniquely identifiable objects from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Objects.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of objects that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectsAsync(PrtgAPI.Parameters.PrtgObjectParameters,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves uniquely identifiable objects from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Objects.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of objects that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensor(System.Int32)"> <summary> Retrieves a sensor with a specified ID from a PRTG Server.<para/> If the sensor does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the sensor to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified sensor does not exist or multiple sensors were resolved with the specified ID.</exception> <returns>The sensor with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorAsync(System.Int32)"> <summary> Asynchronously retrieves a sensor with a specified ID from a PRTG Server.<para/> If the sensor does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the sensor to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified sensor does not exist or multiple sensors were resolved with the specified ID.</exception> <returns>The sensor with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a sensor with a specified ID from a PRTG Server with a specified cancellation token.<para/> If the sensor does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the sensor to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified sensor does not exist or multiple sensors were resolved with the specified ID.</exception> <returns>The sensor with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors"> <summary> Retrieves all sensors from a PRTG Server. </summary> <returns>A list of all sensors on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync"> <summary> Asynchronously retrieves all sensors from a PRTG Server. </summary> <returns>A list of all sensors on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all sensors from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all sensors on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensors(System.Boolean)"> <summary> Streams all sensors from a PRTG Server.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors(PrtgAPI.Status[])"> <summary> Retrieves sensors from a PRTG Server of one or more statuses. </summary> <param name="statuses">A list of sensor statuses to filter for.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Status[])"> <summary> Asynchronously retrieves sensors from a PRTG Server of one or more statuses. </summary> <param name="statuses">A list of sensor statuses to filter for.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Status[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves sensors from a PRTG Server of one or more statuses with a specified cancellation token. </summary> <param name="statuses">A list of sensor statuses to filter for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensors(PrtgAPI.Status[])"> <summary> Streams sensors from a PRTG Server of one or more statuses.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="statuses">A list of sensor statuses to filter for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors(PrtgAPI.Property,System.Object)"> <summary> Retrieves sensors from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves sensors from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves sensors from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensors(PrtgAPI.Property,System.Object)"> <summary> Streams sensors from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Retrieves sensors from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Asynchronously retrieves sensors from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves sensors from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensors(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Streams sensors from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors(PrtgAPI.SearchFilter[])"> <summary> Retrieves sensors from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves sensors from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves sensors from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of sensors that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensors(PrtgAPI.SearchFilter[])"> <summary> Streams sensors from a PRTG Server, filtering for objects based on one or more conditions.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QuerySensors"> <summary> Retrieves sensors from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions. </summary> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QuerySensors(System.Boolean)"> <summary> Retrieves sensors from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, specifying whether to use strict parsing semantics. </summary> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QuerySensors(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Sensor,System.Boolean}})"> <summary> Retrieves sensors from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter sensors according to a specified predicate. </summary> <param name="predicate">The predicate to initially filter sensors by.</param> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the sensors.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QuerySensors(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Sensor,System.Boolean}},System.Boolean)"> <summary> Retrieves sensors from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter sensors according to a specified predicate and specifying whether to use strict parsing semantics. </summary> <param name="predicate">The predicate to initially filter sensors by.</param> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the sensors.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors(PrtgAPI.Parameters.SensorParameters)"> <summary> Retrieves sensors from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Sensors.</param> <returns>A list of sensors that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Parameters.SensorParameters)"> <summary> Asynchronously retrieves sensors from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Sensors.</param> <returns>A list of sensors that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensors(PrtgAPI.Parameters.SensorParameters,System.Boolean)"> <summary> Streams sensors from a PRTG Server using a custom set of parameters.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Sensors.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensors(PrtgAPI.Parameters.SensorParameters,System.Threading.CancellationToken)"> <summary> Retrieves sensors from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Sensors.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of sensors that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorsAsync(PrtgAPI.Parameters.SensorParameters,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves sensors from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Sensors.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of sensors that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTypes(System.Int32)"> <summary> Retrieves descriptions of all sensor types that can be created under a specified object. Actual supported types may differ based on current PRTG settings.<para/> If the specified object does not support querying sensor types, this method returns null. </summary> <param name="objectId">The ID of the object to retrieve supported types of.</param> <returns>If the specified object supports querying sensor types, a list descriptions of sensor types supported by the specified object. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTypesAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves descriptions of all sensor types that can be created under a specified object. Actual supported types may differ based on current PRTG settings.<para/> If the specified object does not support querying sensor types, this method returns null. </summary> <param name="objectId">The ID of the object to retrieve supported types of.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If the specified object supports querying sensor types, a list descriptions of sensor types supported by the specified object. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTotals"> <summary> Retrieves the number of sensors of each sensor type in the system. </summary> <returns>The total number of sensors of each <see cref="T:PrtgAPI.Status"/> type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTotalsAsync"> <summary> Asynchronously retrieves the number of sensors of each sensor type in the system. </summary> <returns>The total number of sensors of each <see cref="T:PrtgAPI.Status"/> type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTotalsAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves the number of sensors of each sensor type in the system with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The total number of sensors of each <see cref="T:PrtgAPI.Status"/> type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevice(System.Int32)"> <summary> Retrieves a device with a specified ID from a PRTG Server.<para/> If the device does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the device to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified device does not exist or multiple devices were resolved with the specified ID.</exception> <returns>The device with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDeviceAsync(System.Int32)"> <summary> Asynchronously retrieves a device with a specified ID from a PRTG Server.<para/> If the device does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the device to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified device does not exist or multiple devices were resolved with the specified ID.</exception> <returns>The device with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDeviceAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a device with a specified ID from a PRTG Server with a specified cancellation token.<para/> If the device does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the device to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified device does not exist or multiple devices were resolved with the specified ID.</exception> <returns>The device with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevices"> <summary> Retrieves all devices from a PRTG Server. </summary> <returns>A list of all devices on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync"> <summary> Asynchronously retrieves all devices from a PRTG Server. </summary> <returns>A list of all devices on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all devices from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all devices on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamDevices(System.Boolean)"> <summary> Streams all devices from a PRTG Server.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevices(PrtgAPI.Property,System.Object)"> <summary> Retrieves devices from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves devices from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves devices from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamDevices(PrtgAPI.Property,System.Object)"> <summary> Streams devices from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevices(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Retrieves devices from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Asynchronously retrieves devices from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves devices from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamDevices(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Streams devices from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevices(PrtgAPI.SearchFilter[])"> <summary> Retrieves devices from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves devices from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves devices from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of devices that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamDevices(PrtgAPI.SearchFilter[])"> <summary> Streams devices from a PRTG Server, filtering for objects based on one or more conditions.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryDevices"> <summary> Retrieves devices from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions. </summary> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryDevices(System.Boolean)"> <summary> Retrieves devices from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, specifying whether to use strict parsing semantics. </summary> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryDevices(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Device,System.Boolean}})"> <summary> Retrieves devices from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter devices according to a specified predicate. </summary> <param name="predicate">The predicate to initially filter devices by.</param> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the devices.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryDevices(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Device,System.Boolean}},System.Boolean)"> <summary> Retrieves devices from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter devices according to a specified predicate and specifying whether to use strict parsing semantics. </summary> <param name="predicate">The predicate to initially filter devices by.</param> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the devices.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevices(PrtgAPI.Parameters.DeviceParameters)"> <summary> Retrieves devices from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Devices.</param> <returns>A list of devices that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.Parameters.DeviceParameters)"> <summary> Asynchronously retrieves devices from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Devices.</param> <returns>A list of devices that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamDevices(PrtgAPI.Parameters.DeviceParameters,System.Boolean)"> <summary> Streams devices from a PRTG Server using a custom set of parameters.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Devices.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevices(PrtgAPI.Parameters.DeviceParameters,System.Threading.CancellationToken)"> <summary> Retrieves devices from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Devices.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of devices that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicesAsync(PrtgAPI.Parameters.DeviceParameters,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves devices from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Devices.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of devices that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDeviceTemplates(System.Int32)"> <summary> Retrieves all auto-discovery device templates supported by the specified object. </summary> <param name="deviceId">The ID of the device to retrieve supported device templates of. In practice all devices should support the same device templates.</param> <returns>A list of device templates supported by the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDeviceTemplatesAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all auto-discovery device templates supported by the specified object. </summary> <param name="deviceId">The ID of the device to retrieve supported device templates of. In practice all devices should support the same device templates.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of device templates supported by the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroup(System.Int32)"> <summary> Retrieves a group with a specified ID from a PRTG Server.<para/> If the group does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the group to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified group does not exist or multiple groups were resolved with the specified ID.</exception> <returns>The group with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupAsync(System.Int32)"> <summary> Asynchronously retrieves a group with a specified ID from a PRTG Server.<para/> If the group does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the group to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified group does not exist or multiple groups were resolved with the specified ID.</exception> <returns>The group with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a group with a specified ID from a PRTG Server with a specified cancellation token.<para/> If the group does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the group to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified group does not exist or multiple groups were resolved with the specified ID.</exception> <returns>The group with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroups"> <summary> Retrieves all groups from a PRTG Server. </summary> <returns>A list of all groups on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync"> <summary> Asynchronously retrieves all groups from a PRTG Server. </summary> <returns>A list of all groups on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all groups from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all groups on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamGroups(System.Boolean)"> <summary> Streams all groups from a PRTG Server.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroups(PrtgAPI.Property,System.Object)"> <summary> Retrieves groups from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves groups from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves groups from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamGroups(PrtgAPI.Property,System.Object)"> <summary> Streams groups from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroups(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Retrieves groups from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Asynchronously retrieves groups from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves groups from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamGroups(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Streams groups from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroups(PrtgAPI.SearchFilter[])"> <summary> Retrieves groups from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves groups from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves groups from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of groups that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamGroups(PrtgAPI.SearchFilter[])"> <summary> Streams groups from a PRTG Server, filtering for objects based on one or more conditions.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryGroups"> <summary> Retrieves groups from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions. </summary> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryGroups(System.Boolean)"> <summary> Retrieves groups from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, specifying whether to use strict parsing semantics. </summary> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryGroups(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Group,System.Boolean}})"> <summary> Retrieves groups from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter groups according to a specified predicate. </summary> <param name="predicate">The predicate to initially filter groups by.</param> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the groups.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryGroups(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Group,System.Boolean}},System.Boolean)"> <summary> Retrieves groups from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter groups according to a specified predicate and specifying whether to use strict parsing semantics. </summary> <param name="predicate">The predicate to initially filter groups by.</param> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the groups.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroups(PrtgAPI.Parameters.GroupParameters)"> <summary> Retrieves groups from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Groups.</param> <returns>A list of groups that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.Parameters.GroupParameters)"> <summary> Asynchronously retrieves groups from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Groups.</param> <returns>A list of groups that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamGroups(PrtgAPI.Parameters.GroupParameters,System.Boolean)"> <summary> Streams groups from a PRTG Server using a custom set of parameters.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Groups.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroups(PrtgAPI.Parameters.GroupParameters,System.Threading.CancellationToken)"> <summary> Retrieves groups from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Groups.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of groups that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupsAsync(PrtgAPI.Parameters.GroupParameters,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves groups from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Groups.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of groups that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbe(System.Int32)"> <summary> Retrieves a probe with a specified ID from a PRTG Server.<para/> If the probe does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the probe to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified probe does not exist or multiple probes were resolved with the specified ID.</exception> <returns>The probe with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbeAsync(System.Int32)"> <summary> Asynchronously retrieves a probe with a specified ID from a PRTG Server.<para/> If the probe does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the probe to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified probe does not exist or multiple probes were resolved with the specified ID.</exception> <returns>The probe with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbeAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a probe with a specified ID from a PRTG Server with a specified cancellation token.<para/> If the probe does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the probe to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified probe does not exist or multiple probes were resolved with the specified ID.</exception> <returns>The probe with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbes"> <summary> Retrieves all probes from a PRTG Server. </summary> <returns>A list of all probes on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync"> <summary> Asynchronously retrieves all probes from a PRTG Server. </summary> <returns>A list of all probes on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all probes from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all probes on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamProbes(System.Boolean)"> <summary> Streams all probes from a PRTG Server.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbes(PrtgAPI.Property,System.Object)"> <summary> Retrieves probes from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves probes from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves probes from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamProbes(PrtgAPI.Property,System.Object)"> <summary> Streams probes from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbes(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Retrieves probes from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Asynchronously retrieves probes from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves probes from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamProbes(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Streams probes from a PRTG Server based on the value of a certain property.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="property">Property to search against.</param> <param name="operator">Operator to compare value and property value with.</param> <param name="value">Value to search for.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbes(PrtgAPI.SearchFilter[])"> <summary> Retrieves probes from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves probes from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves probes from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of probes that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamProbes(PrtgAPI.SearchFilter[])"> <summary> Streams probes from a PRTG Server, filtering for objects based on one or more conditions.<para/> When this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryProbes"> <summary> Retrieves probes from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions. </summary> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryProbes(System.Boolean)"> <summary> Retrieves probes from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, specifying whether to use strict parsing semantics. </summary> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryProbes(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Probe,System.Boolean}})"> <summary> Retrieves probes from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter probes according to a specified predicate. </summary> <param name="predicate">The predicate to initially filter probes by.</param> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the probes.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryProbes(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Probe,System.Boolean}},System.Boolean)"> <summary> Retrieves probes from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter probes according to a specified predicate and specifying whether to use strict parsing semantics. </summary> <param name="predicate">The predicate to initially filter probes by.</param> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the probes.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbes(PrtgAPI.Parameters.ProbeParameters)"> <summary> Retrieves probes from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Probes.</param> <returns>A list of probes that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.Parameters.ProbeParameters)"> <summary> Asynchronously retrieves probes from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Probes.</param> <returns>A list of probes that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamProbes(PrtgAPI.Parameters.ProbeParameters,System.Boolean)"> <summary> Streams probes from a PRTG Server using a custom set of parameters.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Probes.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbes(PrtgAPI.Parameters.ProbeParameters,System.Threading.CancellationToken)"> <summary> Retrieves probes from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Probes.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of probes that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbesAsync(PrtgAPI.Parameters.ProbeParameters,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves probes from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Probes.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of probes that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannel(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32)"> <summary> Retrieves a channel with a specified ID from a PRTG Server. If the channel does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="sensorOrId">The sensor or ID of the sensor containing the channel.</param> <param name="id">The ID of the channel to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified channel does not exist or multiple channels were resolved with the specified ID.</exception> <returns>The channel with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32)"> <summary> Asynchronously retrieves a channel with a specified ID from a PRTG Server. If the channel does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="sensorOrId">The sensor or ID of the sensor containing the channel.</param> <param name="id">The ID of the channel to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified channel does not exist or multiple channels were resolved with the specified ID.</exception> <returns>The channel with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a channel with a specified ID from a PRTG Server with a specified cancellation token. If the channel does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="sensorOrId">The sensor or ID of the sensor containing the channel.</param> <param name="id">The ID of the channel to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified channel does not exist or multiple channels were resolved with the specified ID.</exception> <returns>The channel with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannel(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.String)"> <summary> Retrieves a channel with a specified name from a PRTG Server. If the channel does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="sensorOrId">The sensor or ID of the sensor containing the channel.</param> <param name="name">The name of the channel to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified channel does not exist or multiple channels were resolved with the specified name.</exception> <returns>The channel with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.String)"> <summary> Asynchronously retrieves a channel with a specified name from a PRTG Server. If the channel does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="sensorOrId">The sensor or ID of the sensor containing the channel.</param> <param name="name">The name of the channel to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified channel does not exist or multiple channels were resolved with the specified name.</exception> <returns>The channel with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a channel with a specified name from a PRTG Server with a specified cancellation token. If the channel does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="sensorOrId">The sensor or ID of the sensor containing the channel.</param> <param name="name">The name of the channel to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified channel does not exist or multiple channels were resolved with the specified name.</exception> <returns>The channel with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannels(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32})"> <summary> Retrieves all channels of a sensor. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve channels for.</param> <returns>A list of channels on the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelsAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32})"> <summary> Asynchronously retrieves all channels of a sensor. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve channels for.</param> <returns>A list of channels on the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelsAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all channels of a sensor with a specified cancellation token. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve channels for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of channels on the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannels(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.String)"> <summary> Retrieves all channels of a sensor that match the specified name. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve channels for.</param> <param name="name">The name of the channel to retrieve.</param> <returns>A list of channels on the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelsAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.String)"> <summary> Asynchronously retrieves all channels of a sensor that match the specified name. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve channels for.</param> <param name="name">The name of the channel to retrieve.</param> <returns>A list of channels on the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetChannelsAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all channels of a sensor that match the specified name with a specified cancellation token. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve channels for.</param> <param name="name">The name of the channel to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of channels on the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogs(System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Retrieves logs between two time periods from a PRTG Server. Logs are ordered from newest to oldest. </summary> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Asynchronously retrieves logs between two time periods from a PRTG Server. Logs are ordered from newest to oldest. </summary> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves logs between two time periods from a PRTG Server with a specified cancellation token. Logs are ordered from newest to oldest. </summary> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamLogs(System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Boolean,PrtgAPI.LogStatus[])"> <summary> Streams logs between two time periods from a PRTG Server. If <paramref name="serial"/> is true, logs are guaranteed to be ordered from newest to oldest. </summary> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. If this value is null, all logs will be retrieved within the specified timespan.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogs(System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Retrieves logs between two time periods from a PRTG Server for a specified object. Logs are ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Asynchronously retrieves logs between two time periods from a PRTG Server for a specified object. Logs are ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},PrtgAPI.LogStatus[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves logs between two time periods from a PRTG Server for a specified object with a specified cancellation token. Logs are ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamLogs(System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Boolean,PrtgAPI.LogStatus[])"> <summary> Streams logs between two time periods from a PRTG Server for a specified object. If <paramref name="serial"/> is true, logs are guaranteed to be ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="startDate">Start date to retrieve logs from. If this value is null, logs will be retrieved from the current date and time.</param> <param name="endDate">End date to retrieve logs to. If this value is null, logs will be retrieved until the beginning of all logs.</param> <param name="count">Number of logs to retrieve. If this value is null, all logs will be retrieved within the specified timespan.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogs(PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Retrieves logs for a standard time period from a PRTG Server. Logs are ordered from newest to oldest. </summary> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Asynchronously retrieves logs for a standard time period from a PRTG Server. Logs are ordered from newest to oldest. </summary> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves logs for a standard time period from a PRTG Server with a specified cancellation token. Logs are ordered from newest to oldest. </summary> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamLogs(PrtgAPI.RecordAge,System.Nullable{System.Int32},System.Boolean,PrtgAPI.LogStatus[])"> <summary> Streams logs for a standard time period from a PRTG Server. If <paramref name="serial"/> is true, logs are guaranteed to be ordered from newest to oldest. </summary> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. If this value is null, all logs will be retrieved within the specified timespan.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogs(System.Int32,PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Retrieves logs from a standard time period from a PRTG Server for a specified object. Logs are ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(System.Int32,PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[])"> <summary> Asynchronously retrieves logs from a standard time period from a PRTG Server for a specified object. Logs are ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(System.Int32,PrtgAPI.RecordAge,System.Nullable{System.Int32},PrtgAPI.LogStatus[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves logs from a standard time period from a PRTG Server for a specified object with a specified cancellation token. Logs are ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. Depending on the number of logs stored in the system, specifying a high number may cause the request to timeout.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamLogs(System.Int32,PrtgAPI.RecordAge,System.Nullable{System.Int32},System.Boolean,PrtgAPI.LogStatus[])"> <summary> Streams logs from a standard time period from a PRTG Server for a specified object. If <paramref name="serial"/> is true, logs are guaranteed to be ordered from newest to oldest. </summary> <param name="objectId">ID of the object to retrieve logs from. If this value is 0, logs will be retrieved from the root group.</param> <param name="recordAge">Time period to retrieve logs from. Logs will be retrieved from the beginning of this period until the current date and time, ordered newest to oldest.</param> <param name="count">Number of logs to retrieve. If this value is null, all logs will be retrieved within the specified timespan.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <returns>All logs that meet the specified criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryLogs"> <summary> Retrieves logs from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions.<para/> If a lower date range is not specified, logs will be retrieved between the upper range and the beginning of all logs. If an upper range is not specified, logs will be retrieved from the current date and time. If an Id is not specified, logs will be retrieved for all objects. </summary> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryLogs(System.Boolean)"> <summary> Retrieves logs from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions using strict parsing semantics.<para/> If a lower date range is not specified, logs will be retrieved between the upper range and the beginning of all logs. If an upper range is not specified, logs will be retrieved from the current date and time. If an Id is not specified, logs will be retrieved for all objects. </summary> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> to be wrapped by <see cref="T:System.Linq.Queryable"/> LINQ Expressions.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryLogs(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Log,System.Boolean}})"> <summary> Retrieves logs from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter logs according to a specified predicate.<para/> If a lower date range is not specified in any predicate, logs will be retrieved between the upper range and the beginning of all logs. If an upper range is not specified, logs will be retrieved from the current date and time. If an Id is not specified, logs will be retrieved for all objects. </summary> <param name="predicate">The predicate to initially filter logs by.</param> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the logs.</returns> </member> <member name="M:PrtgAPI.PrtgClient.QueryLogs(System.Linq.Expressions.Expression{System.Func{PrtgAPI.Log,System.Boolean}},System.Boolean)"> <summary> Retrieves logs from a PRTG Server based on one or more <see cref="T:System.Linq.Queryable"/> expressions, starting with an expression to filter logs according to a specified predicate and specifying whether to use strict parsing semantics.<para/> If a lower date range is not specified in any predicate, logs will be retrieved between the upper range and the beginning of all logs. If an upper range is not specified, logs will be retrieved from the current date and time. If an Id is not specified, logs will be retrieved for all objects. </summary> <param name="predicate">The predicate to initially filter logs by.</param> <param name="strict">Whether to use strict evaluation. If true, a <see cref="T:System.NotSupportedException"/> will be thrown if an expression is encountered that cannot be evaluated server side.<para/>If <paramref name="strict"/> is false, the maximal supported expression will be executed server side, with any remaining expressions executed client side.</param> <exception cref="T:System.NotSupportedException">An expression was specified that cannot be evaluated server side.</exception> <returns>An <see cref="T:System.Linq.IQueryable`1"/> representing the result of filtering the logs.</returns> </member> <member name="M:PrtgAPI.PrtgClient.WatchLogs(PrtgAPI.LogStatus[],System.Int32,System.Func{System.Int32,System.Boolean},System.Threading.CancellationToken)"> <summary> Continuously streams logs from a PRTG Server. This method will not end until you stop requesting items from it, <paramref name="progressCallback"/> returns false or the specified <see cref="T:System.Threading.CancellationToken"/> is cancelled.<para/> Logs are ordered from oldest to newest. </summary> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <param name="interval">Interval (in seconds) with which PrtgAPI should poll for new logs.</param> <param name="progressCallback">Callback used to indicate how many records have been retrieved and whether to abort retrieving records. Called between each polling attempt. Takes the number of records retrieved so far as an argument. If this method returns false, streaming will abort.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>All logs that meet the specified criteria between the first log retrieved and when streaming is ended.</returns> </member> <member name="M:PrtgAPI.PrtgClient.WatchLogs(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.LogStatus[],System.Int32,System.Func{System.Int32,System.Boolean},System.Threading.CancellationToken)"> <summary> Continuously streams logs for a specified object from a PRTG Server. This method will not end until you stop requesting items from it, <paramref name="progressCallback"/> returns false or the specified <see cref="T:System.Threading.CancellationToken"/> is cancelled.<para/> Logs are ordered from oldest to newest. </summary> <param name="objectOrId">The object or ID of the object to retrieve logs for.</param> <param name="status">Log event types to retrieve records for. If no types are specified, all record types will be retrieved.</param> <param name="interval">Interval (in seconds) with which PrtgAPI should poll for new logs.</param> <param name="progressCallback">Callback used to indicate how many records have been retrieved and whether to abort retrieving records. Called between each polling attempt. Takes the number of records retrieved so far as an argument. If this method returns false, streaming will abort.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>All logs that meet the specified criteria between the first log retrieved and when streaming is ended.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogs(PrtgAPI.Parameters.LogParameters)"> <summary> Retrieves logs from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Logs.</param> <returns>A list of logs that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(PrtgAPI.Parameters.LogParameters)"> <summary> Asynchronously retrieves logs from a PRTG Server using a custom set of parameters. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Logs.</param> <returns>A list of logs that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamLogs(PrtgAPI.Parameters.LogParameters,System.Boolean)"> <summary> Streams logs from a PRTG Server using a custom set of parameters.<para/> If <paramref name="serial"/> is false, when this method's response is enumerated multiple parallel requests will be executed against the PRTG Server and yielded in the order they return.<para/> Otherwise, requests will be serially executed as the response is enumerated. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Logs.</param> <param name="serial">Specifies whether PrtgAPI should execute all requests one at a time rather than all at once.</param> <returns>If <paramref name="serial"/> is false, a generator encapsulating a series of <see cref="T:System.Threading.Tasks.Task"/> objects capable of streaming a response from a PRTG Server. Otherwise, an enumeration that when iterated retrieves the specified objects.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogs(PrtgAPI.Parameters.LogParameters,System.Threading.CancellationToken)"> <summary> Retrieves logs from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Logs.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of logs that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetLogsAsync(PrtgAPI.Parameters.LogParameters,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves logs from a PRTG Server using a custom set of parameters with a specified cancellation token. </summary> <param name="parameters">A custom set of parameters used to retrieve PRTG Logs.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of logs that match the specified parameters.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationAction(System.Int32)"> <summary> Retrieves a notification action with a specified ID from a PRTG Server.<para/> If the notification action does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the notification action to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified notification action does not exist or multiple notification actions were resolved with the specified ID.</exception> <returns>The notification action with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionAsync(System.Int32)"> <summary> Asynchronously retrieves a notification action with a specified ID from a PRTG Server.<para/> If the notification action does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the notification action to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified notification action does not exist or multiple notification actions were resolved with the specified ID.</exception> <returns>The notification action with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a notification action with a specified ID from a PRTG Server with a specified cancellation token.<para/> If the notification action does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the notification action to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified notification action does not exist or multiple notification actions were resolved with the specified ID.</exception> <returns>The notification action with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationAction(System.String)"> <summary> Retrieves a notification action with a specified name from a PRTG Server. If the notification action does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="name">The name of the notification action to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified notification action does not exist or multiple notification actions were resolved with the specified name.</exception> <returns>The notification action with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionAsync(System.String)"> <summary> Asynchronously retrieves a notification action with a specified name from a PRTG Server. If the notification action does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="name">The name of the notification action to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified notification action does not exist or multiple notification actions were resolved with the specified name.</exception> <returns>The notification action with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a notification action with a specified name from a PRTG Server with a specified cancellation token. If the notification action does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="name">The name of the notification action to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified notification action does not exist or multiple notification actions were resolved with the specified name.</exception> <returns>The notification action with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActions"> <summary> Retrieves all notification actions from a PRTG Server. </summary> <returns>A list of all notification actions on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionsAsync"> <summary> Asynchronously retrieves all notification actions from a PRTG Server. </summary> <returns>A list of all notification actions on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionsAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all notification actions from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all notification actions on a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActions(PrtgAPI.Property,System.Object)"> <summary> Retrieves notification actions from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of notification actions that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionsAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves notification actions from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of notification actions that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionsAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves notification actions from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of notification actions that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActions(PrtgAPI.SearchFilter[])"> <summary> Retrieves notification actions from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of notification actions that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionsAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves notification actions from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of notification actions that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationActionsAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves notification actions from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of notification actions that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationTriggers(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Retrieves all notification triggers of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object to retrieve triggers for.</param> <returns>A list of notification triggers that apply to the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationTriggersAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Asynchronously retrieves all notification triggers of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object to retrieve triggers for.</param> <returns>A list of notification triggers that apply to the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationTriggersAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all notification triggers of a PRTG Object with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to retrieve triggers for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of notification triggers that apply to the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationTriggerTypes(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Retrieves all notification trigger types supported by a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object to retrieve supported trigger types for.</param> <returns>The trigger types supported by the object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationTriggerTypesAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Asynchronously retrieves all notification trigger types supported by a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object to retrieve supported trigger types for.</param> <returns>The trigger types supported by the object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetNotificationTriggerTypesAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all notification trigger types supported by a PRTG Object with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to retrieve supported trigger types for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The trigger types supported by the object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedule(System.Int32)"> <summary> Retrieves a monitoring schedule with a specified ID from a PRTG Server.<para/> If the schedule does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the schedule to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified schedule does not exist or multiple schedules were resolved with the specified ID.</exception> <returns>The schedule with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetScheduleAsync(System.Int32)"> <summary> Asynchronously retrieves a monitoring schedule with a specified ID from a PRTG Server.<para/> If the schedule does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the schedule to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified schedule does not exist or multiple schedules were resolved with the specified ID.</exception> <returns>The schedule with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetScheduleAsync(System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a monitoring schedule with a specified ID from a PRTG Server with a specified cancellation token.<para/> If the schedule does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="id">The ID of the schedule to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified schedule does not exist or multiple schedules were resolved with the specified ID.</exception> <returns>The schedule with the specified ID.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedule(System.String)"> <summary> Retrieves a monitoring schedule with a specified name from a PRTG Server.<para/> If the schedule does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="name">The name of the schedule to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified schedule does not exist or multiple schedules were resolved with the specified name.</exception> <returns>The schedule with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetScheduleAsync(System.String)"> <summary> Asynchronously retrieves a monitoring schedule with a specified name from a PRTG Server.<para/> If the schedule does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="name">The name of the schedule to retrieve.</param> <exception cref="T:System.InvalidOperationException">The specified schedule does not exist or multiple schedules were resolved with the specified name.</exception> <returns>The schedule with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetScheduleAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a monitoring schedule with a specified name from a PRTG Server with a specified cancellation token.<para/> If the schedule does not exist or an ambiguous match is found, an <see cref="T:System.InvalidOperationException"/> is thrown. </summary> <param name="name">The name of the schedule to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified schedule does not exist or multiple schedules were resolved with the specified name.</exception> <returns>The schedule with the specified name.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedules"> <summary> Retrieves all monitoring schedules from a PRTG Server. </summary> <returns>A list of all monitoring schedules supported by a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedulesAsync"> <summary> Asynchronously retrieves all monitoring schedules from a PRTG Server. </summary> <returns>A list of all monitoring schedules supported by a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedulesAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all monitoring schedules from a PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all monitoring schedules supported by a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedules(PrtgAPI.Property,System.Object)"> <summary> Retrieves monitoring schedules from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of schedules that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedulesAsync(PrtgAPI.Property,System.Object)"> <summary> Asynchronously retrieves monitoring schedules from a PRTG Server based on the value of a certain property. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <returns>A list of schedules that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedulesAsync(PrtgAPI.Property,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves monitoring schedules from a PRTG Server based on the value of a certain property with a specified cancellation token. </summary> <param name="property">Property to search against.</param> <param name="value">Value to search for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of schedules that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedules(PrtgAPI.SearchFilter[])"> <summary> Retrieves monitoring schedules from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of schedules that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedulesAsync(PrtgAPI.SearchFilter[])"> <summary> Asynchronously retrieves monitoring schedules from a PRTG Server, filtering for objects based on one or more conditions. </summary> <param name="filters">One or more filters used to limit search results.</param> <returns>A list of schedules that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSchedulesAsync(PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously retrieves monitoring schedules from a PRTG Server, filtering for objects based on one or more conditions with a specified cancellation token. </summary> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of schedules that match the specified search criteria.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorHistory(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32})"> <summary> Retrieves the historical values of a sensor's channels from within a specified time period. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve historical data for.</param> <param name="average">The time span (in seconds) to average results up to. For example, a value of 300 shows the average of results every 5 minutes. If a value of 0 is used, PRTG will use the true interval of the sensor.<para/> Note: due to limitations of the PRTG API, value lookup labels can only be retrieved when the average is 0, while downtime information can only be retrieved when the average is not 0.</param> <param name="startDate">The start date and time to retrieve data from. If this value is null, records will be retrieved from the current date and time.</param> <param name="endDate">The end date and time to retrieve data to. If this value is null, records will be retrieved from one hour prior to <paramref name="startDate"/>.</param> <param name="count">Limit results to the specified number of items within the specified time period.</param> <returns>Historical data for the specified sensor within the desired date range.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorHistoryAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves the historical values of a sensor's channels from within a specified time period. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve historical data for.</param> <param name="average">The time span (in seconds) to average results up to. For example, a value of 300 shows the average of results every 5 minutes. If a value of 0 is used, PRTG will use the true interval of the sensor.<para/> Note: due to limitations of the PRTG API, value lookup labels can only be retrieved when the average is 0, while downtime information can only be retrieved when the average is not 0.</param> <param name="startDate">The start date and time to retrieve data from. If this value is null, records will be retrieved from the current date and time.</param> <param name="endDate">The end date and time to retrieve data to. If this value is null, records will be retrieved from one hour prior to <paramref name="startDate"/>.</param> <param name="count">Limit results to the specified number of items within the specified time period.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>Historical data for the specified sensor within the desired date range.</returns> </member> <member name="M:PrtgAPI.PrtgClient.StreamSensorHistory(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime})"> <summary> Streams the historical values of a sensor's channels from within a specified time period. When this method's response is enumerated, requests will be sent to PRTG as required in order to retrieve additional items. </summary> <param name="sensorOrId">The sensor or ID of the sensor to retrieve historical data for.</param> <param name="average">The time span (in seconds) to average results up to. For example, a value of 300 shows the average of results every 5 minutes. If a value of 0 is used, PRTG will use the true interval of the sensor.<para/> Note: due to limitations of the PRTG API, value lookup labels can only be retrieved when the average is 0, while downtime information can only be retrieved when the average is not 0.</param> <param name="startDate">The start date and time to retrieve data from. If this value is null, records will be retrieved from the current date and time.</param> <param name="endDate">The end date and time to retrieve data to. If this value is null, records will be retrieved from one hour prior to <paramref name="startDate"/>.</param> <returns>A generator encapsulating a series of requests capable of streaming a response from a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetModificationHistory(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Retrieves the setting/state modification history of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object to retrieve historical records for.</param> <returns>A list of all setting/state modifications to the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetModificationHistoryAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Asynchronously retrieves the setting/state modification history of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object to retrieve historical records for.</param> <returns>A list of all setting/state modifications to the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetModificationHistoryAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves the setting/state modification history of a PRTG Object with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to retrieve historical records for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A list of all setting/state modifications to the specified object.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetStatus"> <summary> Retrieves configuration, status and version details of the PRTG Server. </summary> <returns>Status details of a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetStatusAsync"> <summary> Asynchronously retrieves configuration, status and version details of the PRTG Server. </summary> <returns>Status details of a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetStatusAsync(System.Threading.CancellationToken)"> <summary> Asynchronously retrieves configuration, status and version details of the PRTG Server with a specified cancellation token. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>Status details of a PRTG Server.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfo(PrtgAPI.Either{PrtgAPI.Device,System.Int32})"> <summary> Retrieves System Information including hardware, software, process, service and user information for a specified device.<para/> System Information is automatically refreshed by PRTG once every 24 hours. Devices are not guaranteed to support all system information types. </summary> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <returns>A complete summary of System Information known to PRTG for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfoAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32})"> <summary> Asynchronously retrieves System Information including hardware, software, process, service and user information for a specified device.<para/> System Information is automatically refreshed by PRTG once every 24 hours. Devices are not guaranteed to support all system information types. </summary> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <returns>A complete summary of System Information known to PRTG for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfoAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves System Information including hardware, software, process, service and user information for a specified device with a specified cancellation token.<para/> System Information is automatically refreshed by PRTG once every 24 hours. Devices are not guaranteed to support all system information types. </summary> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A complete summary of System Information known to PRTG for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfo``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32})"> <summary> Retrieves a specific type of system information for a specified device based on the resulting object type. </summary> <typeparam name="T">Type of System Information to retrieve.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <returns>System Information known to PRTG for the specified information type for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfoAsync``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32})"> <summary> Asynchronously retrieves a specific type of system information for a specified device based on the resulting object type. </summary> <typeparam name="T">Type of System Information to retrieve.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <returns>System Information known to PRTG for the specified information type for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfoAsync``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a specific type of system information for a specified device based on the resulting object type with a specified cancellation token. </summary> <typeparam name="T">Type of System Information to retrieve.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>System Information known to PRTG for the specified information type for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfo(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SystemInfoType)"> <summary> Retrieves a specific type of system information for a specified device based on a <see cref="T:PrtgAPI.SystemInfoType"/>. </summary> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <param name="type">Type of information to retrieve.</param> <returns>System Information known to PRTG for the specified information type for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfoAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SystemInfoType)"> <summary> Asynchronously retrieves a specific type of system information for a specified device based on a <see cref="T:PrtgAPI.SystemInfoType"/>. </summary> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <param name="type">Type of information to retrieve.</param> <returns>System Information known to PRTG for the specified information type for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSystemInfoAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SystemInfoType,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a specific type of system information for a specified device based on a <see cref="T:PrtgAPI.SystemInfoType"/> with a specified cancellation token. </summary> <param name="deviceOrId">The device or ID of the device to retrieve information for.</param> <param name="type">Type of information to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>System Information known to PRTG for the specified information type for the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.RefreshSystemInfo(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SystemInfoType[])"> <summary> Refreshes one or more types of system information on a specified device.<para/> If no types are specified, all information types will be refreshed. </summary> <param name="deviceOrId">The device or ID of the device to refresh system information for.</param> <param name="types">Types to refresh. If no types are specified, all types will be refreshed.</param> </member> <member name="M:PrtgAPI.PrtgClient.RefreshSystemInfoAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SystemInfoType[])"> <summary> Asynchronously refreshes one or more types of system information on a specified device.<para/> If no types are specified, all information types will be refreshed. </summary> <param name="deviceOrId">The device or ID of the device to refresh system information for.</param> <param name="types">Types to refresh. If no types are specified, all types will be refreshed.</param> </member> <member name="M:PrtgAPI.PrtgClient.RefreshSystemInfoAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SystemInfoType[],System.Threading.CancellationToken)"> <summary> Asynchronously refreshes one or more types of system information on a specified device with a specified cancellation token.<para/> If no types are specified, all information types will be refreshed. </summary> <param name="deviceOrId">The device or ID of the device to refresh system information for.</param> <param name="types">Types to refresh. If no types are specified, all types will be refreshed.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.GetTotalObjects(PrtgAPI.Content)"> <summary> Calculates the total number of objects of a given type present on a PRTG Server. </summary> <param name="content">The type of object to total.</param> <returns>The total number of objects of the given type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetTotalObjectsAsync(PrtgAPI.Content)"> <summary> Asynchronously calculates the total number of objects of a given type present on a PRTG Server. </summary> <param name="content">The type of object to total.</param> <returns>The total number of objects of the given type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetTotalObjectsAsync(PrtgAPI.Content,System.Threading.CancellationToken)"> <summary> Asynchronously calculates the total number of objects of a given type present on a PRTG Server with a specified cancellation token. </summary> <param name="content">The type of object to total.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The total number of objects of the given type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetTotalObjects(PrtgAPI.Content,PrtgAPI.SearchFilter[])"> <summary> Calculates the total number of objects of a given type present on a PRTG Server that match one or more search criteria. </summary> <param name="content">The type of object to total.</param> <param name="filters">One or more filters used to limit search results.</param> <returns>The total number of objects of the given type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetTotalObjectsAsync(PrtgAPI.Content,PrtgAPI.SearchFilter[])"> <summary> Asynchronously calculates the total number of objects of a given type present on a PRTG Server that match one or more search criteria. </summary> <param name="content">The type of object to total.</param> <param name="filters">One or more filters used to limit search results.</param> <returns>The total number of objects of the given type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetTotalObjectsAsync(PrtgAPI.Content,PrtgAPI.SearchFilter[],System.Threading.CancellationToken)"> <summary> Asynchronously calculates the total number of objects of a given type present on a PRTG Server that match one or more search criteria with a specified cancellation token. </summary> <param name="content">The type of object to total.</param> <param name="filters">One or more filters used to limit search results.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The total number of objects of the given type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddSensor(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.Parameters.NewSensorParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Adds a new sensor to a PRTG device. Based on the specified sensor parameters, multiple new sensors may be created. </summary> <param name="deviceOrId">The device or ID of the device the sensor will apply to.</param> <param name="parameters">A set of parameters describing the properties of the sensor to create. Depending on the type of sensor parameters specified, this may result in the creation of several new sensors.</param> <param name="resolve">Whether to resolve the new sensors to their resultant <see cref="T:PrtgAPI.Sensor"/> objects. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, all new sensors that were created from the sensor <paramref name="parameters"/>. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddSensorAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.Parameters.NewSensorParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously adds a new sensor to a PRTG device. Based on the specified sensor parameters, multiple new sensors may be created. </summary> <param name="deviceOrId">The device or ID of the device the sensor will apply to.</param> <param name="parameters">A set of parameters describing the properties of the sensor to create. Depending on the type of sensor parameters specified, this may result in the creation of several new sensors.</param> <param name="resolve">Whether to resolve the new sensors to their resultant <see cref="T:PrtgAPI.Sensor"/> objects. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, all new sensors that were created from the sensor <paramref name="parameters"/>. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddDevice(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},System.String,System.String,PrtgAPI.AutoDiscoveryMode,System.Boolean,System.Threading.CancellationToken)"> <summary> Adds a new device to a PRTG group or probe. </summary> <param name="parent">The group or probe the device will apply to.</param> <param name="name">The name to use for the new device.</param> <param name="host">The hostname or IP Address PRTG should use to communicate with the device. If this value is null, the <paramref name="name"/> will be used.</param> <param name="discoveryMode">Whether an auto-discovery should be automatically performed after device creation.</param> <param name="resolve">Whether to resolve the new device to its resultant <see cref="T:PrtgAPI.Device"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the device that was created from this method's device parameters. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddDeviceAsync(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},System.String,System.String,PrtgAPI.AutoDiscoveryMode,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously adds a new device to a PRTG group or probe. </summary> <param name="parent">The group or probe the device will apply to.</param> <param name="name">The name to use for the new device.</param> <param name="host">The hostname or IP Address PRTG should use to communicate with the device. If this value is null, the <paramref name="name"/> will be used.</param> <param name="discoveryMode">Whether an auto-discovery should be automatically performed after device creation.</param> <param name="resolve">Whether to resolve the new device to its resultant <see cref="T:PrtgAPI.Device"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the device that was created from this method's device parameters. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddDevice(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},PrtgAPI.Parameters.NewDeviceParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Adds a new device to a PRTG group or probe with a complex set of parameters. </summary> <param name="parent">The group or probe the device will apply to.</param> <param name="parameters">A set of parameters describing the properties of the device to create.</param> <param name="resolve">Whether to resolve the new device to its resultant <see cref="T:PrtgAPI.Device"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the device that was created from this method's device <paramref name="parameters"/>. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddDeviceAsync(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},PrtgAPI.Parameters.NewDeviceParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously adds a new device to a PRTG group or probe with a complex set of parameters. </summary> <param name="parent">The group or probe the device will apply to.</param> <param name="parameters">A set of parameters describing the properties of the device to create.</param> <param name="resolve">Whether to resolve the new device to its resultant <see cref="T:PrtgAPI.Device"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the device that was created from this method's device <paramref name="parameters"/>. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddGroup(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Adds a new group to a PRTG group or probe. </summary> <param name="parent">The group or probe the new group will apply to.</param> <param name="name">The name to use for the new group.</param> <param name="resolve">Whether to resolve the new group to its resultant <see cref="T:PrtgAPI.Group"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the group that was created from this method's group parameters. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddGroupAsync(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously adds a new group to a PRTG group or probe. </summary> <param name="parent">The group or probe the new group will apply to.</param> <param name="name">The name to use for the new group.</param> <param name="resolve">Whether to resolve the new group to its resultant <see cref="T:PrtgAPI.Group"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the group that was created from this method's group parameters. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddGroup(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},PrtgAPI.Parameters.NewGroupParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Adds a new group to a PRTG group or probe with a complex set of parameters. </summary> <param name="parent">The group or probe the new group will apply to.</param> <param name="parameters">A set of parameters describing the properties of the group to create.</param> <param name="resolve">Whether to resolve the new group to its resultant <see cref="T:PrtgAPI.Group"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the group that was created from this method's group <paramref name="parameters"/>. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddGroupAsync(PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},PrtgAPI.Parameters.NewGroupParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously adds a new group to a PRTG group or probe with a complex set of parameters. </summary> <param name="parent">The group or probe the new group will apply to.</param> <param name="parameters">A set of parameters describing the properties of the group to create.</param> <param name="resolve">Whether to resolve the new group to its resultant <see cref="T:PrtgAPI.Group"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the group that was created from this method's group <paramref name="parameters"/>. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDynamicSensorParameters(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Creates a set of dynamic sensor parameters for creating a new sensor of a specified type. </summary> <param name="deviceOrId">The device or ID of a device that supports the specified sensor type.</param> <param name="sensorType">The type of sensor to create sensor paramters for.<para/> Note: sensor parameters cannot be created for types that require additional information to be added before interrogating the target device.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor parameters to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.TimeoutException">Sensor parameters failed to resolve within the specified timespan.</exception> <returns>A dynamic set of sensor parameters that store the the parameters required to create a sensor of a specified type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDynamicSensorParametersAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously creates a set of dynamic sensor parameters for creating a new sensor of a specified type. </summary> <param name="deviceOrId">The device or ID of a device that supports the specified sensor type.</param> <param name="sensorType">The type of sensor to create sensor paramters for.<para/> Note: sensor parameters cannot be created for types that require additional information to be added before interrogating the target device.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor parameters to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.TimeoutException">Sensor parameters failed to resolve within the specified timespan.</exception> <returns>A dynamic set of sensor parameters that store the the parameters required to create a sensor of a specified type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AutoDiscover(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.DeviceTemplate[])"> <summary> Automatically creates sensors under an object based on the object's (or it's children's) device type. </summary> <param name="objectOrId">The object or ID of the object to run Auto-Discovery for (such as a device or group).</param> <param name="templates">An optional list of device templates to use for performing the auto-discovery.</param> </member> <member name="M:PrtgAPI.PrtgClient.AutoDiscoverAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.DeviceTemplate[])"> <summary> Asynchronously automatically creates sensors under an object based on the object's (or it's children's) device type. </summary> <param name="objectOrId">The object or ID of the object to run Auto-Discovery for (such as a device or group).</param> <param name="templates">An optional list of device templates to use for performing the auto-discovery.</param> </member> <member name="M:PrtgAPI.PrtgClient.AutoDiscoverAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.DeviceTemplate[],System.Threading.CancellationToken)"> <summary> Asynchronously automatically creates sensors under an object based on the object's (or it's children's) device type with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to run Auto-Discovery for (such as a device or group).</param> <param name="templates">An optional list of device templates to use for performing the auto-discovery.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.AcknowledgeSensor(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Nullable{System.Int32},System.String)"> <summary> Marks a <see cref="F:PrtgAPI.Status.Down"/> sensor as <see cref="F:PrtgAPI.Status.DownAcknowledged"/>. If an acknowledged sensor returns to <see cref="F:PrtgAPI.Status.Up"/>, it will not be acknowledged when it goes down again. </summary> <param name="sensorOrId">The sensor or ID of the sensor to acknowledge.</param> <param name="duration">Duration (in minutes) to acknowledge the sensor for. If null, sensor will be acknowledged indefinitely.</param> <param name="message">Message to display on the acknowledged sensor.</param> </member> <member name="M:PrtgAPI.PrtgClient.AcknowledgeSensor(System.Int32[],System.Nullable{System.Int32},System.String)"> <summary> Marks one or more <see cref="F:PrtgAPI.Status.Down"/> sensors as <see cref="F:PrtgAPI.Status.DownAcknowledged"/>. If an acknowledged sensor returns to <see cref="F:PrtgAPI.Status.Up"/>, it will not be acknowledged when it goes down again. </summary> <param name="sensorIds">IDs of the sensors to acknowledge.</param> <param name="duration">Duration (in minutes) to acknowledge the sensors for. If null, sensors will be acknowledged indefinitely.</param> <param name="message">Message to display on the acknowledged sensors.</param> </member> <member name="M:PrtgAPI.PrtgClient.AcknowledgeSensorAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously marks a <see cref="F:PrtgAPI.Status.Down"/> sensor as <see cref="F:PrtgAPI.Status.DownAcknowledged"/>. If an acknowledged sensor returns to <see cref="F:PrtgAPI.Status.Up"/>, it will not be acknowledged when it goes down again. </summary> <param name="sensorOrId">The sensor or ID of the sensor to acknowledge.</param> <param name="duration">Duration (in minutes) to acknowledge the sensor for. If null, sensor will be acknowledged indefinitely.</param> <param name="message">Message to display on the acknowledged sensor.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.AcknowledgeSensorAsync(System.Int32[],System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously marks one or more <see cref="F:PrtgAPI.Status.Down"/> sensors as <see cref="F:PrtgAPI.Status.DownAcknowledged"/>. If an acknowledged sensor returns to <see cref="F:PrtgAPI.Status.Up"/>, it will not be acknowledged when it goes down again. </summary> <param name="sensorIds">IDs of the sensors to acknowledge.</param> <param name="duration">Duration (in minutes) to acknowledge the sensors for. If null, sensors will be acknowledged indefinitely.</param> <param name="message">Message to display on the acknowledged sensors.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.PauseObject(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Nullable{System.Int32},System.String)"> <summary> Pauses monitoring on a PRTG Object and all child objects. </summary> <param name="objectOrId">The object or ID of the object to pause.</param> <param name="duration">Duration (in minutes) to pause the object for. If null, object will be paused indefinitely.</param> <param name="message">Message to display on the paused object.</param> </member> <member name="M:PrtgAPI.PrtgClient.PauseObject(System.Int32[],System.Nullable{System.Int32},System.String)"> <summary> Pauses monitoring on one or more PRTG Objects and all child objects. </summary> <param name="objectIds">IDs of the objects to pause.</param> <param name="duration">Duration (in minutes) to pause the object for. If null, object will be paused indefinitely.</param> <param name="message">Message to display on the paused objects.</param> </member> <member name="M:PrtgAPI.PrtgClient.PauseObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously pauses monitoring on a PRTG Object and all child objects. </summary> <param name="objectOrId">The object or ID of the object to pause.</param> <param name="duration">Duration (in minutes) to pause the object for. If null, object will be paused indefinitely.</param> <param name="message">Message to display on the paused object.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.PauseObjectAsync(System.Int32[],System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously pauses monitoring on one or more PRTG Objects and all child objects. </summary> <param name="objectIds">IDs of the objects to pause.</param> <param name="duration">Duration (in minutes) to pause the object for. If null, object will be paused indefinitely.</param> <param name="message">Message to display on the paused objects.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.ResumeObject(System.Int32[])"> <summary> Resumes monitoring on one or more PRTG Objects (including sensors, devices, groups and probes) from a Paused or Simulated Error state. </summary> <param name="objectIds">IDs of the objects to resume.</param> </member> <member name="M:PrtgAPI.PrtgClient.ResumeObjectAsync(System.Int32[])"> <summary> Asynchronously resumes monitoring on one or more PRTG Objects (including sensors, devices, groups and probes) from a Paused or Simulated Error state. </summary> <param name="objectIds">IDs of the objects to resume.</param> </member> <member name="M:PrtgAPI.PrtgClient.ResumeObjectAsync(System.Int32[],System.Threading.CancellationToken)"> <summary> Asynchronously resumes monitoring on one or more PRTG Objects (including sensors, devices, groups and probes) from a Paused or Simulated Error state with a specified cancellation token. </summary> <param name="objectIds">IDs of the objects to resume.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SimulateError(System.Int32[])"> <summary> Simulates a <see cref="F:PrtgAPI.Status.Down"/> state for one or more sensors. </summary> <param name="sensorIds">IDs of the sensors to simulate an error for.</param> </member> <member name="M:PrtgAPI.PrtgClient.SimulateErrorAsync(System.Int32[])"> <summary> Asynchronously simulates a <see cref="F:PrtgAPI.Status.Down"/> state for one or more sensors. </summary> <param name="sensorIds">IDs of the sensors to simulate an error for.</param> </member> <member name="M:PrtgAPI.PrtgClient.SimulateErrorAsync(System.Int32[],System.Threading.CancellationToken)"> <summary> Asynchronously simulates a <see cref="F:PrtgAPI.Status.Down"/> state for one or more sensors with a specified cancellation token. </summary> <param name="sensorIds">IDs of the sensors to simulate an error for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.AddNotificationTrigger(PrtgAPI.Parameters.TriggerParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Adds a notification trigger to an object specified by a set of trigger parameters. </summary> <param name="parameters">A set of parameters describing the type of notification trigger to create and the object to apply it to.</param> <param name="resolve">Whether to resolve the new trigger to its resultant <see cref="T:PrtgAPI.NotificationTrigger"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the trigger that was created from this method's trigger parameters. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.AddNotificationTriggerAsync(PrtgAPI.Parameters.TriggerParameters,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously adds a notification trigger to an object specified by a set of trigger parameters. </summary> <param name="parameters">A set of parameters describing the type of notification trigger to create and the object to apply it to.</param> <param name="resolve">Whether to resolve the new trigger to its resultant <see cref="T:PrtgAPI.NotificationTrigger"/> object. If this value is false, this method will return null.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>If <paramref name="resolve"/> is true, the trigger that was created from this method's trigger parameters. Otherwise, null.</returns> </member> <member name="M:PrtgAPI.PrtgClient.SetNotificationTrigger(PrtgAPI.Parameters.TriggerParameters)"> <summary> Adds or edits a notification trigger on an object specified by a set of trigger parameters. </summary> <param name="parameters">A set of parameters describing the type of notification trigger and how to manipulate it.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetNotificationTriggerAsync(PrtgAPI.Parameters.TriggerParameters)"> <summary> Asynchronously adds or edits a notification trigger on an object specified by a set of trigger parameters. </summary> <param name="parameters">A set of parameters describing the type of notification trigger and how to manipulate it.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetNotificationTriggerAsync(PrtgAPI.Parameters.TriggerParameters,System.Threading.CancellationToken)"> <summary> Asynchronously adds or edits a notification trigger on an object specified by a set of trigger parameters with a specified cancellation token. </summary> <param name="parameters">A set of parameters describing the type of notification trigger and how to manipulate it.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.RemoveNotificationTrigger(PrtgAPI.NotificationTrigger)"> <summary> Removes a notification trigger from an object.<para/> Triggers can only be removed from their parent objects, and cannot be removed from objects that have inherited them. </summary> <param name="trigger">The notification trigger to remove.</param> <exception cref="T:System.InvalidOperationException">The <paramref name="trigger"/> was inherited from another object.</exception> </member> <member name="M:PrtgAPI.PrtgClient.RemoveNotificationTriggerAsync(PrtgAPI.NotificationTrigger)"> <summary> Asynchronously removes a notification trigger from an object.<para/> Triggers can only be removed from their parent objects, and cannot be removed from objects that have inherited them. </summary> <param name="trigger">The notification trigger to remove.</param> <exception cref="T:System.InvalidOperationException">The <paramref name="trigger"/> was inherited from another object.</exception> </member> <member name="M:PrtgAPI.PrtgClient.RemoveNotificationTriggerAsync(PrtgAPI.NotificationTrigger,System.Threading.CancellationToken)"> <summary> Asynchronously removes a notification trigger from an object with a specified cancellation token.<para/> Triggers can only be removed from their parent objects, and cannot be removed from objects that have inherited them. </summary> <param name="trigger">The notification trigger to remove.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The <paramref name="trigger"/> was inherited from another object.</exception> </member> <member name="M:PrtgAPI.PrtgClient.CloneObject(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,PrtgAPI.Either{PrtgAPI.DeviceOrGroupOrProbe,System.Int32})"> <summary> Clones a sensor or group to another device or group. </summary> <param name="sourceObject">The sensor or group to clone.</param> <param name="cloneName">The name that should be given to the cloned object.</param> <param name="targetParentObject">If this is a sensor, the device or ID of the device to clone to. If this is a group, the object or ID of the group or probe to clone to.</param> <returns>The ID of the object that was created.</returns> </member> <member name="M:PrtgAPI.PrtgClient.CloneObject(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.String,PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32})"> <summary> Clones a device to another group or probe. </summary> <param name="deviceOrId">The device or ID of the device to clone.</param> <param name="cloneName">The name that should be given to the cloned device.</param> <param name="host">The hostname or IP Address that should be assigned to the new device.</param> <param name="targetParentObject">The group or probe the device should be cloned to.</param> <returns>The ID of the object that was created.</returns> </member> <member name="M:PrtgAPI.PrtgClient.CloneObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,PrtgAPI.Either{PrtgAPI.DeviceOrGroupOrProbe,System.Int32})"> <summary> Asynchronously clones a sensor or group to another device or group. </summary> <param name="sourceObject">The sensor or group to clone.</param> <param name="cloneName">The name that should be given to the cloned object.</param> <param name="targetParentObject">If this is a sensor, the device or ID of the device to clone to. If this is a group, the object or ID of the group or probe to clone to.</param> <returns>The ID of the object that was created.</returns> </member> <member name="M:PrtgAPI.PrtgClient.CloneObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,PrtgAPI.Either{PrtgAPI.DeviceOrGroupOrProbe,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously clones a sensor or group to another device or group with a specified cancellation token. </summary> <param name="sourceObject">The sensor or group to clone.</param> <param name="cloneName">The name that should be given to the cloned object.</param> <param name="targetParentObject">If this is a sensor, the device or ID of the device to clone to. If this is a group, the object or ID of the group or probe to clone to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The ID of the object that was created.</returns> </member> <member name="M:PrtgAPI.PrtgClient.CloneObjectAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.String,PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32})"> <summary> Asynchronously clones a device to another group or probe. </summary> <param name="deviceOrId">The device or ID of the device to clone.</param> <param name="cloneName">The name that should be given to the cloned device.</param> <param name="host">The hostname or IP Address that should be assigned to the new device.</param> <param name="targetParentObject">The group or probe the device should be cloned to.</param> <returns>The ID of the object that was created.</returns> </member> <member name="M:PrtgAPI.PrtgClient.CloneObjectAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.String,PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously clones a device to another group or probe with a specified cancellation token. </summary> <param name="deviceOrId">The device or ID of the device to clone.</param> <param name="cloneName">The name that should be given to the cloned device.</param> <param name="host">The hostname or IP Address that should be assigned to the new device.</param> <param name="targetParentObject">The group or probe the device should be cloned to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The ID of the object that was created.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorProperties(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32})"> <summary> Retrieves properties and settings of a PRTG Sensor.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="sensor">The sensor or ID of the sensor to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified sensor is read only. To retrieve properties from read only sensors, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorPropertiesAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32})"> <summary> Asynchronously retrieves properties and settings of a PRTG Sensor.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="sensor">The sensor or ID of the sensor to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified sensor is read only. To retrieve properties from read only sensors, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorPropertiesAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves properties and settings of a PRTG Sensor with a specified cancellation token.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="sensor">The sensor or ID of the sensor to retrieve settings for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified sensor is read only. To retrieve properties from read only sensors, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified sensor.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDeviceProperties(PrtgAPI.Either{PrtgAPI.Device,System.Int32})"> <summary> Retrieves properties and settings of a PRTG Device.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="device">The device or ID of the device to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified device is read only. To retrieve properties from read only devices, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicePropertiesAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32})"> <summary> Asynchronously retrieves properties and settings of a PRTG Device.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="device">The device or ID of the device to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified device is read only. To retrieve properties from read only devices, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetDevicePropertiesAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves properties and settings of a PRTG Device with a specified cancellation token.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="device">The device or ID of the device to retrieve settings for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified device is read only. To retrieve properties from read only devices, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified device.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupProperties(PrtgAPI.Either{PrtgAPI.Group,System.Int32})"> <summary> Retrieves properties and settings of a PRTG Group.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="group">The group or ID of the group to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified group is read only. To retrieve properties from read only groups, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified group.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupPropertiesAsync(PrtgAPI.Either{PrtgAPI.Group,System.Int32})"> <summary> Asynchronously retrieves properties and settings of a PRTG Group.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="group">The group or ID of the group to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified group is read only. To retrieve properties from read only groups, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified group.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetGroupPropertiesAsync(PrtgAPI.Either{PrtgAPI.Group,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves properties and settings of a PRTG Group with a specified cancellation token.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="group">The group or ID of the group to retrieve settings for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified group is read only. To retrieve properties from read only groups, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified group.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbeProperties(PrtgAPI.Either{PrtgAPI.Probe,System.Int32})"> <summary> Retrieves properties and settings of a PRTG Probe.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="probe">The probe or ID of the probe to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified probe is read only. To retrieve properties from read only probes, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified probe.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbePropertiesAsync(PrtgAPI.Either{PrtgAPI.Probe,System.Int32})"> <summary> Asynchronously retrieves properties and settings of a PRTG Probe.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="probe">The probe or ID of the probe to retrieve settings for.</param> <exception cref="T:System.InvalidOperationException">The specified probe is read only. To retrieve properties from read only probes, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified probe.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetProbePropertiesAsync(PrtgAPI.Either{PrtgAPI.Probe,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously retrieves properties and settings of a PRTG Probe with a specified cancellation token.<para/> If the current user does not have write access to the specified object, an <see cref="T:System.InvalidOperationException"/> will be thrown. </summary> <param name="probe">The probe or ID of the probe to retrieve settings for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified probe is read only. To retrieve properties from read only probes, use <see cref="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"/>.</exception> <returns>All settings of the specified probe.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertiesRaw(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectType)"> <summary> Retrieves all raw properties and settings of a PRTG Object. Note: objects may have additional properties that cannot be retrieved via this method. </summary> <param name="objectOrId">The object or ID of the object to retrieve settings and properties for.</param> <param name="objectType">The type of object to retrieve settings and properties for.</param> <returns>A dictionary mapping all discoverable properties to raw values.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertiesRaw(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String)"> <summary> Retrieves all raw properties and settings of an unsupported object type. Note: objects may have additional properties that cannot be retrieved via this method. </summary> <param name="objectOrId">The object or ID of the object to retrieve settings and properties for.</param> <param name="objectType">The type of object to retrieve settings and properties for. If this value is null, PRTG will attempt to guess the object type based on the specified <paramref name="objectOrId"/>.</param> <returns>A dictionary mapping all discoverable properties to raw values.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertiesRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectType)"> <summary> Asynchronously retrieves all raw properties and settings of a PRTG Object. Note: objects may have additional properties that cannot be retrieved via this method. </summary> <param name="objectOrId">The object or ID of the object to retrieve settings and properties for.</param> <param name="objectType">The type of object to retrieve settings and properties for.</param> <returns>A dictionary mapping all discoverable properties to raw values.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertiesRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectType,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all raw properties and settings of a PRTG Object with a specified cancellation token. Note: objects may have additional properties that cannot be retrieved via this method. </summary> <param name="objectOrId">The object or ID of the object to retrieve settings and properties for.</param> <param name="objectType">The type of object to retrieve settings and properties for.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A dictionary mapping all discoverable properties to raw values.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertiesRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves all raw properties and settings of an unsupported object type. Note: objects may have additional properties that cannot be retrieved via this method. </summary> <param name="objectOrId">The object or ID of the object to retrieve settings and properties for.</param> <param name="objectType">The type of object to retrieve settings and properties for. If this value is null, PRTG will attempt to guess the object type based on the specified <paramref name="objectOrId"/>.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A dictionary mapping all discoverable properties to raw values.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"> <summary> Retrieves a type safe property from a PRTG Server. </summary> <param name="objectOrId">The object or ID of the object to retrieve the property from.</param> <param name="property">The well known property to retrieve.</param> <returns>A type safe representation of the specified property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"> <summary> Asynchronously retrieves a type safe property from a PRTG Server. </summary> <param name="objectOrId">The object or ID of the object to retrieve the property from.</param> <param name="property">The well known property to retrieve.</param> <returns>A type safe representation of the specified property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a type safe property from a PRTG Server with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to retrieve the property from.</param> <param name="property">The well known property to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>A type safe representation of the specified property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectProperty``1(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"> <summary> Retrieves a type safe property from a PRTG Server, cast to its actual type. If the deserialized value is not of the type specified, an <see cref="T:System.InvalidCastException"/> will be thrown. </summary> <typeparam name="T">The type to cast the object to.</typeparam> <param name="objectOrId">The object or ID of the object to retrieve the property from.</param> <param name="property">The well known property to retrieve.</param> <exception cref="T:System.InvalidCastException">The deserialized value could not be cast to the specified type.</exception> <returns>A type safe representation of the specified property, cast to its actual type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyAsync``1(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty)"> <summary> Asynchronously retrieves a type safe property from a PRTG Server, cast to its actual type. If the deserialized value is not of the type specified, an <see cref="T:System.InvalidCastException"/> will be thrown. </summary> <typeparam name="T">The type to cast the object to.</typeparam> <param name="objectOrId">The object or ID of the object to retrieve the property from.</param> <param name="property">The well known property to retrieve.</param> <exception cref="T:System.InvalidCastException">The deserialized value could not be cast to the specified type.</exception> <returns>A type safe representation of the specified property, cast to its actual type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyAsync``1(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves a type safe property from a PRTG Server, cast to its actual type with a specified cancellation token. If the deserialized value is not of the type specified, an <see cref="T:System.InvalidCastException"/> will be thrown. </summary> <typeparam name="T">The type to cast the object to.</typeparam> <param name="objectOrId">The object or ID of the object to retrieve the property from.</param> <param name="property">The well known property to retrieve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidCastException">The deserialized value could not be cast to the specified type.</exception> <returns>A type safe representation of the specified property, cast to its actual type.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyRaw(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.Boolean)"> <summary> Retrieves unsupported properties and settings of a PRTG Object.<para/> If the specified property does not exist, a <see cref="T:PrtgAPI.PrtgRequestException"/> will be thrown, unless the PRTG Server is not in English, in which case "(Property not found)" will be returned in your server's native language. </summary> <param name="objectOrId">The object or ID of the object whose property should be retrieved.</param> <param name="property">The property of the object to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="text">If true, displays option properties using their label names instead of their internal numeric values.</param> <exception cref="T:PrtgAPI.PrtgRequestException">The specified property does not exist and the PRTG Server's language is English.</exception> <returns>The raw value of the object's property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves unsupported properties and settings of a PRTG Object.<para/> If the specified property does not exist, a <see cref="T:PrtgAPI.PrtgRequestException"/> will be thrown, unless the PRTG Server is not in English, in which case "(Property not found)" will be returned in your server's native language. </summary> <param name="objectOrId">The object or ID of the object whose property should be retrieved.</param> <param name="property">The property of the object to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="text">If true, displays option properties using their label names instead of their internal numeric values.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:PrtgAPI.PrtgRequestException">The specified property does not exist and the PRTG Server's language is English.</exception> <returns>The raw value of the object's property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyRaw(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32,System.String,System.String,System.Boolean)"> <summary> Retrieves unsupported properties and settings of a PRTG <see cref="T:PrtgAPI.ISubObject"/> such as Channels and Notification Triggers.<para/> If the specified property does not exist, a <see cref="T:PrtgAPI.PrtgRequestException"/> will be thrown, unless the PRTG Server is not in English, in which case "(Property not found)" will be returned in your server's native language. </summary> <param name="objectOrId">The object or ID of the object whose property should be retrieved.</param> <param name="subId">The ID of the sub object whose property should be retrieved.</param> <param name="subType">The type of sub object to retrieve the property from.</param> <param name="property">The property of the object to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="text">If true, displays option properties using their label names instead of their internal numeric values.</param> <exception cref="T:PrtgAPI.PrtgRequestException">The specified property does not exist and the PRTG Server's language is English.</exception> <returns>The raw value of the sub object's property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetObjectPropertyRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Int32,System.String,System.String,System.Boolean,System.Threading.CancellationToken)"> <summary> Asynchronously retrieves unsupported properties and settings of a PRTG <see cref="T:PrtgAPI.ISubObject"/> such as Channels and Notification Triggers.<para/> If the specified property does not exist, a <see cref="T:PrtgAPI.PrtgRequestException"/> will be thrown, unless the PRTG Server is not in English, in which case "(Property not found)" will be returned in your server's native language. </summary> <param name="objectOrId">The object or ID of the object whose property should be retrieved.</param> <param name="subId">The ID of the sub object whose property should be retrieved.</param> <param name="subType">The type of sub object to retrieve the property from.</param> <param name="property">The property of the object to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="text">If true, displays option properties using their label names instead of their internal numeric values.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:PrtgAPI.PrtgRequestException">The specified property does not exist and the PRTG Server's language is English.</exception> <returns>The raw value of the sub object's property.</returns> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty,System.Object)"> <summary> Modifies properties and settings of a PRTG Object.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="property">The property of the object to modify.</param> <param name="value">The value to set the object's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectProperty(System.Int32[],PrtgAPI.ObjectProperty,System.Object)"> <summary> Modifies properties and settings of one or more PRTG Objects.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="property">The property of each object to modify.</param> <param name="value">The value to set each object's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty,System.Object)"> <summary> Asynchronously modifies properties and settings of a PRTG Object.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="property">The property of the object to modify.</param> <param name="value">The value to set the object's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.ObjectProperty,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously modifies properties and settings of a PRTG Object with a specified cancellation token.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="property">The property of the object to modify.</param> <param name="value">The value to set the object's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(System.Int32[],PrtgAPI.ObjectProperty,System.Object)"> <summary> Asynchronously modifies properties and settings of one or more PRTG Objects.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="property">The property of each object to modify.</param> <param name="value">The value to set each object's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(System.Int32[],PrtgAPI.ObjectProperty,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously modifies properties and settings of one or more PRTG Objects with a specified cancellation token.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="property">The property of each object to modify.</param> <param name="value">The value to set each object's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectProperty(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Parameters.PropertyParameter[])"> <summary> Modifies multiple properties of a PRTG Object.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectProperty(System.Int32[],PrtgAPI.Parameters.PropertyParameter[])"> <summary> Modifies multiple properties of one or more PRTG Objects.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Parameters.PropertyParameter[])"> <summary> Asynchronously modifies multiple properties of a PRTG Object.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Parameters.PropertyParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies multiple properties of a PRTG Object with a specified cancellation token.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(System.Int32[],PrtgAPI.Parameters.PropertyParameter[])"> <summary> Asynchronously modifies multiple properties of one or more PRTG Objects.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyAsync(System.Int32[],PrtgAPI.Parameters.PropertyParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies multiple properties of one or more PRTG Objects with a specified cancellation token.<para/> Each <see cref="T:PrtgAPI.ObjectProperty"/> corresponds with a Property of a type derived from <see cref="T:PrtgAPI.ObjectSettings"/>.<para/> If PrtgAPI cannot convert the specified value to the type required by the property, PrtgAPI will throw an exception indicating the type that was expected. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Channel,PrtgAPI.ChannelProperty,System.Object)"> <summary> Modifies a property of a PRTG Channel. </summary> <param name="channel">The channel to modify.</param> <param name="property">The property whose value should be modified.</param> <param name="value">The value to set the property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Channel,PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Modifies a property of a PRTG Channel with a specified cancellation token. </summary> <param name="channel">The channel to modify.</param> <param name="property">The property whose value should be modified.</param> <param name="value">The value to set the property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.ChannelProperty,System.Object)"> <summary> Modifies a property of one or more PRTG Channels. </summary> <param name="channels">The channels to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Modifies a property of one or more PRTG Channels with a specified cancellation token. </summary> <param name="channels">The channels to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Channel,PrtgAPI.ChannelProperty,System.Object)"> <summary> Asynchronously modifies a property of a PRTG Channel. </summary> <param name="channel">The channel to modify.</param> <param name="property">The property whose value should be modified.</param> <param name="value">The value to set the property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Channel,PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously modifies a property of a PRTG Channel with a specified cancellation token. </summary> <param name="channel">The channel to modify.</param> <param name="property">The property whose value should be modified.</param> <param name="value">The value to set the property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.ChannelProperty,System.Object)"> <summary> Asynchronously modifies a property of one or more PRTG Channels. </summary> <param name="channels">The channels to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously modifies a property of one or more PRTG Channels with a specified cancellation token. </summary> <param name="channels">The channels to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Channel,PrtgAPI.Parameters.ChannelParameter[])"> <summary> Modifies one or more properties of a PRTG Channel. </summary> <param name="channel">The channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Channel,PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Modifies one or more properties of a PRTG Channel with a specified cancellation token. </summary> <param name="channel">The channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.Parameters.ChannelParameter[])"> <summary> Modifies multiple properties of one or more PRTG Channels. </summary> <param name="channels">The channels to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Modifies multiple properties of one or more PRTG Channels with a specified cancellation token. </summary> <param name="channels">The channels to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Channel,PrtgAPI.Parameters.ChannelParameter[])"> <summary> Asynchronously modifies one or more properties of a PRTG Channel. </summary> <param name="channel">The channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Channel,PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies one or more properties of a PRTG Channel with a specified cancellation token. </summary> <param name="channel">The channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.Parameters.ChannelParameter[])"> <summary> Asynchronously modifies multiple properties of one or more PRTG Channels. </summary> <param name="channels">The channels to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Collections.Generic.IEnumerable{PrtgAPI.Channel},PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies multiple properties of one or more PRTG Channels with a specified cancellation token. </summary> <param name="channels">The channels to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.ChannelProperty,System.Object)"> <summary> Modifies a property of a PRTG Channel based on its Sensor ID and Channel ID. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="property">The property of the channel to modify.</param> <param name="value">The value to set the channel's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Modifies a property of a PRTG Channel based on its Sensor ID and Channel ID with a specified cancellation token. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="property">The property of the channel to modify.</param> <param name="value">The value to set the channel's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Int32[],System.Int32,PrtgAPI.ChannelProperty,System.Object)"> <summary> Modifies a property of PRTG Channels with a given Channel ID across one or more PRTG Sensors. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Int32[],System.Int32,PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Modifies a property of PRTG Channels with a given Channel ID across one or more PRTG Sensors with a specified cancellation token. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.ChannelProperty,System.Object)"> <summary> Asynchronously modifies a property of a PRTG Channel based on its Sensor ID and Channel ID. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="property">The property of the channel to modify.</param> <param name="value">The value to set the channel's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously modifies a property of a PRTG Channel based on its Sensor ID and Channel ID with a specified cancellation token. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="property">The property of the channel to modify.</param> <param name="value">The value to set the channel's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Int32[],System.Int32,PrtgAPI.ChannelProperty,System.Object)"> <summary> Asynchronously modifies a property of PRTG Channels with a given Channel ID across one or more PRTG Sensors. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Int32[],System.Int32,PrtgAPI.ChannelProperty,System.Object,System.Threading.CancellationToken)"> <summary> Asynchronously modifies a property of PRTG Channels with a given Channel ID across one or more PRTG Sensors with a specified cancellation token. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="property">The property of each channel to modify.</param> <param name="value">The value to set each channel's property to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.Parameters.ChannelParameter[])"> <summary> Modifies one or more properties of a PRTG Channel based on its Sensor ID and Channel ID. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Modifies one or more properties of a PRTG Channel based on its Sensor ID and Channel ID with a specified cancellation token. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Int32[],System.Int32,PrtgAPI.Parameters.ChannelParameter[])"> <summary> Modifies multiple properties of PRTG Channels with a given Channel ID across one or more PRTG Sensors. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelProperty(System.Int32[],System.Int32,PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Modifies multiple properties of PRTG Channels with a given Channel ID across one or more PRTG Sensors with a specified cancellation token. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.Parameters.ChannelParameter[])"> <summary> Asynchronously modifies one or more properties of a PRTG Channel based on its Sensor ID and Channel ID. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(PrtgAPI.Either{PrtgAPI.Sensor,System.Int32},System.Int32,PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies one or more properties of a PRTG Channel based on its Sensor ID and Channel ID with a specified cancellation token. </summary> <param name="sensorOrId">The sensor or ID of the sensor whose channels should be modified.</param> <param name="channelId">The ID of the channel to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Int32[],System.Int32,PrtgAPI.Parameters.ChannelParameter[])"> <summary> Asynchronously modifies multiple properties of PRTG Channels with a given Channel ID across one or more PRTG Sensors. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetChannelPropertyAsync(System.Int32[],System.Int32,PrtgAPI.Parameters.ChannelParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies multiple properties of PRTG Channels with a given Channel ID across one or more PRTG Sensors with a specified cancellation token. </summary> <param name="sensorIds">The IDs of the sensors whose channels should be modified.</param> <param name="channelId">The ID of the channel of each sensor to modify.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRaw(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.String)"> <summary> Modifies unsupported properties and settings of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="property">The property of the object to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="value">The value to set the object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRaw(System.Int32[],System.String,System.String)"> <summary> Modifies unsupported properties and settings of one or more PRTG Objects. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="property">The property of each object to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="value">The value to set each object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.String)"> <summary> Asynchronously modifies unsupported properties and settings of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="property">The property of the object to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="value">The value to set the object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.String,System.Threading.CancellationToken)"> <summary> Asynchronously modifies unsupported properties and settings of a PRTG Object with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="property">The property of the object to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="value">The value to set the object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(System.Int32[],System.String,System.String)"> <summary> Asynchronously modifies unsupported properties and settings of one or more PRTG Objects. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="property">The property of each object to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="value">The value to set each object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(System.Int32[],System.String,System.String,System.Threading.CancellationToken)"> <summary> Asynchronously modifies unsupported properties and settings of one or more PRTG Objects with a specified cancellation token. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="property">The property of each object to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.<para/> If the properties name ends in an underscore, this must be included.</param> <param name="value">The value to set each object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRaw(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Parameters.CustomParameter[])"> <summary> Modifies multiple unsupported properties of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRaw(System.Int32[],PrtgAPI.Parameters.CustomParameter[])"> <summary> Modifies multiple unsupported properties of one or more PRTG Objects. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Parameters.CustomParameter[])"> <summary> Asynchronously modifies multiple unsupported properties of a PRTG Object. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Parameters.CustomParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies multiple unsupported properties of a PRTG Object with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(System.Int32[],PrtgAPI.Parameters.CustomParameter[])"> <summary> Asynchronously modifies multiple unsupported properties of one or more PRTG Objects. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetObjectPropertyRawAsync(System.Int32[],PrtgAPI.Parameters.CustomParameter[],System.Threading.CancellationToken)"> <summary> Asynchronously modifies multiple unsupported properties of one or more PRTG Objects with a specified cancellation token. </summary> <param name="objectIds">The IDs of the objects whose properties should be modified.</param> <param name="parameters">A set of parameters describing the properties and their values to process.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.BackupConfigDatabase"> <summary> Requests PRTG generate a backup of the PRTG Configuration Database.<para/> When executed, this method will request PRTG store a backup of its configuration database under the Configuration Auto-Backups folder after first writing the current running configuration to disk.<para/> Depending on the size of your database, this may take several seconds to complete. Note that PRTG always creates its backup asynchronously; as such when this method returns the backup may not have fully completed.<para/> By default, configuration backups are stored under C:\ProgramData\Paessler\PRTG Network Monitor\Configuration Auto-Backups. </summary> </member> <member name="M:PrtgAPI.PrtgClient.BackupConfigDatabaseAsync"> <summary> Asynchronously requests PRTG generate a backup of the PRTG Configuration Database.<para/> When executed, this method will request PRTG store a backup of its configuration database under the Configuration Auto-Backups folder after first writing the current running configuration to disk.<para/> Depending on the size of your database, this may take several seconds to complete. Note that PRTG always creates its backup asynchronously; as such when this method returns the backup may not have fully completed.<para/> By default, configuration backups are stored under C:\ProgramData\Paessler\PRTG Network Monitor\Configuration Auto-Backups. </summary> </member> <member name="M:PrtgAPI.PrtgClient.BackupConfigDatabaseAsync(System.Threading.CancellationToken)"> <summary> Asynchronously requests PRTG generate a backup of the PRTG Configuration Database with a specified cancellation token.<para/> When executed, this method will request PRTG store a backup of its configuration database under the Configuration Auto-Backups folder after first writing the current running configuration to disk.<para/> Depending on the size of your database, this may take several seconds to complete. Note that PRTG always creates its backup asynchronously; as such when this method returns the backup may not have fully completed.<para/> By default, configuration backups are stored under C:\ProgramData\Paessler\PRTG Network Monitor\Configuration Auto-Backups. </summary> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.ClearSystemCache(PrtgAPI.SystemCacheType)"> <summary> Clears cached data used by PRTG, including map, graph and authentication caches. Note: clearing certain cache types may result in a restart of the PRTG Core Server. See each cache type for further details. </summary> <param name="cacheType">The type of cache to clear. Note: clearing certain cache types may result in a restart of the PRTG Core Server. See each cache type for further details.</param> </member> <member name="M:PrtgAPI.PrtgClient.ClearSystemCacheAsync(PrtgAPI.SystemCacheType)"> <summary> Asynchronously clears cached data used by PRTG, including map, graph and authentication caches. Note: clearing certain cache types may result in a restart of the PRTG Core Server. See each cache type for further details. </summary> <param name="cacheType">The type of cache to clear. Note: clearing certain cache types may result in a restart of the PRTG Core Server. See each cache type for further details.</param> </member> <member name="M:PrtgAPI.PrtgClient.ClearSystemCacheAsync(PrtgAPI.SystemCacheType,System.Threading.CancellationToken)"> <summary> Asynchronously clears cached data used by PRTG, including map, graph and authentication caches with a specified cancellation token. Note: clearing certain cache types may result in a restart of the PRTG Core Server. See each cache type for further details. </summary> <param name="cacheType">The type of cache to clear. Note: clearing certain cache types may result in a restart of the PRTG Core Server. See each cache type for further details.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.LoadConfigFiles(PrtgAPI.ConfigFileType)"> <summary> Reloads config files including sensor lookups, device icons and report templates used by PRTG. </summary> <param name="fileType">The type of files to reload.</param> </member> <member name="M:PrtgAPI.PrtgClient.LoadConfigFilesAsync(PrtgAPI.ConfigFileType)"> <summary> Asynchronously reloads config files including sensor lookups, device icons and report templates used by PRTG. </summary> <param name="fileType">The type of files to reload.</param> </member> <member name="M:PrtgAPI.PrtgClient.LoadConfigFilesAsync(PrtgAPI.ConfigFileType,System.Threading.CancellationToken)"> <summary> Asynchronously reloads config files including sensor lookups, device icons and report templates used by PRTG with a specified cancellation token. </summary> <param name="fileType">The type of files to reload.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.RestartProbe(PrtgAPI.Either{PrtgAPI.Probe,System.Int32},System.Boolean,System.Func{PrtgAPI.ProbeRestartProgress,System.Boolean},System.Threading.CancellationToken)"> <summary> Restarts the PRTG Probe Service of a specified PRTG Probe.<para/> By default, PrtgAPI will wait 5 seconds between each probing attempt to confirm whether all probes have successfully restarted.<para/> If a progress callback is specified, it is up to the programmer to specify the wait duration between each request. If at any time the progress callback returns false, PrtgAPI will stop waiting for all probes to restart. </summary> <param name="probeOrId">The probe or ID of the probe to restart.</param> <param name="waitForRestart">Whether to wait for the Probe Service on all probes to restart before completing this method.</param> <param name="progressCallback">A callback method to execute upon each request against PRTG to check whether all probes have restarted.</param> <param name="token">A cancellation token to use when waiting for all probes to restart. If cancellation is requested, this method will abort waiting for any remaining probes to restart.</param> </member> <member name="M:PrtgAPI.PrtgClient.RestartProbeAsync(PrtgAPI.Either{PrtgAPI.Probe,System.Int32},System.Boolean,System.Func{PrtgAPI.ProbeRestartProgress,System.Boolean},System.Threading.CancellationToken)"> <summary> Asynchronously restarts the PRTG Probe Service of a specified PRTG Probe.<para/> By default, PrtgAPI will wait 5 seconds between each probing attempt to confirm whether all probes have successfully restarted.<para/> If a progress callback is specified, it is up to the programmer to specify the wait duration between each request. If at any time the progress callback returns false, PrtgAPI will stop waiting for all probes to restart. </summary> <param name="probeOrId">The probe or ID of the probe to restart.</param> <param name="waitForRestart">Whether to wait for the Probe Service on all probes to restart before completing this method.</param> <param name="progressCallback">A callback method to execute upon each request against PRTG to check whether all probes have restarted.</param> <param name="token">A cancellation token to use when waiting for all probes to restart. If cancellation is requested, this method will abort waiting for any remaining probes to restart.</param> </member> <member name="M:PrtgAPI.PrtgClient.RestartProbe(System.Int32[],System.Boolean,System.Func{PrtgAPI.ProbeRestartProgress[],System.Boolean},System.Threading.CancellationToken)"> <summary> Restarts the PRTG Probe Service of one or more PRTG Probes. If no probe ID is specified, the PRTG Probe Service will be restarted on all PRTG Probes.<para/> By default, PrtgAPI will wait 5 seconds between each probing attempt to confirm whether all probes have successfully restarted.<para/> If a progress callback is specified, it is up to the programmer to specify the wait duration between each request. If at any time the progress callback returns false, PrtgAPI will stop waiting for all probes to restart. </summary> <param name="probeIds">The IDs of the probe to restart. If this value is null or empty, the PRTG Probe Service of all probes will be restarted.</param> <param name="waitForRestart">Whether to wait for the Probe Service on all probes to restart before completing this method.</param> <param name="progressCallback">A callback method to execute upon each request against PRTG to check whether all probes have restarted.</param> <param name="token">A cancellation token to use when waiting for all probes to restart. If cancellation is requested, this method will abort waiting for any remaining probes to restart.</param> </member> <member name="M:PrtgAPI.PrtgClient.RestartProbeAsync(System.Int32[],System.Boolean,System.Func{PrtgAPI.ProbeRestartProgress[],System.Boolean},System.Threading.CancellationToken)"> <summary> Asynchronously restarts the PRTG Probe Service of one or more PRTG Probes. If no probe ID is specified, the PRTG Probe Service will be restarted on all PRTG Probes.<para/> By default, PrtgAPI will wait 5 seconds between each probing attempt to confirm whether all probes have successfully restarted.<para/> If a progress callback is specified, it is up to the programmer to specify the wait duration between each request. If at any time the progress callback returns false, PrtgAPI will stop waiting for all probes to restart. </summary> <param name="probeIds">The IDs of the probe to restart. If this value is null or empty, the PRTG Probe Service of all probes will be restarted.</param> <param name="waitForRestart">Whether to wait for the Probe Service on all probes to restart before completing this method.</param> <param name="progressCallback">A callback method to execute upon each request against PRTG to check whether all probes have restarted.</param> <param name="token">A cancellation token to use when waiting for all probes to restart. If cancellation is requested, this method will abort waiting for any remaining probes to restart.</param> </member> <member name="M:PrtgAPI.PrtgClient.RestartCore(System.Boolean,System.Func{PrtgAPI.RestartCoreStage,System.Boolean},System.Threading.CancellationToken)"> <summary> Restarts the PRTG Core Service. This will cause PRTG to disconnect all users and become completely unavailable while the service restarts.<para/> If PRTG is part of a cluster, only the server specified by the current <see cref="T:PrtgAPI.PrtgClient"/> will be restarted.<para/> By default, PrtgAPI will wait 5 seconds between each probing attempt to confirm whether PRTG has successfully restarted.<para/> If a progress callback is specified, it is up to the programmer to specify the wait duration between each request. If at any time the progress callback returns false, PrtgAPI will stop waiting for the core to restart. </summary> <param name="waitForRestart">Whether wait for the Core Service to restart before completing this method.</param> <param name="progressCallback">A callback method to execute upon each request against PRTG to check whether PRTG has restarted.</param> <param name="token">A cancellation token to use when waiting for the Core Service to restart. If cancellation is requested, this method will abort waiting for the core to restart.</param> </member> <member name="M:PrtgAPI.PrtgClient.RestartCoreAsync(System.Boolean,System.Func{PrtgAPI.RestartCoreStage,System.Boolean},System.Threading.CancellationToken)"> <summary> Asynchronously restarts the PRTG Core Service. This will cause PRTG to disconnect all users and become completely unavailable while the service restarts.<para/> If PRTG is part of a cluster, only the server specified by the current <see cref="T:PrtgAPI.PrtgClient"/> will be restarted.<para/> By default, PrtgAPI will wait 5 seconds between each probing attempt to confirm whether PRTG has successfully restarted.<para/> If a progress callback is specified, it is up to the programmer to specify the wait duration between each request. If at any time the progress callback returns false, PrtgAPI will stop waiting for the core to restart. </summary> <param name="waitForRestart">Whether wait for the Core Service to restart before completing this method.</param> <param name="progressCallback">A callback method to execute upon each request against PRTG to check whether PRTG has restarted.</param> <param name="token">A cancellation token to use when waiting for the Core Service to restart. If cancellation is requested, this method will abort waiting for the core to restart.</param> </member> <member name="M:PrtgAPI.PrtgClient.ApproveProbe(PrtgAPI.Either{PrtgAPI.Probe,System.Int32},PrtgAPI.ProbeApproval)"> <summary> Approves or denies a newly installed probe for use within PRTG. </summary> <param name="probeOrId">The probe or ID of the probe to set the approval status of.</param> <param name="action">The approval action to perform for the probe.</param> <exception cref="T:System.InvalidOperationException">The specified object ID is not a probe or is a probe that has already been approved.</exception> </member> <member name="M:PrtgAPI.PrtgClient.ApproveProbeAsync(PrtgAPI.Either{PrtgAPI.Probe,System.Int32},PrtgAPI.ProbeApproval)"> <summary> Asynchronously approves or denies a newly installed probe for use within PRTG. </summary> <param name="probeOrId">The probe or ID of the probe to set the approval status of.</param> <param name="action">The approval action to perform for the probe.</param> <exception cref="T:System.InvalidOperationException">The specified object ID is not a probe or is a probe that has already been approved.</exception> </member> <member name="M:PrtgAPI.PrtgClient.ApproveProbeAsync(PrtgAPI.Either{PrtgAPI.Probe,System.Int32},PrtgAPI.ProbeApproval,System.Threading.CancellationToken)"> <summary> Asynchronously approves or denies a newly installed probe for use within PRTG with a specified cancellation token. </summary> <param name="probeOrId">The probe or ID of the probe to set the approval status of.</param> <param name="action">The approval action to perform for the probe.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <exception cref="T:System.InvalidOperationException">The specified object ID is not a probe or is a probe that has already been approved.</exception> </member> <member name="M:PrtgAPI.PrtgClient.RefreshObject(System.Int32[])"> <summary> Requests an object or any children of one or more objects refresh themselves immediately. </summary> <param name="objectIds">The IDs of the Sensors and/or the IDs of the Probes, Groups or Devices whose child sensors should be refreshed.</param> </member> <member name="M:PrtgAPI.PrtgClient.RefreshObjectAsync(System.Int32[])"> <summary> Asynchronously requests an object or any children of one or more objects refresh themselves immediately. </summary> <param name="objectIds">The IDs of the Sensors and/or the IDs of the Probes, Groups or Devices whose child sensors should be refreshed.</param> </member> <member name="M:PrtgAPI.PrtgClient.RefreshObjectAsync(System.Int32[],System.Threading.CancellationToken)"> <summary> Asynchronously requests an object or any children of one or more objects refresh themselves immediately with a specified cancellation token. </summary> <param name="objectIds">The IDs of the Sensors and/or the IDs of the Probes, Groups or Devices whose child sensors should be refreshed.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetPosition(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Position)"> <summary> Moves the position of an object up or down under its parent within the PRTG User Interface. </summary> <param name="objectOrId">The object or ID of the object to reposition.</param> <param name="position">The direction to move in.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetPosition(PrtgAPI.SensorOrDeviceOrGroupOrProbe,System.Int32)"> <summary> Sets the absolute position of an object under its parent within the PRTG User Interface. </summary> <param name="obj">The object to reposition.</param> <param name="position">The position to move the object to. If this value is higher than the total number of objects under the parent node, the object will be moved to the last possible position.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetPositionAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Position)"> <summary> Asynchronously moves the position of an object up or down under its parent within the PRTG User Interface. </summary> <param name="objectOrId">The object or ID of the object to reposition.</param> <param name="position">The direction to move in.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetPositionAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Position,System.Threading.CancellationToken)"> <summary> Asynchronously moves the position of an object up or down under its parent within the PRTG User Interface with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to reposition.</param> <param name="position">The direction to move in.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetPositionAsync(PrtgAPI.SensorOrDeviceOrGroupOrProbe,System.Int32)"> <summary> Asynchronously sets the absolute position of an object under its parent within the PRTG User Interface. </summary> <param name="obj">The object to reposition.</param> <param name="position">The position to move the object to. If this value is higher than the total number of objects under the parent node, the object will be moved to the last possible position.</param> </member> <member name="M:PrtgAPI.PrtgClient.SetPositionAsync(PrtgAPI.SensorOrDeviceOrGroupOrProbe,System.Int32,System.Threading.CancellationToken)"> <summary> Asynchronously sets the absolute position of an object under its parent within the PRTG User Interface with a specified cancellation token. </summary> <param name="obj">The object to reposition.</param> <param name="position">The position to move the object to. If this value is higher than the total number of objects under the parent node, the object will be moved to the last possible position.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.MoveObject(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32})"> <summary> Moves a device or group (excluding the root group) to another group or probe within PRTG. </summary> <param name="objectOrId">The device or group to move.</param> <param name="destination">The group or probe to move the object to.</param> </member> <member name="M:PrtgAPI.PrtgClient.MoveObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32})"> <summary> Asynchronously moves a device or group (excluding the root group) to another group or probe within PRTG. </summary> <param name="objectOrId">The device or group to move.</param> <param name="destination">The group or probe to move the object to.</param> </member> <member name="M:PrtgAPI.PrtgClient.MoveObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},PrtgAPI.Either{PrtgAPI.GroupOrProbe,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously moves a device or group (excluding the root group) to another group or probe within PRTG with a specified cancellation token. </summary> <param name="objectOrId">The device or group to move.</param> <param name="destination">The group or probe to move the object to.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.SortAlphabetically(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Sorts the children of a device, group or probe alphabetically. </summary> <param name="objectOrId">The object or ID of the object to sort.</param> </member> <member name="M:PrtgAPI.PrtgClient.SortAlphabeticallyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32})"> <summary> Asynchronously sorts the children of a device, group or probe alphabetically. </summary> <param name="objectOrId">The object or ID of the object to sort.</param> </member> <member name="M:PrtgAPI.PrtgClient.SortAlphabeticallyAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.Threading.CancellationToken)"> <summary> Asynchronously sorts the children of a device, group or probe alphabetically with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to sort.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.RemoveObject(System.Int32[])"> <summary> Permanently removes one or more objects such as a Sensor, Device, Group or Probe from PRTG. This cannot be undone. </summary> <param name="objectIds">IDs of the objects to remove.</param> </member> <member name="M:PrtgAPI.PrtgClient.RemoveObjectAsync(System.Int32[])"> <summary> Asynchronously permanently removes one or more objects such as a Sensor, Device, Group or Probe from PRTG. This cannot be undone. </summary> <param name="objectIds">IDs of the objects to remove.</param> </member> <member name="M:PrtgAPI.PrtgClient.RemoveObjectAsync(System.Int32[],System.Threading.CancellationToken)"> <summary> Asynchronously permanently removes one or more objects such as a Sensor, Device, Group or Probe from PRTG with a specified cancellation token. This cannot be undone. </summary> <param name="objectIds">IDs of the objects to remove.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.RenameObject(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String)"> <summary> Renames an object such as a Sensor, Device, Group or Probe within PRTG. </summary> <param name="objectOrId">The object or ID of the object to rename.</param> <param name="name">New name to give the object.</param> </member> <member name="M:PrtgAPI.PrtgClient.RenameObject(System.Int32[],System.String)"> <summary> Renames one or more Sensors, Devices, Groups or Probes within PRTG. </summary> <param name="objectIds">IDs of the objects to rename.</param> <param name="name">New name to give the objects.</param> </member> <member name="M:PrtgAPI.PrtgClient.RenameObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String)"> <summary> Asynchronously renames an object such as a Sensor, Device, Group or Probe within PRTG. </summary> <param name="objectOrId">The object or ID of the object to rename.</param> <param name="name">New name to give the object.</param> </member> <member name="M:PrtgAPI.PrtgClient.RenameObjectAsync(PrtgAPI.Either{PrtgAPI.IPrtgObject,System.Int32},System.String,System.Threading.CancellationToken)"> <summary> Asynchronously renames an object such as a Sensor, Device, Group or Probe within PRTG with a specified cancellation token. </summary> <param name="objectOrId">The object or ID of the object to rename.</param> <param name="name">New name to give the object.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.RenameObjectAsync(System.Int32[],System.String)"> <summary> Asynchronously renames one or more Sensors, Devices, Groups or Probes within PRTG. </summary> <param name="objectIds">IDs of the objects to rename.</param> <param name="name">New name to give the objects.</param> </member> <member name="M:PrtgAPI.PrtgClient.RenameObjectAsync(System.Int32[],System.String,System.Threading.CancellationToken)"> <summary> Asynchronously renames one or more Sensors, Devices, Groups or Probes within PRTG with a specified cancellation token. </summary> <param name="objectIds">IDs of the objects to rename.</param> <param name="name">New name to give the objects.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> </member> <member name="M:PrtgAPI.PrtgClient.ResolveSensorTargets``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SensorType,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken,System.Func{System.String,System.Collections.Generic.List{``0}})"> <summary> Entry point for resolving sensor targets of a supported sensor type. </summary> <typeparam name="T">The type of sensor targets the response should be transformed into.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets from.</param> <param name="sensorType">Type of sensor to retrieve sensor targets for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="parser">Transforms the result of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> to instances of type <typeparamref name="T"/>.</param> <returns>A list of targets that were extracted from PRTG.</returns> </member> <member name="M:PrtgAPI.PrtgClient.ResolveSensorTargets``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken,System.Func{System.String,System.Collections.Generic.List{``0}})"> <summary> Entry point for resolving sensor targets of a raw sensor type. </summary> <typeparam name="T">The type of sensor targets the response should be transformed into.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets from.</param> <param name="sensorType">Type of sensor to retrieve sensor targets for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="parser">Transforms the result of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> to instances of type <typeparamref name="T"/>.</param> <returns>A list of targets that were extracted from PRTG.</returns> </member> <member name="M:PrtgAPI.PrtgClient.ResolveSensorTargets``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.Parameters.BeginAddSensorQueryParameters,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken,System.Func{System.String,System.Collections.Generic.List{``0}})"> <summary> Common entry point for scraping <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> for either a supported or raw sensor type and then transforming the response into a set of sensor targets. </summary> <typeparam name="T">The type of sensor targets the response should be transformed into.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets from.</param> <param name="parameters">A set of parameters for requesting the <see cref="F:PrtgAPI.Parameter.TmpId"/> of either a supported or raw sensor type.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="parser">Transforms the result of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> to instances of type <typeparamref name="T"/>.</param> <returns>A list of targets that were extracted from PRTG.</returns> </member> <member name="M:PrtgAPI.PrtgClient.ResolveSensorTargetsAsync``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.SensorType,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken,System.Func{System.String,System.Collections.Generic.List{``0}})"> <summary> Entry point for resolving sensor targets of a supported sensor type. </summary> <typeparam name="T">The type of sensor targets the response should be transformed into.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets from.</param> <param name="sensorType">Type of sensor to retrieve sensor targets for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="parser">Transforms the result of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> to instances of type <typeparamref name="T"/>.</param> <returns>A list of targets that were extracted from PRTG.</returns> </member> <member name="M:PrtgAPI.PrtgClient.ResolveSensorTargetsAsync``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken,System.Func{System.String,System.Collections.Generic.List{``0}})"> <summary> Entry point for resolving sensor targets of a raw sensor type. </summary> <typeparam name="T">The type of sensor targets the response should be transformed into.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets from.</param> <param name="sensorType">Type of sensor to retrieve sensor targets for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="parser">Transforms the result of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> to instances of type <typeparamref name="T"/>.</param> <returns>A list of targets that were extracted from PRTG.</returns> </member> <member name="M:PrtgAPI.PrtgClient.ResolveSensorTargetsAsync``1(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.Parameters.BeginAddSensorQueryParameters,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken,System.Func{System.String,System.Collections.Generic.List{``0}})"> <summary> Common entry point for scraping <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> for either a supported or raw sensor type and then transforming the response into a set of sensor targets. </summary> <typeparam name="T">The type of sensor targets the response should be transformed into.</typeparam> <param name="deviceOrId">The device or ID of the device to retrieve sensor targets from.</param> <param name="parameters">A set of parameters for requesting the <see cref="F:PrtgAPI.Parameter.TmpId"/> of either a supported or raw sensor type.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <param name="parser">Transforms the result of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> to instances of type <typeparamref name="T"/>.</param> <returns>A list of targets that were extracted from PRTG.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetAddSensorQueryResponse(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Special entry point for constructing parameters from a raw sensor type and retrieving the contents of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> without parsing into sensor targets.. </summary> <param name="deviceOrId">The device or ID of the device to probe.</param> <param name="sensorType">Type of sensor to retrieve parameters for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The contents of the <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> page.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTargetsResponse(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.Parameters.BeginAddSensorQueryParameters,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Entry point for retrieving the raw contents of the <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> page (without performing any post-request manipulations) </summary> <param name="deviceOrId">The device or ID of the device to probe.</param> <param name="parameters">A set of parameters for requesting the <see cref="F:PrtgAPI.Parameter.TmpId"/> of either a supported or raw sensor type.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The contents of the <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> page.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetAddSensorQueryResponseAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},System.String,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Special entry point for constructing parameters from a raw sensor type and retrieving the contents of <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> without parsing into sensor targets.. </summary> <param name="deviceOrId">The device or ID of the device to probe.</param> <param name="sensorType">Type of sensor to retrieve parameters for.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The contents of the <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> page.</returns> </member> <member name="M:PrtgAPI.PrtgClient.GetSensorTargetsResponseAsync(PrtgAPI.Either{PrtgAPI.Device,System.Int32},PrtgAPI.Parameters.BeginAddSensorQueryParameters,System.Func{System.Int32,System.Boolean},System.Int32,System.Threading.CancellationToken)"> <summary> Entry point for retrieving the raw contents of the <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> page (without performing any post-request manipulations) </summary> <param name="deviceOrId">The device or ID of the device to probe.</param> <param name="parameters">A set of parameters for requesting the <see cref="F:PrtgAPI.Parameter.TmpId"/> of either a supported or raw sensor type.</param> <param name="progressCallback">A callback function used to monitor the progress of the request. If this function returns false, the request is aborted and this method returns null.</param> <param name="timeout">Duration (in seconds) to wait for sensor targets to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns>The contents of the <see cref="F:PrtgAPI.HtmlFunction.AddSensor4"/> page.</returns> </member> <member name="F:PrtgAPI.PrtgClient.ConnectionDetails"> <summary> Stores server and authentication details required to connect to a PRTG Server. </summary> </member> <member name="P:PrtgAPI.PrtgClient.RequestEngine"> <summary> Provides access to methods used for executing web requests against a PRTG Server. </summary> </member> <member name="P:PrtgAPI.PrtgClient.ObjectEngine"> <summary> Provides access to methods used for requesting and deserializing objects from a PRTG Server. </summary> </member> <member name="P:PrtgAPI.PrtgClient.Targets"> <summary> Provides methods for retrieving dynamic sensor targets used for creating and modifying sensors. </summary> </member> <member name="P:PrtgAPI.PrtgClient.Server"> <summary> Gets the PRTG server API requests will be made against. </summary> </member> <member name="P:PrtgAPI.PrtgClient.UserName"> <summary> Gets the username that will be used for authenticating API requests. </summary> </member> <member name="P:PrtgAPI.PrtgClient.PassHash"> <summary> Gets the passhash that will be used for authenticating API requests, in place of a password. </summary> </member> <member name="P:PrtgAPI.PrtgClient.RetryCount"> <summary> Gets or sets the number of times to retry a request that times out while communicating with the server. </summary> </member> <member name="P:PrtgAPI.PrtgClient.RetryDelay"> <summary> Gets or sets the base delay (in seconds) between retrying a timed out request. Each successive failure of a given request will wait an additional multiple of this value. </summary> </member> <member name="E:PrtgAPI.PrtgClient.RetryRequest"> <summary> Occurs when a request times out while communicating with the server. </summary> </member> <member name="E:PrtgAPI.PrtgClient.LogVerbose"> <summary> Occurs when a PrtgAPI logs verbose processing information. </summary> </member> <member name="P:PrtgAPI.PrtgClient.LogLevel"> <summary> Specifies the types of events that should be logged by <see cref="E:PrtgAPI.PrtgClient.LogVerbose"/>. </summary> </member> <member name="P:PrtgAPI.PrtgClient.Version"> <summary> Gets the version of PRTG Network Monitor this client is connected to. </summary> </member> <member name="P:PrtgAPI.PrtgClient.DefaultCancellationToken"> <summary> The default <see cref="T:System.Threading.CancellationToken"/> token to use in requests when a token is not otherwise specified. </summary> </member> <member name="M:PrtgAPI.PrtgClient.#ctor(System.String,System.String,System.String,PrtgAPI.AuthMode,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgClient"/> class. </summary> <param name="server">The server to connect to. If a protocol is not specified, HTTPS will be used.</param> <param name="username">The username to authenticate with.</param> <param name="password">The password or passhash to authenticate with.</param> <param name="authMode">Whether the <paramref name="password"/> refers to a password or passhash. If a password is specified, this will automatically be resolved to a passhash.</param> <param name="ignoreSSL">Whether to ignore all SSL errors retuned by <paramref name="server"/>. Affects all requests to your server for the life of your program.</param> </member> <member name="M:PrtgAPI.PrtgClient.ResolveAddress(System.String,System.Threading.CancellationToken)"> <summary> Resolves an address to its latitudinal and longitudinal coordinates. May spuriously return no results. </summary> <param name="address">The address to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns></returns> </member> <member name="M:PrtgAPI.PrtgClient.ResolveAddressAsync(System.String,System.Threading.CancellationToken)"> <summary> Asynchronously resolves an address to its latitudinal and longitudinal coordinates. May spuriously return no results. </summary> <param name="address">The address to resolve.</param> <param name="token">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param> <returns></returns> </member> <member name="T:PrtgAPI.StringEnum`1"> <summary> Provides a type safe wrapper around a string value that may or may not be convertable to a specified enum type. </summary> <typeparam name="TEnum">The type of enum to convert to.</typeparam> </member> <member name="P:PrtgAPI.StringEnum`1.Value"> <summary> Gets the type safe enum version of <see cref="P:PrtgAPI.StringEnum`1.StringValue"/>. If <see cref="P:PrtgAPI.StringEnum`1.StringValue"/> is not convertable to type <typeparamref name="TEnum"/>, this value is null. </summary> </member> <member name="P:PrtgAPI.StringEnum`1.StringValue"> <summary> Gets the raw string value encapsulated by this wrapper.<para/>If only a string value is provided when this object is instantiated, the string value may be changed during construction if the <see cref="P:PrtgAPI.StringEnum`1.Value"/> has a <see cref="T:System.ComponentModel.DescriptionAttribute"/>. </summary> </member> <member name="M:PrtgAPI.StringEnum`1.#ctor(`0)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.StringEnum`1"/> class with a specified enum value.<para/> The <see cref="P:PrtgAPI.StringEnum`1.StringValue"/> will be derlived from the enum's <see cref="T:System.Xml.Serialization.XmlEnumAttribute"/> or <see cref="T:System.ComponentModel.DescriptionAttribute"/> if applicable. </summary> <param name="enumValue">The enum to encapsulate.</param> </member> <member name="M:PrtgAPI.StringEnum`1.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.StringEnum`1"/> class with a specified string value. </summary> <param name="stringValue">The string value to encapsulate.</param> </member> <member name="M:PrtgAPI.StringEnum`1.#ctor(System.String,`0)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.StringEnum`1"/> class with a specified enum and string value. </summary> <param name="stringValue">The string value to encapsulate.</param> <param name="enumValue">The enum value to encapsulate.</param> </member> <member name="M:PrtgAPI.StringEnum`1.op_Equality(PrtgAPI.StringEnum{`0},PrtgAPI.StringEnum{`0})"> <summary> Determines whether two values of type <see cref="T:PrtgAPI.StringEnum`1"/> are equal. </summary> <param name="first">The first value to compare.</param> <param name="second">The second value to compare.</param> <returns>True if both values have the same <see cref="P:PrtgAPI.StringEnum`1.Value"/> or <see cref="P:PrtgAPI.StringEnum`1.StringValue"/>. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.StringEnum`1.op_Inequality(PrtgAPI.StringEnum{`0},PrtgAPI.StringEnum{`0})"> <summary> Determines whether two values of type <see cref="T:PrtgAPI.StringEnum`1"/> are not equal. </summary> <param name="first">The first value to compare.</param> <param name="second">The second value to compare.</param> <returns>True if both values have a different <see cref="P:PrtgAPI.StringEnum`1.Value"/> and <see cref="P:PrtgAPI.StringEnum`1.StringValue"/>. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.StringEnum`1.op_Implicit(System.String)~PrtgAPI.StringEnum{`0}"> <summary> Creates a new <see cref="T:PrtgAPI.StringEnum`1"/> from a specified string value. </summary> <param name="value">The value to encapsulate.</param> </member> <member name="M:PrtgAPI.StringEnum`1.op_Implicit(`0)~PrtgAPI.StringEnum{`0}"> <summary> Creates a new <see cref="T:PrtgAPI.StringEnum`1"/> from a specified enum value. </summary> <param name="enumValue">The value to encapsulate.</param> </member> <member name="M:PrtgAPI.StringEnum`1.Equals(System.Object)"> <summary> Returns a boolean indicating whether the specified object <paramref name="obj"/> is equal to the current object. The specified object is equal to this if both objects are of the same type and have the same <see cref="P:PrtgAPI.StringEnum`1.Value"/> or <see cref="P:PrtgAPI.StringEnum`1.StringValue"/> (ignoring case). </summary> <param name="obj">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.StringEnum`1.Equals(PrtgAPI.StringEnum{`0})"> <summary> Returns a boolean indicating whetehr the specified <see cref="T:PrtgAPI.StringEnum`1"/> is equal to this object. The specified object is equal if both values have the same <see cref="P:PrtgAPI.StringEnum`1.Value"/> or <see cref="P:PrtgAPI.StringEnum`1.StringValue"/> (ignoring case). </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.StringEnum`1.GetHashCode"> <summary> Returns the hash code for this object. If two objects have the same <see cref="P:PrtgAPI.StringEnum`1.StringValue"/> (ignoring case where the object is a <see cref="T:PrtgAPI.StringEnum`1"/>) they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="M:PrtgAPI.StringEnum`1.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.IEventObject"> <summary> Represents an event that can occur to a <see cref="T:PrtgAPI.IPrtgObject"/>. </summary> </member> <member name="P:PrtgAPI.IEventObject.ObjectId"> <summary> ID of the object the event applies to. </summary> </member> <member name="T:PrtgAPI.IObject"> <summary> Represents an abstract object that can exist within PRTG. </summary> </member> <member name="P:PrtgAPI.IObject.Name"> <summary> The name of this object or the object this object pertains to. </summary> </member> <member name="T:PrtgAPI.IPrtgObject"> <summary> Represents a uniquely identifiable object within PRTG. </summary> </member> <member name="P:PrtgAPI.IPrtgObject.Id"> <summary> Unique identifier of this object within PRTG. </summary> </member> <member name="T:PrtgAPI.ISubObject"> <summary> Represents a child of a <see cref="T:PrtgAPI.IPrtgObject"/> that is not globally identifiable and may exist multiple times across different <see cref="T:PrtgAPI.IPrtgObject"/> instances. </summary> </member> <member name="P:PrtgAPI.ISubObject.SubId"> <summary> The identifier of this object under its parent object. </summary> </member> <member name="T:PrtgAPI.ITableObject"> <summary> Represents an abstract object of an unspecified <see cref="T:PrtgAPI.IObject"/> type capable of appearing in tables.<para/>This type is not considered a concrete implementation of <see cref="T:PrtgAPI.IObject"/>. Implementing types must also implement a real derivation of <see cref="T:PrtgAPI.IObject"/> such as <see cref="T:PrtgAPI.IPrtgObject"/>. </summary> </member> <member name="P:PrtgAPI.ITableObject.Id"> <summary> The unique identifier of this object or the ID of the object this object pertains to. </summary> </member> <member name="P:PrtgAPI.ITableObject.DisplayType"> <summary> The display type of this object or the type of the object this object pertains to. </summary> </member> <member name="P:PrtgAPI.ITableObject.Type"> <summary> The raw type name of this object or the raw type name of the object this object pertains to.. </summary> </member> <member name="P:PrtgAPI.ITableObject.Tags"> <summary> Tags contained on this object or the object this object pertains to. </summary> </member> <member name="P:PrtgAPI.ITableObject.Active"> <summary> Whether or not the object is currently active (in a monitoring state). If false, the object is paused. </summary> </member> <member name="T:PrtgAPI.DeviceTemplate"> <summary> <para type="description">Represents a device template that can be used for performing an auto-discovery.</para> </summary> </member> <member name="P:PrtgAPI.DeviceTemplate.Name"> <summary> Gets the name of the template. </summary> </member> <member name="P:PrtgAPI.DeviceTemplate.Value"> <summary> Gets the config file that defines the device template. Found under C:\Program Files (x86)\PRTG Network Monitor\devicetemplates on the PRTG Core Server. </summary> </member> <member name="M:PrtgAPI.DeviceTemplate.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.DeviceTemplate.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects are of the same type and have the same <see cref="F:PrtgAPI.DeviceTemplate.raw"/> value. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.DeviceTemplate.Equals(PrtgAPI.DeviceTemplate)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects are of the same type and have the same <see cref="F:PrtgAPI.DeviceTemplate.raw"/> value. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.DeviceTemplate.GetHashCode"> <summary> Returns a hash code for this object. If two Device Templates have the same <see cref="F:PrtgAPI.DeviceTemplate.raw"/> value, they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="T:PrtgAPI.TableSettings"> <summary> Settings that are found within table objects in PRTG, including Sensors, Devices, Groups and Probes. </summary> </member> <member name="P:PrtgAPI.TableSettings.InheritProxy"> <summary> Whether to inherit HTTP Proxy settings from the parent object.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Inherit Proxy Settings. </summary> </member> <member name="P:PrtgAPI.TableSettings.ProxyAddress"> <summary> IP Address/DNS name of the proxy server to use for HTTP/HTTPS requests.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Name. </summary> </member> <member name="P:PrtgAPI.TableSettings.ProxyPort"> <summary> Port to use to connect to the proxy server.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Port. </summary> </member> <member name="P:PrtgAPI.TableSettings.ProxyUser"> <summary> Username to use to for proxy server authentication.<para/> Corresponds to Proxy Settings for HTTP Sensors -> User. </summary> </member> <member name="P:PrtgAPI.TableSettings.HasProxyPassword"> <summary> Whether a HTTP/HTTPS proxy password has been set.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Password. </summary> </member> <member name="P:PrtgAPI.TableSettings.InheritInterval"> <summary> Whether to inherit Scanning Interval settings from the parent object.<para/> Corresponds to Scanning Interval -> Inherit Scanning Interval. </summary> </member> <member name="P:PrtgAPI.TableSettings.Interval"> <summary> The scanning interval of this object.<para/> Corresponds to Scanning Interval -> Scanning Interval. </summary> </member> <member name="P:PrtgAPI.TableSettings.IntervalErrorMode"> <summary> How this sensor should react in the event of a sensor query failure.<para/> Corresponds to Scanning Interval -> If a Sensor Query Fails. </summary> </member> <member name="P:PrtgAPI.TableSettings.InheritDependency"> <summary> Whether to inherit Schedules, Dependencies and Maintenance Window settings from the parent object.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Inherit Settings. </summary> </member> <member name="P:PrtgAPI.TableSettings.Schedule"> <summary> The schedule during which monitoring is active. If the schedule is not active, sensors will be <see cref="F:PrtgAPI.Status.PausedBySchedule"/>.<para/> If <see cref="P:PrtgAPI.TableSettings.InheritDependency"/> is set to True, this value will be lost.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Schedule. </summary> </member> <member name="P:PrtgAPI.TableSettings.MaintenanceEnabled"> <summary> Whether a one-time maintenance window has been defined.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Maintenance Window. </summary> </member> <member name="P:PrtgAPI.TableSettings.MaintenanceStart"> <summary> The start time of a one-time maintenance window. If <see cref="P:PrtgAPI.TableSettings.MaintenanceEnabled"/> is false, this property will contain the default maintenance start value.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Maintenance Begins. </summary> </member> <member name="P:PrtgAPI.TableSettings.MaintenanceEnd"> <summary> The end time of a one-time maintenance window. If <see cref="P:PrtgAPI.TableSettings.MaintenanceEnabled"/> is false, this property will contain the default maintenance end value.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Maintenance Ends. </summary> </member> <member name="P:PrtgAPI.TableSettings.DependencyType"> <summary> Indicates the type of object this object uses as its dependency. When the dependency object goes down, this object is <see cref="F:PrtgAPI.Status.PausedByDependency"/>.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Dependency Type. </summary> </member> <member name="P:PrtgAPI.TableSettings.DependentObjectId"> <summary> The custom object to use as a dependency of this object.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Dependency. </summary> </member> <member name="P:PrtgAPI.TableSettings.DependencyDelay"> <summary> Duration (in seconds) to delay resuming this sensor after its master object returns to <see cref="F:PrtgAPI.Status.Up"/>. This property only applies when <see cref="P:PrtgAPI.TableSettings.DependencyType"/> is <see cref="F:PrtgAPI.DependencyType.Object"/>.<para/> Corresponds to Schedules, Dependencies and Maintenance Window -> Dependency Delay. </summary> </member> <member name="P:PrtgAPI.TableSettings.InheritChannelUnit"> <summary> Whether to inherit Channel Unit Configuration settings from the parent object.<para/> Corresponds to Channel Unit Configuration -> Inherit Channel Unit. </summary> </member> <member name="P:PrtgAPI.TableSettings.BandwidthVolumeUnit"> <summary> Unit to use for traffic volume sensor channels.<para/> Corresponds to Channel Unit Configuration -> Bandwidth (Bytes). </summary> </member> <member name="P:PrtgAPI.TableSettings.BandwidthSpeedUnit"> <summary> Unit to use for traffic speed sensor channels.<para/> Corresponds to Channel Unit Configuration -> Bandwidth (Bytes). </summary> </member> <member name="P:PrtgAPI.TableSettings.BandwidthTimeUnit"> <summary> Unit to use for rate in traffic speed sensor channels.<para/> Corresponds to Channel Unit Configuration -> Bandwidth (Bytes). </summary> </member> <member name="P:PrtgAPI.TableSettings.MemoryUsageUnit"> <summary> Unit to use for memory usage in memory usage sensors.<para/> Corresponds to Channel Unit Configuration -> Bytes (Memory). </summary> </member> <member name="P:PrtgAPI.TableSettings.DiskSizeUnit"> <summary> Unit to use for disk usage in disk usage sensors.<para/> Corresponds to Channel Unit Configuration -> Bytes (Disk). </summary> </member> <member name="P:PrtgAPI.TableSettings.FileSizeUnit"> <summary> Unit to use for file size in file size sensors.<para/> Corresponds to Channel Unit Configuration -> Bytes (File). </summary> </member> <member name="T:PrtgAPI.Log"> <summary> <para type="description">Describes an event that has occurred to a <see cref="T:PrtgAPI.PrtgObject"/>.</para> </summary> </member> <member name="P:PrtgAPI.Log.Id"> <summary> ID of the <see cref="T:PrtgAPI.PrtgObject"/> this event applies to. </summary> </member> <member name="P:PrtgAPI.Log.Name"> <summary> Name of the <see cref="T:PrtgAPI.PrtgObject"/> this event applies to. </summary> </member> <member name="P:PrtgAPI.Log.DateTime"> <summary> The date and time the event occurred. </summary> </member> <member name="P:PrtgAPI.Log.Parent"> <summary> The parent of the object the event pertained to. </summary> </member> <member name="P:PrtgAPI.Log.Status"> <summary> Type of log record this object contains. </summary> </member> <member name="P:PrtgAPI.Log.Sensor"> <summary> Sensor the event pertained to (if applicable) </summary> </member> <member name="P:PrtgAPI.Log.Device"> <summary> Device the event pertained to, or the device of the affected sensor. </summary> </member> <member name="P:PrtgAPI.Log.Group"> <summary> Group the event pertained to, or the group of the affected device or sensor. </summary> </member> <member name="P:PrtgAPI.Log.Probe"> <summary> Probe the event pertained to, or the probe of the affected group, device or sensor. </summary> </member> <member name="P:PrtgAPI.Log.Message"> <summary> Message or subject displayed on an object. </summary> </member> <member name="P:PrtgAPI.Log.Priority"> <summary> <see cref="P:PrtgAPI.Log.Priority"/> of this object. </summary> </member> <member name="P:PrtgAPI.Log.DisplayType"> <summary> The display type of the object this object pertains to. </summary> </member> <member name="P:PrtgAPI.Log.type"> <summary> The raw type name of the object this object pertains to. </summary> </member> <member name="P:PrtgAPI.Log.Type"> <summary> The type of this object this object pertains to. </summary> </member> <member name="P:PrtgAPI.Log.Tags"> <summary> Tags contained on the object this event pertains to. </summary> </member> <member name="P:PrtgAPI.Log.Active"> <summary> Whether or not the object is currently active (in a monitoring state). If false, the object is paused. </summary> </member> <member name="M:PrtgAPI.Log.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.NotificationActions.BaseNotificationActionSettings"> <summary> Base class for notification settings that can be defined on a <see cref="T:PrtgAPI.NotificationAction"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.BaseNotificationActionSettings.Enabled"> <summary> Whether this notification type is enabled on its parent <see cref="T:PrtgAPI.NotificationAction"/>. </summary> </member> <member name="M:PrtgAPI.NotificationActions.BaseNotificationActionSettings.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionAmazonSettings"> <summary> Settings that apply to Amazon Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionAmazonSettings.AccessKey"> <summary> Access key to use for authentication to AWS. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionAmazonSettings.SecretKey"> <summary> Secret key to use for authentication to AWS. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionAmazonSettings.Region"> <summary> Region your AWS service is located in. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionAmazonSettings.ResourceName"> <summary> Amazon Resource Name to connect to. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionAmazonSettings.Subject"> <summary> Subject to display in the notification. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionAmazonSettings.Message"> <summary> Message to include in the notification. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionEmailSettings"> <summary> Settings that apply to Email Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.UserAccount"> <summary> PRTG user to send notification to. Can be used in conjunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.UserGroup"/> and <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.Address"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.UserGroup"> <summary> PRTG group to send notification to. Can be used in conjunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.UserAccount"/> and <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.Address"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.Address"> <summary> Email address to send notification to. Can be used in cojunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.UserAccount"/> and <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.UserGroup"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.Subject"> <summary> Subject to use for the email. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.ContentType"> <summary> Content type to use for the email. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.CustomText"> <summary> Text to display in email body when <see cref="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.ContentType"/> is <see cref="F:PrtgAPI.EmailContentType.Custom"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEmailSettings.Priority"> <summary> The priority to use for the email. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionEventLogSettings"> <summary> Settings that apply to Event Log Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEventLogSettings.LogName"> <summary> The name of the event log to store events under. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEventLogSettings.EventSource"> <summary> The source to display for the event. Applies only if <see cref="P:PrtgAPI.NotificationActions.NotificationActionEventLogSettings.LogName"/> is <see cref="F:PrtgAPI.EventLog.Application"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEventLogSettings.EventType"> <summary> The type of event to log. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionEventLogSettings.Message"> <summary> The message to display in the log. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionProgramSettings"> <summary> Setings that apply to Program Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.ExeFile"> <summary> The name of the EXE/Script file to execute. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.Parameters"> <summary> Parameters to pass to the <see cref="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.ExeFile"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.WindowsDomain"> <summary> The domain or local hostname used to run the <see cref="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.ExeFile"/> in custom security context. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.WindowsUserName"> <summary> The username used to run the <see cref="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.ExeFile"/> in custom security context. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.HasWindowsPassword"> <summary> Whether a password has been specified for running the <see cref="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.ExeFile"/> in a custom security context. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionProgramSettings.Timeout"> <summary> The duration (in seconds) the program can run for before PRTG will terminate the process. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionHttpSettings"> <summary> Settings that apply to HTTP Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionHttpSettings.Url"> <summary> URL PRTG should execute a HTTP request against. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionHttpSettings.SendSNI"> <summary> Whether PRTG should send the Server Name Indication when executing the <see cref="P:PrtgAPI.NotificationActions.NotificationActionHttpSettings.Url"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionHttpSettings.SNIName"> <summary> Server Name Indication required by target <see cref="P:PrtgAPI.NotificationActions.NotificationActionHttpSettings.Url"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionHttpSettings.PostData"> <summary> POST data to include in the HTTP request. Can include variable placeholders. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionPushSettings"> <summary> Settings that apply to Push Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionPushSettings.UserAccount"> <summary> PRTG user to send notification to. Can be used in conjunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionPushSettings.UserGroup"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionPushSettings.UserGroup"> <summary> PRTG group to send notification to. Can be used in conjunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionPushSettings.UserAccount"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionPushSettings.Message"> <summary> Message to send in notification. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionSMSSettings"> <summary> Settings that apply to SMS/Pager Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.UserAccount"> <summary> PRTG user to send notification to. Can be used in conjunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.UserGroup"/> and <see cref="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.Address"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.UserGroup"> <summary> PRTG group to send notification to. Can be used in conjunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.UserAccount"/> and <see cref="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.Address"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.Address"> <summary> Email address to send notification to. Can be used in cojunction with <see cref="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.UserAccount"/> and <see cref="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.UserGroup"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSMSSettings.Message"> <summary> Message to include in the SMS/Pager alert. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionSNMPSettings"> <summary> Settings that apply to SNMP Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.Host"> <summary> The IP Address/HostName of the trap receiver server. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.Port"> <summary> Port to use on trap receiver server. Default port is 162. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.Community"> <summary> Community string to use for SNMP. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.TrapCode"> <summary> Trap code to use to identify the purpose of the trap. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.MessageId"> <summary> Message ID used to identify the origin of the trap. PRTG will send Message ID to trap server on OID 1.3.6.1.4.1.32446.1.1.1 </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.Message"> <summary> Message to include in the SNMP trap. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSNMPSettings.SenderIP"> <summary> IP Address to display as the sender. If this is blank, PRTG will use the IP of the PRTG Core Server. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionSyslogSettings"> <summary> Settings that apply to Syslog Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSyslogSettings.Host"> <summary> IP Address/HostName of the syslog server. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSyslogSettings.Port"> <summary> Port to use on syslog server. Default port is 514. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSyslogSettings.Facility"> <summary> Logging facility to categorize the message under. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSyslogSettings.Encoding"> <summary> Encoding format to use for syslog message. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionSyslogSettings.Message"> <summary> Message to send to Syslog server. </summary> </member> <member name="T:PrtgAPI.NotificationActions.NotificationActionTicketSettings"> <summary> Settings that apply to Ticket Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.IsUserGroup"> <summary> If true, specifies that new tickets will be assigned to a <see cref="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.UserGroup"/>. If false, tickets will be assigned to a specific <see cref="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.UserAccount"/>. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.UserAccount"> <summary> The PRTG User tickets will be assigned to. Applies only if <see cref="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.IsUserGroup"/> is false. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.UserGroup"> <summary> The PRTG User Group tickets will be assigned to. Applies only if <see cref="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.IsUserGroup"/> is true. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.Subject"> <summary> The subject to use for new tickets. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.Message"> <summary> The message to include in the ticket. </summary> </member> <member name="P:PrtgAPI.NotificationActions.NotificationActionTicketSettings.AutoClose"> <summary> Whether tickets should automatically close themselves when the condition that triggered the notification clears. </summary> </member> <member name="T:PrtgAPI.Targets.GenericSensorTarget"> <summary> Represents a generic sensor target that can be used for creating a new sensor. </summary> </member> <member name="P:PrtgAPI.Targets.GenericSensorTarget.Value"> <summary> Gets or sets the internal value or unique identifier of the target. </summary> </member> <member name="P:PrtgAPI.Targets.GenericSensorTarget.Properties"> <summary> Gets the individual raw properties of this object. </summary> </member> <member name="T:PrtgAPI.Targets.ExeFileTarget"> <summary> Represents an EXE or Script file that can be used for implementing a custom PRTG Sensor. </summary> </member> <member name="M:PrtgAPI.Targets.ExeFileTarget.Parse(System.Object)"> <summary> Converts an object of one of several types to a <see cref="T:PrtgAPI.Targets.ExeFileTarget"/>. If the specified value is not convertable to <see cref="T:PrtgAPI.Targets.ExeFileTarget"/>, an <see cref="T:System.InvalidCastException"/> is thrown. </summary> <param name="exeFile">The value to parse.</param> <exception cref="T:System.InvalidCastException">The specified value could not be parsed to an <see cref="T:PrtgAPI.Targets.ExeFileTarget"/>.</exception> <returns>An <see cref="T:PrtgAPI.Targets.ExeFileTarget"/> that encapsulates the passed value.</returns> </member> <member name="P:PrtgAPI.Targets.ExeFileTarget.Type"> <summary> Gets the type of executable file this file targets. </summary> </member> <member name="M:PrtgAPI.Targets.ExeFileTarget.op_Implicit(System.String)~PrtgAPI.Targets.ExeFileTarget"> <summary> Creates a new <see cref="T:PrtgAPI.Targets.ExeFileTarget"/> from a specified file name.<para/> Note: PrtgAPI does not verify that the specified file exists on the probe of the target device.<para/> If the specified name is invalid, any sensors created will show an error stating the file does not exist. </summary> <param name="exeFile">The name of the script or executable to use.</param> </member> <member name="T:PrtgAPI.Targets.SensorTarget`1"> <summary> <para type="description">Represents a resource that can be monitored or used for monitoring by a PRTG Sensor.</para> </summary> <typeparam name="T">The type of this object.</typeparam> </member> <member name="P:PrtgAPI.Targets.SensorTarget`1.Name"> <summary> Gets the name of the target. </summary> </member> <member name="F:PrtgAPI.Targets.SensorTarget`1.components"> <summary> Gets the individual components of the target's raw value. This field is read-only. </summary> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Targets.SensorTarget`1"/> class. </summary> <param name="raw">The raw value of this object.</param> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.ToDropDownOption(System.String)"> <summary> Converts a string to the raw value used by a dropdown list option in PRTG. </summary> <param name="name">The string to encode.</param> <returns>The encoded format used by PRTG dropdown options.</returns> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.CreateFromDropDownOptions(System.String,System.String,System.Func{System.String,`0})"> <summary> Retrieves a list of sensor targets from a list of options on a specified dropdown list. </summary> <param name="response">The raw HTML response to parse.</param> <param name="name">The name of the dropdown list to parse.</param> <param name="createObj">A function used to construct a sensor target from the target's raw value.</param> <returns>A list of sensor targets of type T</returns> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.CreateFromCheckbox(System.String,System.String,System.Func{System.String,`0})"> <summary> Retrieves a list of sensor targets from a list of checkboxes in a specified checkbox group. </summary> <param name="response">The raw HTML response to parse.</param> <param name="name">The name of the checkbox group to parse.</param> <param name="createObj">A function used to construct a sensor target from the target's raw value.</param> <returns>A list of sensor targets of type T</returns> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects are of the same type and have the same <see cref="F:PrtgAPI.Targets.SensorTarget`1.raw"/> value. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.Equals(`0)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects are of the same type and have the same <see cref="F:PrtgAPI.Targets.SensorTarget`1.raw"/> value. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Targets.SensorTarget`1.GetHashCode"> <summary> Returns a hash code for this object. If two Sensor Targets are of the same type and have the same <see cref="F:PrtgAPI.Targets.SensorTarget`1.raw"/> value, they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="T:PrtgAPI.Targets.SqlServerQueryTarget"> <summary> Represents a SQL query file that can be used to query the status of a SQL Server Database. </summary> </member> <member name="M:PrtgAPI.Targets.SqlServerQueryTarget.Parse(System.Object)"> <summary> Converts an object of one of several types to a <see cref="T:PrtgAPI.Targets.SqlServerQueryTarget"/>. If the specified value is not convertable to <see cref="T:PrtgAPI.Targets.SqlServerQueryTarget"/>, an <see cref="T:System.InvalidCastException"/> is thrown. </summary> <param name="sqlQuery">The value to parse.</param> <exception cref="T:System.InvalidCastException">The specified value could not be parsed to a <see cref="T:PrtgAPI.Targets.SqlServerQueryTarget"/>.</exception> <returns>An <see cref="T:PrtgAPI.Targets.SqlServerQueryTarget"/> that encapsulates the passed value.</returns> </member> <member name="M:PrtgAPI.Targets.SqlServerQueryTarget.op_Implicit(System.String)~PrtgAPI.Targets.SqlServerQueryTarget"> <summary> Creates a new <see cref="T:PrtgAPI.Targets.SqlServerQueryTarget"/> from a specified file name.<para/> Note: PrtgAPI does not verify that the specified file exists on the probe of the target device.<para/> If the specified name is invalid, any sensors created will show an error stating the file does not exist. </summary> <param name="sqlQuery">The name of the query file to use.</param> </member> <member name="T:PrtgAPI.Targets.WmiServiceTarget"> <summary> Describes a system service on a Microsoft Windows server that can be monitored via WMI. </summary> </member> <member name="P:PrtgAPI.Targets.WmiServiceTarget.DisplayName"> <summary> Gets the friendly display name of the service. </summary> </member> <member name="P:PrtgAPI.Targets.WmiServiceTarget.Description"> <summary> Gets the description of the service. </summary> </member> <member name="P:PrtgAPI.Targets.WmiServiceTarget.Status"> <summary> Indicates whether the service is currently running or stopped. </summary> </member> <member name="M:PrtgAPI.Targets.WmiServiceTarget.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.UserGroup"> <summary> Represents a user group used for organizing one or more <see cref="T:PrtgAPI.UserAccount"/> objects within PRTG. </summary> </member> <member name="T:PrtgAPI.UserAccount"> <summary> Represents a user account capable of logging into PRTG. </summary> </member> <member name="T:PrtgAPI.ProbeRestartProgress"> <summary> Tracks the progress of a PRTG Probe being restarted. </summary> </member> <member name="P:PrtgAPI.ProbeRestartProgress.Id"> <summary> The ID of the probe that is being restarted. </summary> </member> <member name="P:PrtgAPI.ProbeRestartProgress.Name"> <summary> The name of the probe that is being restarted. </summary> </member> <member name="P:PrtgAPI.ProbeRestartProgress.InitialStatus"> <summary> The connection status of this probe before an attempt was made to restart it. </summary> </member> <member name="P:PrtgAPI.ProbeRestartProgress.Disconnected"> <summary> Whether the probe has disconnected from PRTG as part of its restart. </summary> </member> <member name="P:PrtgAPI.ProbeRestartProgress.Reconnected"> <summary> Whether the probe has reconnected to PRTG as part of its restart. </summary> </member> <member name="M:PrtgAPI.ProbeRestartProgress.#ctor(PrtgAPI.Probe)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.ProbeRestartProgress"/> class. </summary> <param name="probe">The probe that is being restarted.</param> </member> <member name="T:PrtgAPI.ChannelHistoryRecord"> <summary> Represents the value of a channel at a given date and time. </summary> </member> <member name="P:PrtgAPI.ChannelHistoryRecord.DateTime"> <summary> The date and time to which this object's historical values apply. </summary> </member> <member name="P:PrtgAPI.ChannelHistoryRecord.SensorId"> <summary> The ID of the sensor to which this history record applies. </summary> </member> <member name="P:PrtgAPI.ChannelHistoryRecord.Name"> <summary> The name of the channel. </summary> </member> <member name="P:PrtgAPI.ChannelHistoryRecord.ChannelId"> <summary> The ID of the channel. </summary> </member> <member name="P:PrtgAPI.ChannelHistoryRecord.Value"> <summary> Average value of the channel during the specified time period. This value can change based on the time span to use for the averaging interval. </summary> </member> <member name="M:PrtgAPI.ChannelHistoryRecord.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.SensorTypeDescriptor"> <summary> <para type="description">Describes a sensor type that can be applied under an object.</para> </summary> </member> <member name="P:PrtgAPI.SensorTypeDescriptor.Id"> <summary> The internal identifier of the sensor type. </summary> </member> <member name="P:PrtgAPI.SensorTypeDescriptor.Name"> <summary> The name of the sensor type. </summary> </member> <member name="P:PrtgAPI.SensorTypeDescriptor.Description"> <summary> A description of the sensor type. </summary> </member> <member name="P:PrtgAPI.Ticket.Status"> <summary> Status of this ticket </summary> </member> <member name="T:PrtgAPI.ContainerSettings"> <summary> Settings that are found within container objects in PRTG, including Devices, Groups and Probes. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.Name"> <summary> The name of the PRTG Object.<para/> Corresponds to Basic Settings -> Name. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.Tags"> <summary> Tags that have been applied to this object.<para/> Corresponds to Basic Settings -> Tags. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.Active"> <summary> Indicates whether this object is active. If an object is inative, all objects under it are paused.<para/> Corresponds to Basic Settings -> Status. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.Priority"> <summary> The priority of the object.<para/> Corresponds to Basic Settings -> Priority. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritLocation"> <summary> Whether this object's location is inherited from its parent.<para/> Corresponds to Location -> Inherit Location. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.Location"> <summary> The location of this object.<para/> Corresponds to Location -> Location (for Geo Maps). </summary> </member> <member name="P:PrtgAPI.ContainerSettings.Coordinates"> <summary> The latitudinal and longitudinal coordinates of this object's <see cref="P:PrtgAPI.ContainerSettings.Location"/>. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritWindowsCredentials"> <summary> Whether this object's Windows Credentials are inherited from its parent.<para/> Corresponds to Credentials for Windows Systems -> Inherit Windows Credentials. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WindowsDomain"> <summary> The domain or local hostname used for Windows Authentication.<para/> Corresponds to Credentials for Windows Systems -> Domain or Computer Name. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WindowsUserName"> <summary> The username used for Windows Authentication.<para/> Corresponds to Credentials for Windows Systems -> User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.windowsPassword"> <summary> The hidden Windows Password of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasWindowsPassword"> <summary> Whether a Windows Password is set.<para/> Corresponds to Credentials for Windows Systems -> Password. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritLinuxCredentials"> <summary> Whether this object's Linux Credentials are inherited from its parent.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Inherit Linux Credentials. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.LinuxUserName"> <summary> The username used for Linux Authentication.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.LinuxLoginMode"> <summary> The login/authentication mode to use for Linux Authentication.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Login. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.linuxPassword"> <summary> The hidden Linux Password of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasLinuxPassword"> <summary> Whether a Linux Password is set.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Password. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.linuxPrivateKey"> <summary> The hidden Linux Private Key of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasLinuxPrivateKey"> <summary> Whether a Linux Private Key is set.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Private Key. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WbemProtocolMode"> <summary> The protocol that is used to communicate with WBEM.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> For WBEM Use Protocol. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WbemPortMode"> <summary> Indicates the port to use for WBEM communications. If automatic is specified, the port will be 5988 or 5989.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> For WBEM Use Port. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WbemPort"> <summary> The custom port to use for WBEM.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> WBEM Port. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SSHPort"> <summary> The port to use for SSH communications.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Port. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SSHElevationMode"> <summary> Specifies whether to execute commands as the specified user or elevate rights using su or sudo.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Rights Elevation. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SSHElevationSuUser"> <summary> The user to use for SSH Elevation with su. If no user is specified, root will be used.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Target User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SSHElevationSudoUser"> <summary> The user to use for SSH Elevation with sudo. If no user is specified, root will be used.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Target User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.sshElevationPassword"> <summary> The hidden SSH Elevation Password of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasSSHElevationPassword"> <summary> Whether a SSH Elevation Password is set.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Rights Elevation -> Password. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SSHEngine"> <summary> The engine to use for SSH Requests.<para/> Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Engine. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritVMwareCredentials"> <summary> Whether this object's VMware/XenServer credentials are inherited from its parent.<para/> Corresponds to Credentials for VMware/XenServer -> Inherit VMware Credentials. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.VMwareUserName"> <summary> The username to use for VMware/XenServer authentication.<para/> Corresponds to Credentials for VMware/XenServer -> User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.vmwarePassword"> <summary> The hidden VMware Password of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasVMwarePassword"> <summary> Whether a VMware Password is set.<para/> Corresponds to Credentials for VMware/XenServer -> Password. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.VMwareProtocol"> <summary> The protocol to use when connecting to VMware/XenServer systems.<para/> Corresponds to Credentials for VMware/XenServer -> VMware Protocol. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.VMwareSessionMode"> <summary> Whether to reuse sessions for multiple sensor scans.<para/> Corresponds to Credentials for VMware/XenServer -> Session Pool. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritSNMPCredentials"> <summary> Whether this object's SNMP credentials are inherited from its parent.<para/> Corresponds to Credentials for SNMP Devices -> Inherit SNMP Credentials. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPVersion"> <summary> The version to use for SNMP.<para/> Corresponds to Credentials for SNMP Devices -> SNMP Version. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPCommunityStringV1"> <summary> The community string to use when using SNMP v1. The default value is 'public'.<para/> Corresponds to Credentials for SNMP Devices -> Community String (SNMP v1). </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPCommunityStringV2"> <summary> The community string to use when using SNMP v2c. The default value is 'public'.<para/> Corresponds to Credentials for SNMP Devices -> Community String (SNMP v2c). </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPv3AuthType"> <summary> The authentication type to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> Authentication Type. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPv3UserName"> <summary> The username to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.snmpv3Password"> <summary> The hidden SNMPv3 Password of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasSNMPv3Password"> <summary> Whether a SNMPv3 Password is set.<para/> Corresponds to Credentials for SNMP Devices -> Password. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPv3EncryptionType"> <summary> The encryption type to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> Encryption Type. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.snmpv3EncryptionKey"> <summary> The hidden SNMPv3 Encryption Key of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasSNMPv3EncryptionKey"> <summary> Whether a SNMPv3 Encryption Key is set.<para/> Corresponds to Credentials for SNMP Devices -> Data Encryption Key. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPv3Context"> <summary> The context name to use for SNMPv3. A context name is required only if specified by the target device.<para/> Corresponds to Credentials for SNMP Devices -> Context Name. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPPort"> <summary> The port to use for SNMP. The default value is 161.<para/> Corresponds to Credentials for SNMP Devices -> SNMP Port. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPTimeout"> <summary> The length of time (in seconds) before a SNMP request times out.<para/> Corresponds to Credentials for SNMP Devices -> SNMP Timeout. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritDBCredentials"> <summary> Whether this object's DBMS credentials are inherited from its parent.<para/> Corresponds to Credentials for Database Management Systems -> Inherit Database Credentials. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.DBPortMode"> <summary> Indicates whether PRTG automatically determines the port of the DBMS or the port is set manually.<para/> Corresponds to Credentials for Database Management Systems -> Port for Databases. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.DBPort"> <summary> The port to use for all database sensors. This only applies if the <see cref="P:PrtgAPI.ContainerSettings.DBPortMode"/> is <see cref="F:PrtgAPI.AutoMode.Manual"/>.<para/> Corresponds to Credentials for Database Management Systems -> Custom Database Port. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.DBAuthMode"> <summary> The authentication mode PRTG uses to connect to a database server.<para/> Corresponds to Credentials for Database Management Systems -> Authentication Mode. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.DBUserName"> <summary> The username to use when <see cref="P:PrtgAPI.ContainerSettings.DBAuthMode"/> is <see cref="F:PrtgAPI.DBAuthMode.SQL"/>.<para/> Corresponds to Credentials for Database Management Systems -> User. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.dbPassword"> <summary> The hidden Database Password of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasDBPassword"> <summary> Whether a database password is set.<para/> Corresponds to Credentials for Database Management Systems -> Password. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.DBTimeout"> <summary> The length of time (in seconds) before a database request times out.<para/> Corresponds to Credentials for Database Management Systems -> Timeout. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritAmazonCredentials"> <summary> Whether this object's Amazon Cloudwatch credentials are inherited from its parent.<para/> Corresponds to Credentials for Amazon Cloudwatch -> Inherit Amazon Credentials. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.AmazonAccessKey"> <summary> The access key to use for Amazon Web Services.<para/> Corresponds to Credentials for Amazon Cloudwatch -> Access Key. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.amazonSecretKey"> <summary> The hidden Amazon Secret Key of this object. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.HasAmazonSecretKey"> <summary> Whether an Amazon Secret Key is set.<para/> Corresponds to Credentials for Amazon Cloudwatch -> Secret Key. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritWindowsCompatibility"> <summary> Whether this object's Windows Compatibility settings are inherited from its parent.<para/> Corresponds to Windows Compatibility Options -> Inherit Windows Compatibility Options. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WmiDataSource"> <summary> The data source to use for performing WMI queries.<para/> Corresponds to Windows Compatibility Options -> Preferred Data Source. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WmiTimeoutMethod"> <summary> The method to use for determining the timeout of WMI requests.<para/> Corresponds to Windows Compatibility Options -> Timeout Method. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.WmiTimeout"> <summary> The length of time (in seconds) before a WMI request times out. This only applies if <see cref="P:PrtgAPI.ContainerSettings.WmiTimeoutMethod"/> is <see cref="F:PrtgAPI.WmiTimeoutMethod.Manual"/>.<para/> Corresponds to Windows Compatibility Options -> Timeout Value. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.InheritSNMPCompatibility"> <summary> Whether this object's SNMP Compatibility settings are inherited from its parent.<para/> Corresponds to SNMP Compatibility Options -> Inherit SNMP Compatibility Options. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPDelay"> <summary> The delay (in ms) PRTG should wait between multiple SNMP requests to a single device. This value must be 0-100ms. Higher values are not supported.<para/> Corresponds to SNMP Compatibility Options -> SNMP Delay. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPRetryMode"> <summary> Whether PRTG should retry failed requests.<para/> Corresponds to SNMP Compatibility Options -> Failed Requests. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPOverflowMode"> <summary> Whether PRTG treats overflow values as valid results.<para/> Corresponds to SNMP Compatibility Options -> Overflow Values. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPZeroValueMode"> <summary> Whether spurious "0" values should be ignored for delta (difference) sensors.<para/> Corresponds to SNMP Compatibility Options -> Zero Values. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPCounterMode"> <summary> Whether to use force using 32-bit counters even when a device reports 64-bit counters are available.<para/> Corresponds to SNMP Compatibility Options -> 32-bit/64-bit Counters. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPRequestMode"> <summary> Whether to include a single or multiple SNMP requests in each request.<para/> Corresponds to SNMP Compatibility Options -> Request Mode. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPPortNameTemplate"> <summary> Name template to define how the sensor name should be displayed. Template variables include [port], [ifalias], [ifname], [ifdescr], [ifspeed], [ifsensor] and custom OIDs.<para/> Corresponds to SNMP Compatibility Options -> Port Name Template. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPPortNameUpdateMode"> <summary> Whether PRTG should automatically update SNMP port sensor names when those names change in the device.<para/> Corresponds to SNMP Compatibility Options -> Port Name Update. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPPortIdMode"> <summary> Specifies the field to use to identify SNMP interfaces in the event the interface port order changes on reboot.<para/> Corresponds to SNMP Compatibility Options -> Port Identification. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPInterfaceStartIndex"> <summary> The start index for the interface range SNMP Traffic sensors can query during sensor creation. If this value is 0, PRTG will use "automatic mode".<para/> Corresponds to SNMP Compatibility Options -> Start Interface Index. </summary> </member> <member name="P:PrtgAPI.ContainerSettings.SNMPInterfaceEndIndex"> <summary> The end index for the interface range SNMP Traffic sensors can query during sensor creation. If this value is 0, PRTG will use "automatic mode".<para/> Corresponds to SNMP Compatibility Options -> End Interface Index. </summary> </member> <member name="M:PrtgAPI.ContainerSettings.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.DeviceOrGroupSettings"> <summary> Settings that apply to Devices and Groups within PRTG. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupSettings.ParentTags"> <summary> Tags that are inherited from this object's parent. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupSettings.AutoDiscoveryMode"> <summary> How thoroughly PRTG should scan for compatible sensor types when performing an auto-discovery. Corresponds to:<para/> Group Type -> Sensor Management<para/> Device Type -> Sensor Management </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupSettings.AutoDiscoverySchedule"> <summary> How often auto-discovery operations should be performed to create new sensors. Corresponds to:<para/> Group Type -> Discovery Schedule<para/> Device Type -> Discovery Schedule </summary> </member> <member name="T:PrtgAPI.DeviceSettings"> <summary> Settings that apply to Devices within PRTG. </summary> </member> <member name="P:PrtgAPI.DeviceSettings.IPVersion"> <summary> The internet protocol version to use to connect to the device.<para/> Corresponds to Basic Device Settings -> IP Version. </summary> </member> <member name="P:PrtgAPI.DeviceSettings.Host"> <summary> The IP Address or Hostname used to connect to the device.<para/> If the <see cref="P:PrtgAPI.DeviceSettings.IPVersion"/> of this device is <see cref="F:PrtgAPI.IPVersion.IPv6"/>, this returns the value of <see cref="P:PrtgAPI.DeviceSettings.Hostv6"/>. Otherwise, returns <see cref="P:PrtgAPI.DeviceSettings.Hostv4"/>. </summary> </member> <member name="P:PrtgAPI.DeviceSettings.Hostv4"> <summary> The IPv4 Address or Hostname used to connect to the device.<para/> Corresponds to Basic Device Settings -> IPv4 Address/DNS Name. </summary> </member> <member name="P:PrtgAPI.DeviceSettings.Hostv6"> <summary> The IPv6 Address or Hostname used to connect to the device.<para/> Corresponds to Basic Device Settings -> IPv6 Address/DNS Name. </summary> </member> <member name="P:PrtgAPI.DeviceSettings.ServiceUrl"> <summary> The URL used to service this device.<para/> Corresponds to Additional Device Information -> Service URL. </summary> </member> <member name="T:PrtgAPI.GroupSettings"> <summary> Settings that apply to Groups within PRTG. </summary> </member> <member name="T:PrtgAPI.Coordinates"> <summary> Represents a geographic coordinate used to specify a physical location. </summary> </member> <member name="P:PrtgAPI.Coordinates.Latitude"> <summary> The north/south position of the coordinate. </summary> </member> <member name="P:PrtgAPI.Coordinates.Longitude"> <summary> The east/west position of the coordinate. </summary> </member> <member name="M:PrtgAPI.Coordinates.ToString"> <summary> The latitude and longitude of these coordinates in the form <see cref="P:PrtgAPI.Coordinates.Latitude"/>,<see cref="P:PrtgAPI.Coordinates.Longitude"/>. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.ProbeSettings"> <summary> Settings that apply to Probes within PRTG. </summary> </member> <member name="P:PrtgAPI.ProbeSettings.ProbeApproved"> <summary> Whether this probe has been confirmed for use within this PRTG Core.<para/>If this value is false, the probe has neither been approved nor denied.<para/>If a probe is denied, its GID will be blacklisted and it will be removed from PRTG. </summary> </member> <member name="T:PrtgAPI.TriggerChannel"> <summary> Represents a channel that can cause a Notification Trigger to activate. </summary> </member> <member name="F:PrtgAPI.TriggerChannel.Primary"> <summary> The sensor's primary channel. </summary> </member> <member name="F:PrtgAPI.TriggerChannel.Total"> <summary> The sensor's "Total" channel (where applicable). </summary> </member> <member name="F:PrtgAPI.TriggerChannel.TrafficIn"> <summary> The sensor's "Traffic In" channel (where applicable). </summary> </member> <member name="F:PrtgAPI.TriggerChannel.TrafficOut"> <summary> The sensor's "Traffic Out" channel (where applicable). </summary> </member> <member name="M:PrtgAPI.TriggerChannel.Parse(System.Object)"> <summary> Converts an object of one of several types to a <see cref="T:PrtgAPI.TriggerChannel"/>. If the specified value is not convertable to <see cref="T:PrtgAPI.TriggerChannel"/>, an <see cref="T:System.InvalidCastException"/> is thrown. </summary> <param name="value">The value to parse.</param> <returns>A <see cref="T:PrtgAPI.TriggerChannel"/> that encapsulates the passed value.</returns> </member> <member name="M:PrtgAPI.TriggerChannel.TryParse(System.Object,PrtgAPI.TriggerChannel@)"> <summary> Converts an object of one of several types to a <see cref="T:PrtgAPI.TriggerChannel"/>. A return value indicates whether the conversion succeeded. </summary> <param name="value">The value to parse.</param> <param name="result">When this method returns, if the <paramref name="value"/> was successfully converted to a <see cref="T:PrtgAPI.TriggerChannel"/>, this parameter contains the result of that conversion. If the conversion was unsuccessful, this parameter will be set to null. </param> <returns>True if the value was successfully parsed. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.TriggerChannel.#ctor(PrtgAPI.Channel)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.TriggerChannel"/> from a Channel. </summary> <param name="channel"></param> </member> <member name="M:PrtgAPI.TriggerChannel.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.TriggerChannel"/> class from a Channel ID. </summary> </member> <member name="M:PrtgAPI.TriggerChannel.op_Implicit(PrtgAPI.Channel)~PrtgAPI.TriggerChannel"> <summary> Creates a new <see cref="T:PrtgAPI.TriggerChannel"/> object from a specified Channel. </summary> <param name="channel">A custom channel that will apply to a trigger.</param> </member> <member name="M:PrtgAPI.TriggerChannel.op_Implicit(PrtgAPI.StandardTriggerChannel)~PrtgAPI.TriggerChannel"> <summary> Creates a new <see cref="T:PrtgAPI.TriggerChannel"/> from a specified <see cref="T:PrtgAPI.StandardTriggerChannel"/>. </summary> <param name="channel">A standard channel that will apply to a trigger.</param> </member> <member name="M:PrtgAPI.TriggerChannel.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.TriggerChannel.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects target the same channel. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.TriggerChannel.Equals(PrtgAPI.TriggerChannel)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects target the same channel. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.TriggerChannel.GetHashCode"> <summary> Returns a hash code for this object. If two trigger channels target the same channel, they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="T:PrtgAPI.StandardTriggerChannel"> <summary> Specifies standard sensor channels a notification trigger can monitor. </summary> </member> <member name="F:PrtgAPI.StandardTriggerChannel.Primary"> <summary> The primary channel. </summary> </member> <member name="F:PrtgAPI.StandardTriggerChannel.Total"> <summary> The "Total" channel (where applicable) </summary> </member> <member name="F:PrtgAPI.StandardTriggerChannel.TrafficIn"> <summary> The "TrafficIn" channel (where applicable) </summary> </member> <member name="F:PrtgAPI.StandardTriggerChannel.TrafficOut"> <summary> The "TrafficOut" channel (where applicable) </summary> </member> <member name="T:PrtgAPI.TriggerCondition"> <summary> Specifies threshold conditions to be used in notification triggers. </summary> </member> <member name="F:PrtgAPI.TriggerCondition.Above"> <summary> Trigger when sensor's value is above the threshold. </summary> </member> <member name="F:PrtgAPI.TriggerCondition.Below"> <summary> Trigger when the sensor's value is below the threshold. </summary> </member> <member name="F:PrtgAPI.TriggerCondition.Equals"> <summary> Trigger when the sensor's value is equal to the threshold. </summary> </member> <member name="F:PrtgAPI.TriggerCondition.NotEquals"> <summary> Trigger when the sensor's value is not equal to the threshold. </summary> </member> <member name="F:PrtgAPI.TriggerCondition.Change"> <summary> Trigger whenever the sensor's value changes. For use in <see cref="F:PrtgAPI.TriggerType.Change"/> triggers only. </summary> </member> <member name="T:PrtgAPI.TriggerPeriod"> <summary> Specifies the time period for <see cref="F:PrtgAPI.TriggerType.Volume"/> triggers. </summary> </member> <member name="F:PrtgAPI.TriggerPeriod.Hour"> <summary> Trigger when a volume limit is reached per hour. </summary> </member> <member name="F:PrtgAPI.TriggerPeriod.Day"> <summary> Trigger when a volume limit is reached per day. </summary> </member> <member name="F:PrtgAPI.TriggerPeriod.Week"> <summary> Trigger when a volume limit is reached per week. </summary> </member> <member name="F:PrtgAPI.TriggerPeriod.Month"> <summary> Trigger when a volume limit is reached per month. </summary> </member> <member name="T:PrtgAPI.TimeUnit"> <summary> Specifies data transfer time components for <see cref="F:PrtgAPI.TriggerType.Speed"/> notification triggers. </summary> </member> <member name="F:PrtgAPI.TimeUnit.Sec"> <summary> Seconds </summary> </member> <member name="F:PrtgAPI.TimeUnit.Min"> <summary> Minutes </summary> </member> <member name="F:PrtgAPI.TimeUnit.Hour"> <summary> Hours </summary> </member> <member name="F:PrtgAPI.TimeUnit.Day"> <summary> Days </summary> </member> <member name="T:PrtgAPI.TriggerType"> <summary> <para type="description">Specifies types of notification triggers that can be defined on objects.</para> </summary> </member> <member name="F:PrtgAPI.TriggerType.State"> <summary> Trigger when an object enters a specific state. </summary> </member> <member name="F:PrtgAPI.TriggerType.Speed"> <summary> Trigger when a channel reaches a certain speed. </summary> </member> <member name="F:PrtgAPI.TriggerType.Volume"> <summary> Trigger when a channel processes a certain volume of data over a given time frame. </summary> </member> <member name="F:PrtgAPI.TriggerType.Threshold"> <summary> Trigger when a channel reaches a certain value. </summary> </member> <member name="F:PrtgAPI.TriggerType.Change"> <summary> Trigger whenever an object changes. </summary> </member> <member name="T:PrtgAPI.DataUnit"> <summary> Specifies data unit sizes that measure speed or volume. </summary> </member> <member name="F:PrtgAPI.DataUnit.Bit"> <summary> Bits </summary> </member> <member name="F:PrtgAPI.DataUnit.Kbit"> <summary> Kilobits </summary> </member> <member name="F:PrtgAPI.DataUnit.Mbit"> <summary> Megabits </summary> </member> <member name="F:PrtgAPI.DataUnit.Gbit"> <summary> Gigabits </summary> </member> <member name="F:PrtgAPI.DataUnit.Tbit"> <summary> Terabits </summary> </member> <member name="F:PrtgAPI.DataUnit.Byte"> <summary> Bytes </summary> </member> <member name="F:PrtgAPI.DataUnit.KByte"> <summary> Kilobytes </summary> </member> <member name="F:PrtgAPI.DataUnit.MByte"> <summary> Megabytes </summary> </member> <member name="F:PrtgAPI.DataUnit.GByte"> <summary> Gigabytes </summary> </member> <member name="F:PrtgAPI.DataUnit.TByte"> <summary> Terabytes </summary> </member> <member name="T:PrtgAPI.ModifyAction"> <summary> Specifies ways in which an object can be modified. </summary> </member> <member name="F:PrtgAPI.ModifyAction.Add"> <summary> Add a new object. </summary> </member> <member name="F:PrtgAPI.ModifyAction.Edit"> <summary> Edit an existing object. </summary> </member> <member name="T:PrtgAPI.ObjectProperty"> <summary> <para type="description">Specifies the settings of objects that can be interfaced with using the PRTG HTTP API.</para> </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Active"> <summary> Indicates whether this object is active. If an object is inative, all objects under it are paused.<para/> Corresponds to Basic Settings -> Status. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritLocation"> <summary> Whether this object's location is inherited from its parent.<para/> Corresponds to Location -> Inherit Location. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Location"> <summary> The location of this object.<para/> Corresponds to Location -> Location (for Geo Maps). </summary> </member> <member name="F:PrtgAPI.ObjectProperty.LocationName"> <summary> The label to use for the location. Must be used in conjunction with <see cref="F:PrtgAPI.ObjectProperty.Location"/>. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritWindowsCredentials"> <summary> Whether this object's Windows Credentials are inherited from its parent.<para/> Corresponds to Credentials for Windows Systems -> Inherit Windows Credentials. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WindowsDomain"> <summary> The domain or local hostname to use for Windows Authentication.<para/> Corresponds to Credentials for Windows Systems -> Domain or Computer Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WindowsUserName"> <summary> The username to use for Windows Authentication.<para/> Corresponds to Credentials for Windows Systems -> User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WindowsPassword"> <summary> The password to use for Windows Authentication.<para/> Corresponds to Credentials for Windows Systems -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritLinuxCredentials"> <summary> Whether this object's Linux Credentials are inherited from its parent.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Inherit Linux Credentials. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.LinuxUserName"> <summary> The username used for Linux Authentication.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.LinuxLoginMode"> <summary> The login/authentication mode to use for Linux Authentication.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Login. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.LinuxPassword"> <summary> The password to use for Linux Authentication.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.LinuxPrivateKey"> <summary> The private key to use for Linux Authentication.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Private Key. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WbemProtocolMode"> <summary> The protocol that is used to communicate with WBEM.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> For WBEM Use Protocol. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WbemPortMode"> <summary> Indicates the port to use for WBEM communications. If automatic is specified, the port will be 5988 or 5989.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> For WBEM Use Port. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WbemPort"> <summary> The custom port to use for WBEM.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> WBEM Port. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SSHPort"> <summary> The port to use for SSH communications.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Port. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SSHElevationMode"> <summary> Specifies whether to execute commands as the specified user or elevate rights using su or sudo.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Rights Elevation. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SSHElevationSuUser"> <summary> The user to use for SSH Elevation with su. If no user is specified, root will be used.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Target User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SSHElevationSudoUser"> <summary> The user to use for SSH Elevation with sudo. If no user is specified, root will be used.<para/> Note: as this property can be used with multiple <see cref="T:PrtgAPI.SSHElevationMode"/> values, setting this property will not modify the current <see cref="F:PrtgAPI.ObjectProperty.SSHElevationMode"/>.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> Target User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SSHElevationPassword"> <summary> The password to use for SSH Elevation.<para/> Note: as this property can be used with multiple <see cref="T:PrtgAPI.SSHElevationMode"/> values, setting this property will not modify the current <see cref="F:PrtgAPI.ObjectProperty.SSHElevationMode"/>.<para/> Corresponds to Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Rights Elevation -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SSHEngine"> <summary> The engine to use for SSH Requests.<para/> Credentials for Linux/Solaris/Mac OS (SSH/WBEM) Systems -> SSH Engine. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritVMwareCredentials"> <summary> Whether this object's VMware/XenServer credentials are inherited from its parent.<para/> Corresponds to Credentials for VMware/XenServer -> Inherit VMware Credentials. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.VMwareUserName"> <summary> The username to use for VMware/XenServer authentication.<para/> Corresponds to Credentials for VMware/XenServer -> User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.VMwarePassword"> <summary> The password to use for VMware/XenServer authentication.<para/> Corresponds to Credentials for VMware/XenServer -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.VMwareProtocol"> <summary> The protocol to use when connecting to VMware/XenServer systems.<para/> Corresponds to Credentials for VMware/XenServer -> VMware Protocol. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.VMwareSessionMode"> <summary> Whether to reuse sessions for multiple sensor scans.<para/> Corresponds to Credentials for VMware/XenServer -> Session Pool. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritSNMPCredentials"> <summary> Whether this object's SNMP credentials are inherited from its parent.<para/> Corresponds to Credentials for SNMP Devices -> Inherit SNMP Credentials. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPVersion"> <summary> The version to use for SNMP.<para/> Corresponds to Credentials for SNMP Devices -> SNMP Version. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPCommunityStringV1"> <summary> The community string to use when using SNMP v1. The default value is 'public'.<para/> Corresponds to Credentials for SNMP Devices -> Community String (SNMP v1). </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPCommunityStringV2"> <summary> The community string to use when using SNMP v2c. The default value is 'public'.<para/> Corresponds to Credentials for SNMP Devices -> Community String (SNMP v2c). </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPv3AuthType"> <summary> The authentication type to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> Authentication Type. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPv3UserName"> <summary> The username to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPv3Password"> <summary> The password to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPv3EncryptionType"> <summary> The encryption type to use for SNMPv3.<para/> Corresponds to Credentials for SNMP Devices -> Encryption Type. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPv3EncryptionKey"> <summary> The encryption key to use for encrypting SNMPv3 packets.<para/> Corresponds to Credentials for SNMP Devices -> Data Encryption Key. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPv3Context"> <summary> The context name to use for SNMPv3. A context name is required only if specified by the target device.<para/> Corresponds to Credentials for SNMP Devices -> Context Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPPort"> <summary> The port to use for SNMP. The default value is 161.<para/> Corresponds to Credentials for SNMP Devices -> SNMP Port. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPTimeout"> <summary> The length of time (in seconds) before a SNMP request times out.<para/> Corresponds to Credentials for SNMP Devices -> SNMP Timeout. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritDBCredentials"> <summary> Whether this object's DBMS credentials are inherited from its parent.<para/> Corresponds to Credentials for Database Management Systems -> Inherit Database Credentials. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DBPortMode"> <summary> Indicates whether PRTG automatically determines the port of the DBMS or the port is set manually.<para/> Corresponds to Credentials for Database Management Systems -> Port for Databases. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DBPort"> <summary> The port to use for all database sensors. This only applies if the <see cref="F:PrtgAPI.ObjectProperty.DBPortMode"/> is <see cref="F:PrtgAPI.AutoMode.Manual"/>.<para/> Corresponds to Credentials for Database Management Systems -> Custom Database Port. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DBAuthMode"> <summary> The authentication mode PRTG uses to connect to a database server.<para/> Corresponds to Credentials for Database Management Systems -> Authentication Mode. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DBUserName"> <summary> The username to use when <see cref="F:PrtgAPI.ObjectProperty.DBAuthMode"/> is <see cref="F:PrtgAPI.DBAuthMode.SQL"/>.<para/> Corresponds to Credentials for Database Management Systems -> User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DBPassword"> <summary> The password to use when <see cref="F:PrtgAPI.ObjectProperty.DBAuthMode"/> is <see cref="F:PrtgAPI.DBAuthMode.SQL"/>.<para/> Corresponds to Credentials for Database Management Systems -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DBTimeout"> <summary> The length of time (in seconds) before a database request times out.<para/> Corresponds to Credentials for Database Management Systems -> Timeout. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritAmazonCredentials"> <summary> Whether this object's Amazon Cloudwatch credentials are inherited from its parent.<para/> Corresponds to Credentials for Amazon Cloudwatch -> Inherit Amazon Credentials. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.AmazonAccessKey"> <summary> The access key to use for Amazon Web Services.<para/> Corresponds to Credentials for Amazon Cloudwatch -> Access Key. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.AmazonSecretKey"> <summary> The secret key to use for Amazon Web Services.<para/> Corresponds to Credentials for Amazon Cloudwatch -> Secret Key. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritWindowsCompatibility"> <summary> Whether this object's Windows Compatibility settings are inherited from its parent.<para/> Corresponds to Windows Compatibility Options -> Inherit Windows Compatibility Options. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WmiDataSource"> <summary> The data source to use for performing WMI queries.<para/> Corresponds to Windows Compatibility Options -> Preferred Data Source. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WmiTimeoutMethod"> <summary> The method to use for determining the timeout of WMI requests.<para/> Corresponds to Windows Compatibility Options -> Timeout Method. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WmiTimeout"> <summary> The length of time (in seconds) before a WMI request times out. This only applies if <see cref="F:PrtgAPI.ObjectProperty.WmiTimeoutMethod"/> is <see cref="F:PrtgAPI.WmiTimeoutMethod.Manual"/>.<para/> Corresponds to Windows Compatibility Options -> Timeout Value. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritSNMPCompatibility"> <summary> Whether this object's SNMP Compatibility settings are inherited from its parent.<para/> Corresponds to SNMP Compatibility Options -> Inherit SNMP Compatibility Options. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPDelay"> <summary> The delay (in ms) PRTG should wait between multiple SNMP requests to a single device. This value must be 0-100ms. Higher values are not supported.<para/> Corresponds to SNMP Compatibility Options -> SNMP Delay. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPRetryMode"> <summary> Whether PRTG should retry failed requests.<para/> Corresponds to SNMP Compatibility Options -> Failed Requests. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPOverflowMode"> <summary> Whether PRTG treats overflow values as valid results.<para/> Corresponds to SNMP Compatibility Options -> Overflow Values. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPZeroValueMode"> <summary> Whether spurious "0" values should be ignored for delta (difference) sensors.<para/> Corresponds to SNMP Compatibility Options -> Zero Values. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPCounterMode"> <summary> Whether to use force using 32-bit counters even when a device reports 64-bit counters are available.<para/> Corresponds to SNMP Compatibility Options -> 32-bit/64-bit Counters. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPRequestMode"> <summary> Whether to include a single or multiple SNMP requests in each request.<para/> Corresponds to SNMP Compatibility Options -> Request Mode. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPPortNameTemplate"> <summary> Name template to define how the sensor name should be displayed. Template variables include [port], [ifalias], [ifname], [ifdescr], [ifspeed], [ifsensor] and custom OIDs.<para/> Corresponds to SNMP Compatibility Options -> Port Name Template. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPPortNameUpdateMode"> <summary> Whether PRTG should automatically update SNMP port sensor names when those names change in the device.<para/> Corresponds to SNMP Compatibility Options -> Port Name Update. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPPortIdMode"> <summary> Specifies the field to use to identify SNMP interfaces in the event the interface port order changes on reboot.<para/> Corresponds to SNMP Compatibility Options -> Port Identification. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPInterfaceStartIndex"> <summary> The start index for the interface range SNMP Traffic sensors can query during sensor creation. If this value is 0, PRTG will use "automatic mode".<para/> Corresponds to SNMP Compatibility Options -> Start Interface Index. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SNMPInterfaceEndIndex"> <summary> The end index for the interface range SNMP Traffic sensors can query during sensor creation. If this value is 0, PRTG will use "automatic mode".<para/> Corresponds to SNMP Compatibility Options -> End Interface Index. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritChannelUnit"> <summary> Whether to inherit Channel Unit Configuration settings from the parent object.<para/> Corresponds to Channel Unit Configuration -> Inherit Channel Unit.<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.BandwidthVolumeUnit"> <summary> Unit to use for traffic volume sensor channels.<para/> Corresponds to Channel Unit Configuration -> Bandwidth (Bytes).<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.BandwidthSpeedUnit"> <summary> Unit to use for traffic speed sensor channels.<para/> Corresponds to Channel Unit Configuration -> Bandwidth (Bytes).<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.BandwidthTimeUnit"> <summary> Unit to use for rate in traffic speed sensor channels.<para/> Corresponds to Channel Unit Configuration -> Bandwidth (Bytes).<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.MemoryUsageUnit"> <summary> Unit to use for memory usage in memory usage sensors.<para/> Corresponds to Channel Unit Configuration -> Bytes (Memory).<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DiskSizeUnit"> <summary> Unit to use for disk usage in disk usage sensors.<para/> Corresponds to Channel Unit Configuration -> Bytes (Disk).<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.FileSizeUnit"> <summary> Unit to use for file size in file size sensors.<para/> Corresponds to Channel Unit Configuration -> Bytes (File).<para/> Note: Modifying this property may invalidate the <see cref="P:PrtgAPI.Channel.Factor"/> of any <see cref="T:PrtgAPI.Channel"/> objects under this sensor you currently hold reference to.<para/> Attempts to modify channel properties from these objects may not work as expected until the objects are re-retrieved. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritAccess"> <summary> Whether to inherit Access Rights settings from the parent object.<para/> Corresponds to Access Rights -> Inherit Access Rights. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Name"> <summary> The name of the PRTG Object.<para/> Corresponds to Basic Settings -> Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Tags"> <summary> Tags that have been applied to this object.<para/> Corresponds to Basic Settings -> Tags. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Priority"> <summary> The priority of the object.<para/> Corresponds to Basic Settings -> Priority. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.DebugMode"> <summary> How raw sensor results should be stored for debugging purposes. Corresponds to:<para/> Debug Options (WMI) -> Sensor Result<para/> Sensor Settings (EXE/XML) -> EXE Result WMI Service Monitor -> Sensor Result </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Url"> <summary> The URL to monitor. If a protocol is not specified, HTTP is used.<para/> Corresponds to HTTP Specific -> URL. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.HttpRequestMethod"> <summary> The HTTP Request Method to use for requesting the <see cref="F:PrtgAPI.ObjectProperty.Url"/>.<para/> Corresponds to HTTP Specific -> Request Method. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PostData"> <summary> Data to include in POST requests. Applies when <see cref="F:PrtgAPI.ObjectProperty.HttpRequestMethod"/> is <see cref="F:PrtgAPI.HttpRequestMethod.POST"/>.<para/> Corresponds to HTTP Specific -> Postdata. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.UseCustomPostContent"> <summary> Whether POST requests should use a custom content type. If false, content type "application/x-www-form-urlencoded" will be used.<para/> Corresponds to HTTP Specific -> Content Type. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PostContentType"> <summary> Custom content type to use for POST requests.<para/> Corresponds to HTTP Specific -> Custom Content Type. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.UseSNIFromUrl"> <summary> Whether the Server Name Indication is inherited from the parent device, or derived from the specified <see cref="F:PrtgAPI.ObjectProperty.Url"/>.<para/> Corresponds to HTTP Specific -> SNI Inheritance. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritProxy"> <summary> Whether to inherit HTTP Proxy settings from the parent object.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Inherit Proxy Settings. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ProxyAddress"> <summary> IP Address/DNS name of the proxy server to use for HTTP/HTTPS requests.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ProxyPort"> <summary> Port to use to connect to the proxy server.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Port. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ProxyUser"> <summary> Username to use for proxy server authentication.<para/> Corresponds to Proxy Settings for HTTP Sensors -> User. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ProxyPassword"> <summary> Password to use for proxy server authentication.<para/> Corresponds to Proxy Settings for HTTP Sensors -> Password. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Timeout"> <summary> The duration (in seconds) this sensor can run for before timing out. Based on the sensor type, the maximum valid value may be different. Corresponds to:<para/> Ping Settings -> Timeout (Max 300)<para/> WMI Remote Ping Configuration -> Timeout (Max 300)<para/> HTTP Specific -> Timeout (Max 900)<para/> Sensor Settings (EXE/XML) -> Timeout (Max 900) </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PingPacketSize"> <summary> The packet size to use for Ping Requests (bytes). The default value is 32 bytes. This value must be between 1-10,000 bytes.<para/> Corresponds to Ping Settings -> Packet Size. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PingMode"> <summary> Whether to send a single Ping or Multiple Pings. If <see cref="F:PrtgAPI.PingMode.MultiPing"/> is used, all packets must be most for the sensor to go <see cref="F:PrtgAPI.Status.Down"/>.<para/> Corresponds to Ping Settings -> Ping Method. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PingCount"> <summary> The number of Ping Requests to make, when using <see cref="F:PrtgAPI.PingMode.MultiPing"/>.<para/> Corresponds to Ping Settings -> Ping Count. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PingDelay"> <summary> The delay between each Ping Request, when using <see cref="F:PrtgAPI.PingMode.MultiPing"/>.<para/> Corresponds to Ping Settings -> Ping Delay. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.AutoAcknowledge"> <summary> Whether this sensor should auto acknowledge on entering a <see cref="F:PrtgAPI.Status.Down"/> state.<para/> Corresponds to Ping Settings -> Auto Acknowledge. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritInterval"> <summary> Whether to inherit this object's scanning interval settings from its parent. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Interval"> <summary> The <see cref="T:PrtgAPI.ScanningInterval"/> with which an object refreshes its data. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.IntervalErrorMode"> <summary> The <see cref="T:PrtgAPI.IntervalErrorMode"/> indicating the number of scanning intervals to wait before setting a sensor to <see cref="F:PrtgAPI.Status.Down"/> when an error is reported. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.GraphType"> <summary> Whether channels should be shown independently in graphs, or stacked on top of each other.<para/> Corresponds to Sensor Display -> Graph Type. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ExeFile"> <summary> Name of the EXE or Script File the sensor executes.<para/> Corresponds to Sensor Settings -> EXE/Script </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ExeParameters"> <summary> Parameters that will be passed to the specified EXE/Script file.<para/> Corresponds to Sensor Settings -> Parameters. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SetExeEnvironmentVariables"> <summary> Whether PRTG Environment Variables (%host, %windowsusername, etc) will be available as System Environment Variables inside the EXE/Script.<para/> Corresponds to Sensor Settings -> Environment </summary> </member> <member name="F:PrtgAPI.ObjectProperty.UseWindowsAuthentication"> <summary> Whether to use the Windows Credentials of the parent device to execute the specified EXE/Script file. If custom credentials are not used, the file will be executed under the credentials of the PRTG Probe Service.<para/> Corresponds to Sensor Settings -> Security Context. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Mutex"> <summary> The mutex name to use. All sensors with the same mutex name will be executed sequentially, reducing resource utilization.<para/> Corresponds to Sensor Settings -> Mutex Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.WmiMode"> <summary> The method used for performing WMI queries.<para/> Corresponds to WMI Alternative Query -> Alternative Query. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Target"> <summary> The DNS name or IP Address to target. Applies to: WMI Remote Ping </summary> </member> <member name="F:PrtgAPI.ObjectProperty.PingRemotePacketSize"> <summary> The packet size to use for Remote Ping Requests (bytes). The default value is 32 bytes. This value must be between 1-10,000 bytes.<para/> Corresponds to WMI remote Ping Configuration -> Packet Size. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ChannelDefinition"> <summary> Channels to display in a sensor factory<para/> Corresponds to Sensor Factory Specific Settings -> Channel Definition </summary> </member> <member name="F:PrtgAPI.ObjectProperty.FactoryErrorMode"> <summary> How the sensor should respond when one of its source sensors goes <see cref="F:PrtgAPI.Status.Down"/><para/> Corresponds to Sensor Factory Specific Settings -> Error Handling. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.FactoryErrorFormula"> <summary> Custom formula for determining when a sensor sensor factory should go <see cref="F:PrtgAPI.Status.Down"/> when one of its source sensors enters an error state.<para/>Applies when <see cref="F:PrtgAPI.ObjectProperty.FactoryErrorMode"/> is <see cref="F:PrtgAPI.FactoryErrorMode.CustomFormula"/><para/> Corresponds to Sensor Factory Specific Settings -> Status Definition. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.FactoryMissingDataMode"> <summary> How factory channel values should be calculated when one of their source sensors is <see cref="F:PrtgAPI.Status.Down"/><para/> Corresponds to Sensor Factory Specific Settings -> If a Sensor has No Data. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.StartStopped"> <summary> Whether PRTG should automatically start this item if it detects it has stopped<para/> Corresponds to WMI Service Monitor -> If Service is Not Running. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.NotifyChanged"> <summary> Whether PRTG should trigger any Change notification triggers defined on this object when PRTG starts the object or its value changes.<para/> For specific trigger conditions see documentation for object type. Corresponds to<para/> Sensor Settings -> If Value Changes WMI Service Monitor -> If Service is Restarted. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.MonitorPerformance"> <summary> Whether PRTG should monitor just basic information for the target of the sensor, or should also collect additional performance metrics.<para/> Corresponds to WMI Service Monitor -> Monitoring. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Database"> <summary> The name of the database this sensor targets.<para/> Corresponds to Database Specific -> Database. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.UseCustomInstance"> <summary> Whether to use a custom instance of the SQL Server, or use the server's default instance. If using a custom instance and a value has not previously been specified, the <see cref="F:PrtgAPI.ObjectProperty.InstanceName"/> defaults to "SQLEXPRESS"<para/> Corresponds to Data Specific -> SQL Server Instance. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InstanceName"> <summary> The name of the custom instance of SQL Server to connect to.<para/> Corresponds to Database Specific -> Instance Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SqlEncryptionMode"> <summary> How to encrypt the connection between PRTG and the target database server.<para/> Corresponds to Database Specific -> Encryption. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SqlServerQuery"> <summary> A <see cref="T:PrtgAPI.Targets.SqlServerQueryTarget"/> describing the SQL query file used to query a database. This value can only be retrieved via direct calls to PRTG.<para/> Corresponds to Data -> SQL Query File. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.UseSqlInputParameter"> <summary> Whether to pass any parameters to the specified <see cref="F:PrtgAPI.ObjectProperty.SqlServerQuery"/>.<para/> Corresponds to Data -> Use Input Parameter. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SqlInputParameter"> <summary> Parameters to pass to the specified <see cref="F:PrtgAPI.ObjectProperty.SqlServerQuery"/>.<para/> Corresponds to Data -> Input Parameter. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SqlTransactionMode"> <summary> Whether PRTG should use transactional processing for executing the specified <see cref="F:PrtgAPI.ObjectProperty.SqlServerQuery"/>.<para/> Corresponds to Data -> Use Transaction. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.SqlProcessingMode"> <summary> A <see cref="T:PrtgAPI.SqlProcessingMode"/> specifying how PRTG should handle the data returned from the executed SQL query. This value can only be retrieved via direct calls to PRTG.<para/> Corresponds to Data -> Data Processing. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.InheritTriggers"> <summary> Whether to inherit notification triggers from the parent object.<para/> Corresponds to Notifications Tab -> Trigger Inheritance.<para/> To retrieve the value of this property, use <see cref="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.NotificationTypes"/> </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Comments"> <summary> Any comments applied to the object.<para> Corresponds to Comments Tab -> Comments.</para> </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Host"> <summary> The IPv4 Address or HostName to use to connect to a device. The same as <see cref="F:PrtgAPI.ObjectProperty.Hostv4"/>.<para/> Corresponds to Basic Device Settings -> IPv4 Address/DNS Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Hostv4"> <summary> The IPv4 Address or HostName to use to connect to a device. The same as <see cref="F:PrtgAPI.ObjectProperty.Host"/>.<para/> Corresponds to Basic Device Settings -> IPv4 Address/DNS Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.Hostv6"> <summary> The IPv6 Address or HostName to use to connect to a device.<para/> Corresponds to Basic Device Settings -> IPv6 Address/DNS Name. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.ServiceUrl"> <summary> The URL used to service this device.<para/> Corresponds to Additional Device Information -> Service URL. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.AutoDiscoveryMode"> <summary> Indicates how thoroughly PRTG should scan for compatible sensor types when performing an auto-discovery.<para/> Corresponds to Device Type -> Sensor Management. </summary> </member> <member name="F:PrtgAPI.ObjectProperty.AutoDiscoverySchedule"> <summary> How often auto-discovery operations on a device should be performed.<para/> Corresponds to Device Type -> Discovery Schedule. </summary> </member> <member name="T:PrtgAPI.TriggerProperty"> <summary> <para type="description">Specifies properties that can be modified on notification triggers.</para> </summary> </member> <member name="F:PrtgAPI.TriggerProperty.State"> <summary> The state that causes the trigger to activate. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.Latency"> <summary> The delay (in seconds) before the <see cref="F:PrtgAPI.TriggerProperty.OnNotificationAction"/> executes after the trigger has activated. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.OnNotificationAction"> <summary> The notification action to execute when the trigger has activated. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.OffNotificationAction"> <summary> The notification action to execute when the trigger has deactivated. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.EscalationNotificationAction"> <summary> The notification action to execute when the trigger continues to remain activated for an extended period of time. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.EscalationLatency"> <summary> The delay (in seconds) before the <see cref="F:PrtgAPI.TriggerProperty.EscalationNotificationAction"/> executes after the trigger has activated. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.RepeatInterval"> <summary> The delay (in minutes) before the <see cref="F:PrtgAPI.TriggerProperty.EscalationNotificationAction"/> should be re-executed. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.Channel"> <summary> The channel the trigger should apply to. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.Period"> <summary> The time period over which the <see cref="F:PrtgAPI.TriggerProperty.Threshold"/> volume is analyzed. Used in conjunction with <see cref="F:PrtgAPI.TriggerProperty.UnitSize"/>. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.UnitSize"> <summary> The unit component of the data rate that causes this trigger to activate. Used in conjunction with <see cref="F:PrtgAPI.TriggerProperty.Period"/> or <see cref="F:PrtgAPI.TriggerProperty.UnitTime"/>. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.Condition"> <summary> The condition that must be true for the trigger to activate. Used in conjunction with <see cref="F:PrtgAPI.TriggerProperty.Threshold"/>. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.Threshold"> <summary> The threshold that must be reached for the trigger to activate. Used in conjunction with <see cref="F:PrtgAPI.TriggerProperty.Condition"/>. </summary> </member> <member name="F:PrtgAPI.TriggerProperty.UnitTime"> <summary> The time component of the data rate that causes this trigger to activate. Used in conjunction with <see cref="F:PrtgAPI.TriggerProperty.UnitSize"/>. </summary> </member> <member name="T:PrtgAPI.TriggerSensorState"> <summary> Specifies sensor statuses that can cause a trigger to activate. </summary> </member> <member name="F:PrtgAPI.TriggerSensorState.Down"> <summary> Trigger when the sensor is <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="F:PrtgAPI.TriggerSensorState.Warning"> <summary> Trigger when the sensor is <see cref="F:PrtgAPI.Status.Warning"/>. </summary> </member> <member name="F:PrtgAPI.TriggerSensorState.Unusual"> <summary> Trigger when the sensor is <see cref="F:PrtgAPI.Status.Unusual"/>. </summary> </member> <member name="F:PrtgAPI.TriggerSensorState.PartialDown"> <summary> Trigger when the sensor is <see cref="F:PrtgAPI.Status.DownPartial"/>. </summary> </member> <member name="T:PrtgAPI.DataVolumeUnit"> <summary> Specifies data unit sizes that measure data volume. </summary> </member> <member name="F:PrtgAPI.DataVolumeUnit.Byte"> <summary> Bytes </summary> </member> <member name="F:PrtgAPI.DataVolumeUnit.KByte"> <summary> Kilobytes </summary> </member> <member name="F:PrtgAPI.DataVolumeUnit.MByte"> <summary> Megabytes </summary> </member> <member name="F:PrtgAPI.DataVolumeUnit.GByte"> <summary> Gigabytes </summary> </member> <member name="F:PrtgAPI.DataVolumeUnit.TByte"> <summary> Terabytes </summary> </member> <member name="T:PrtgAPI.RetryRequestEventArgs"> <summary> The arguments passed to an event handler when a web request is retried. </summary> </member> <member name="P:PrtgAPI.RetryRequestEventArgs.Exception"> <summary> Gets or sets the exception that caused the request to fail. </summary> </member> <member name="P:PrtgAPI.RetryRequestEventArgs.Url"> <summary> Gets or sets the URL of the request that failed. </summary> </member> <member name="P:PrtgAPI.RetryRequestEventArgs.RetriesRemaining"> <summary> Gets or sets the number of retries remaining for the current request. </summary> </member> <member name="M:PrtgAPI.RetryRequestEventArgs.#ctor(System.Exception,System.String,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.RetryRequestEventArgs"/> class. </summary> <param name="ex">The exception that caused the request to fail.</param> <param name="url">The URL of the request that failed.</param> <param name="retriesRemaining">The number of retries remaining.</param> </member> <member name="T:PrtgAPI.InvalidTriggerTypeException"> <summary> The exception that is thrown when a trigger of an incompatible type is added to an object. </summary> </member> <member name="M:PrtgAPI.InvalidTriggerTypeException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTriggerTypeException"/> class. </summary> </member> <member name="M:PrtgAPI.InvalidTriggerTypeException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTriggerTypeException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.InvalidTriggerTypeException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTriggerTypeException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.InvalidTriggerTypeException.#ctor(System.Int32,PrtgAPI.TriggerType,System.Collections.Generic.List{PrtgAPI.TriggerType})"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTriggerTypeException"/> class with a specified Object ID, the type of trigger that is invalid and a list of valid trigger types. </summary> <param name="objectId">The ID of the object the trigger attempted to be applied to.</param> <param name="type">The type of trigger that is not valid for the object.</param> <param name="validTypes">The types of triggers that are valid for the object.</param> </member> <member name="M:PrtgAPI.InvalidTriggerTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTriggerTypeException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.InvalidTypeException"> <summary> The exception that is thrown when a type is not valid for a specified context. </summary> </member> <member name="M:PrtgAPI.InvalidTypeException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTypeException"/> class. </summary> </member> <member name="M:PrtgAPI.InvalidTypeException.#ctor(System.Type)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTypeException"/> class with a specified type. </summary> <param name="type">The type that was not valid in the given context.</param> </member> <member name="M:PrtgAPI.InvalidTypeException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTypeException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.InvalidTypeException.#ctor(System.Type,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTypeException"/> class with a specified type and a reference to the inner exception that is the cause of this exception. </summary> <param name="type">The type that was not valid in the given context.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.InvalidTypeException.#ctor(System.Type,System.Type)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTypeException"/> class with the tye that was expected and the actual type that was received. </summary> <param name="expectedType">The type that was expected.</param> <param name="actualType">The type that was received.</param> </member> <member name="M:PrtgAPI.InvalidTypeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.InvalidTypeException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.NotificationAction"> <summary> <para type="description">An action to be performed by PRTG when a <see cref="T:PrtgAPI.NotificationTrigger"/> activates.</para> </summary> </member> <member name="P:PrtgAPI.NotificationAction.Url"> <summary> URL of this object. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Postpone"> <summary> Whether alerts triggered outside of this notification's <see cref="P:PrtgAPI.NotificationAction.Schedule"/> should be sent out when the scheduled pause ends. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Comments"> <summary> Comments present on this object. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Schedule"> <summary> The schedule during which the notification action is active. When inactive, alerts sent to this notification will be ignored unless <see cref="P:PrtgAPI.NotificationAction.Postpone"/> is specified. </summary> </member> <member name="P:PrtgAPI.NotificationAction.SummaryMode"> <summary> Specifies how PRTG should summarize notifications when multiple alerts occur within quick succession. </summary> </member> <member name="P:PrtgAPI.NotificationAction.SummarySubject"> <summary> The subject line to use for summarize notification alerts. </summary> </member> <member name="P:PrtgAPI.NotificationAction.SummaryPeriod"> <summary> The timespan (in seconds) during which PRTG will gather new notifications before sending a summarization alert. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Email"> <summary> Settings that apply to Email Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Push"> <summary> Settings that apply to Email Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.SMS"> <summary> Settings that apply to SMS/Pager Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.EventLog"> <summary> Settings that apply to Event Log Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Syslog"> <summary> Settings that apply to Syslog Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.SNMP"> <summary> Settings that apply to SNMP Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Http"> <summary> Settings that apply to HTTP Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Program"> <summary> Setings that apply to Program Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Amazon"> <summary> Settings that apply to Amazon Notification Actions. </summary> </member> <member name="P:PrtgAPI.NotificationAction.Ticket"> <summary> Settings that apply to Ticket Notification Actions. </summary> </member> <member name="M:PrtgAPI.NotificationAction.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.NotificationAction"/> class. </summary> </member> <member name="T:PrtgAPI.NotificationTrigger"> <summary> <para type="description">Causes notification actions to occur when a sensor exhibits a specified behaviour.</para> </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.ObjectId"> <summary> The Object ID this notification trigger applies to. </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.ParentId"> <summary> The Object ID notification trigger is defined on. If this value is not the same as the <see cref="P:PrtgAPI.NotificationTrigger.ObjectId"/>, this indicates this notification trigger is inherited. </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Inherited"> <summary> Whether the notification trigger is defined on its parent object, or whether it is inherited from another object. </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Type"> <summary> The type of event that triggers this notification. Applies to: State, Volume, Threshold, Change, Speed Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.TypeName"> <summary> Full name of the event that triggers this notification. Applies to: State, Volume, Threshold, Change, Speed Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.SubId"> <summary> ID of the trigger on the object it is assigned to. Applies to: State, Volume, Threshold, Change, Speed Triggers </summary> </member> <member name="F:PrtgAPI.NotificationTrigger.stateTrigger"> <summary> State that will cause this notification to trigger. Applies to: State Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Latency"> <summary> Delay (in seconds) before this notification is activated after activation requirements have been met. Applies to: State, Threshold, Speed Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Channel"> <summary> The channel the trigger should apply to. Applies to: Speed, Threshold, Volume Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Unit"> <summary> The formatted units display of this trigger. </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.OnNotificationAction"> <summary> Notification action that will occur when trigger is activated. Applies to: State, Volume, Threshold, Change, Speed Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.OffNotificationAction"> <summary> Notification action that will occur when trigger is deactivated. Applies to: State, Threshold, Speed Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Threshold"> <summary> Value threshold or object state required before this notification is activated. Applies to: Threshold, Speed, Volume Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.Condition"> <summary> Condition that must be true for the trigger to activate. Applies to: Speed, Threshold Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.EscalationLatency"> <summary> Delay (in seconds) before the <see cref="P:PrtgAPI.NotificationTrigger.EscalationNotificationAction"/> occurs after this trigger has been activated. Applies to: State Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.EscalationNotificationAction"> <summary> Notification action that will occur when the trigger condition has been remained active for an extended period of time. Repeats every <see cref="P:PrtgAPI.NotificationTrigger.EscalationLatency"/> seconds. Applies to: State Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTrigger.RepeatInterval"> <summary> Interval to repeat the <see cref="P:PrtgAPI.NotificationTrigger.EscalationNotificationAction"/>, in minutes. Applies to: State Triggers </summary> </member> <member name="M:PrtgAPI.NotificationTrigger.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.SensorHistoryData"> <summary> Represents historical monitoring data for a sensor at a specified time period. </summary> </member> <member name="P:PrtgAPI.SensorHistoryData.DateTime"> <summary> The date and time to which this object's historical values apply. </summary> </member> <member name="P:PrtgAPI.SensorHistoryData.SensorId"> <summary> The ID of the sensor to which the historic channel data applies. </summary> </member> <member name="P:PrtgAPI.SensorHistoryData.ChannelRecords"> <summary> A collection of channels and their associated values at the DateTime indicated by this object. </summary> </member> <member name="P:PrtgAPI.SensorHistoryData.Coverage"> <summary> Indicates the percentage of time over the history averaging interval during which PRTG was successfully monitoring the sensor. </summary> </member> <member name="M:PrtgAPI.SensorHistoryData.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.ModificationEvent"> <summary> <para type="description">Represents a modification event of a PRTG Object.</para> </summary> </member> <member name="P:PrtgAPI.ModificationEvent.ObjectId"> <summary> The ID of the object the event occurred to. </summary> </member> <member name="P:PrtgAPI.ModificationEvent.DateTime"> <summary> The date/time the event was performed. </summary> </member> <member name="P:PrtgAPI.ModificationEvent.UserName"> <summary> The name of the user that performed the event. </summary> </member> <member name="P:PrtgAPI.ModificationEvent.Message"> <summary> A description of the event. </summary> </member> <member name="M:PrtgAPI.ModificationEvent.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.AutoMode"> <summary> Specifies whether something is specified or done automatically or manually. </summary> </member> <member name="F:PrtgAPI.AutoMode.Automatic"> <summary> The item is specified or done automatically. </summary> </member> <member name="F:PrtgAPI.AutoMode.Manual"> <summary> The item must be specified or done manually. </summary> </member> <member name="T:PrtgAPI.DebugMode"> <summary> Specifies whether to save debug information for troubleshooting sensor issues. </summary> </member> <member name="F:PrtgAPI.DebugMode.Discard"> <summary> Discard all debug information. </summary> </member> <member name="F:PrtgAPI.DebugMode.WriteToDisk"> <summary> Save debug information to disk. Debug information is stored under C:\ProgramData\Paessler\PRTG Network Monitor\Logs (Sensors) on the sensors probe server. </summary> </member> <member name="F:PrtgAPI.DebugMode.WriteToDiskWhenError"> <summary> Save debug information to disk if the scan results in an error. Not supported with WMI sensors. Debug information is stored under C:\ProgramData\Paessler\PRTG Network Monitor\Logs (Sensors) on the sensors probe server. </summary> </member> <member name="T:PrtgAPI.DependencyType"> <summary> Specifies the object this object is dependent on. When the dependent object goes down this object will be automatically paused. </summary> </member> <member name="F:PrtgAPI.DependencyType.Parent"> <summary> The object is dpendent on its parent (e.g. a sensor is dependent upon its device). </summary> </member> <member name="F:PrtgAPI.DependencyType.Object"> <summary> The object is dependent on an arbitrary PRTG object. </summary> </member> <member name="F:PrtgAPI.DependencyType.MasterObject"> <summary> Indicates that the object is the "master" object of its parent. When the master object goes down, the parent (and any objects it is the <see cref="F:PrtgAPI.DependencyType.Parent"/> of) goes down. Objects should only have one master object. </summary> </member> <member name="T:PrtgAPI.IntervalErrorMode"> <summary> Specifies the number of scanning intervals to wait before setting the sensor <see cref="F:PrtgAPI.Status.Down"/> when an error is reported. When an error clears, the sensor will go <see cref="F:PrtgAPI.Status.Up"/> immediately. </summary> </member> <member name="F:PrtgAPI.IntervalErrorMode.DownImmediately"> <summary> Set the sensor to <see cref="F:PrtgAPI.Status.Down"/> immediately. </summary> </member> <member name="F:PrtgAPI.IntervalErrorMode.OneWarningThenDown"> <summary> Set the sensor to <see cref="F:PrtgAPI.Status.Warning"/>, and then to <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="F:PrtgAPI.IntervalErrorMode.TwoWarningsThenDown"> <summary> Set the sensor to <see cref="F:PrtgAPI.Status.Warning"/> for two intervals, and then to <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="F:PrtgAPI.IntervalErrorMode.ThreeWarningsThenDown"> <summary> Set the sensor to <see cref="F:PrtgAPI.Status.Warning"/> for three intervals, and then to <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="F:PrtgAPI.IntervalErrorMode.FourWarningsThenDown"> <summary> Set the sensor to <see cref="F:PrtgAPI.Status.Warning"/> for four intervals, and then to <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="F:PrtgAPI.IntervalErrorMode.FiveWarningsThenDown"> <summary> Set the sensor to <see cref="F:PrtgAPI.Status.Warning"/> for five intervals, and then to <see cref="F:PrtgAPI.Status.Down"/>. </summary> </member> <member name="T:PrtgAPI.ScanningInterval"> <summary> Represents a well known or custom TimeSpan used for the Scanning Interval of an object. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.ThirtySeconds"> <summary> Scan every 30 seconds. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.SixtySeconds"> <summary> Scan every 60 seconds. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.FiveMinutes"> <summary> Scan every 5 minutes. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.TenMinutes"> <summary> Scan every 10 minutes. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.FifteenMinutes"> <summary> Scan every 15 minutes. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.ThirtyMinutes"> <summary> Scan every 30 minutes </summary> </member> <member name="F:PrtgAPI.ScanningInterval.OneHour"> <summary> Scan every 1 hour. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.FourHours"> <summary> Scan every 4 hours. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.SixHours"> <summary> Scan every 6 hours. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.TwelveHours"> <summary> Scan every 12 hours. </summary> </member> <member name="F:PrtgAPI.ScanningInterval.TwentyFourHours"> <summary> Scan every 24 hours. </summary> </member> <member name="M:PrtgAPI.ScanningInterval.Parse(System.Object)"> <summary> Converts an object of one of several types to a <see cref="T:PrtgAPI.ScanningInterval"/>. If the specified value is not convertable to <see cref="T:PrtgAPI.ScanningInterval"/>, an <see cref="T:System.InvalidCastException"/> is thrown. </summary> <param name="value">The value to parse.</param> <returns>A <see cref="T:PrtgAPI.ScanningInterval"/> that encapsulates the passed value.</returns> </member> <member name="M:PrtgAPI.ScanningInterval.TryParse(System.Object,PrtgAPI.ScanningInterval@)"> <summary> Converts an object of one of several types to a <see cref="T:PrtgAPI.ScanningInterval"/>. A return value indicates whether the conversion succeeded. </summary> <param name="value">The value to parse.</param> <param name="result">When this method returns, if the <paramref name="value"/> was successfully converted to a <see cref="T:PrtgAPI.ScanningInterval"/>, this parameter contains the result of that conversion. If the conversion was unsuccessful, this parameter will be set to null. </param> <returns>True if the value was successfully parsed. Otherwise, false.</returns> </member> <member name="M:PrtgAPI.ScanningInterval.#ctor(System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.ScanningInterval"/> class from a TimeSpan. </summary> <param name="interval"></param> </member> <member name="M:PrtgAPI.ScanningInterval.op_Implicit(System.TimeSpan)~PrtgAPI.ScanningInterval"> <summary> Creates a new <see cref="T:PrtgAPI.ScanningInterval"/> from a specified <see cref="P:PrtgAPI.ScanningInterval.TimeSpan"/>. </summary> <param name="interval">A custom TimeSpan that will be used for the interval.<para/> If the PRTG Server has not been configured to recognize the specified TimeSpan, it will be rounded to the nearest valid value.</param> </member> <member name="M:PrtgAPI.ScanningInterval.op_Implicit(PrtgAPI.StandardScanningInterval)~PrtgAPI.ScanningInterval"> <summary> Creates a new <see cref="T:PrtgAPI.ScanningInterval"/> from a well known Scanning Interval. </summary> <param name="interval">A standard TimeSpan that will be used for the scanning interval.</param> </member> <member name="P:PrtgAPI.ScanningInterval.TimeSpan"> <summary> Gets the <see cref="T:System.TimeSpan"/> representation of the underlying interval. </summary> </member> <member name="M:PrtgAPI.ScanningInterval.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.ScanningInterval.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object <paramref name="other"/> is equal to this object. The specified object is equal to this if both objects are of the same type and have the same <see cref="P:PrtgAPI.ScanningInterval.TimeSpan"/>. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.ScanningInterval.GetHashCode"> <summary> Returns a hash code for this object. If two objects are both scanning intervals and have the same <see cref="P:PrtgAPI.ScanningInterval.TimeSpan"/>, they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="M:PrtgAPI.ScanningInterval.Equals(PrtgAPI.ScanningInterval)"> <summary> Returns a boolean indicating if the specified <see cref="T:PrtgAPI.ScanningInterval"/> is equal to this object. The specified object is equal to this if both values have the same <see cref="P:PrtgAPI.ScanningInterval.TimeSpan"/>. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="T:PrtgAPI.StandardScanningInterval"> <summary> Specifies the interval at which a sensor initiates a scan to refresh its data. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.ThirtySeconds"> <summary> Scan every 30 seconds. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.SixtySeconds"> <summary> Scan every 60 seconds. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.FiveMinutes"> <summary> Scan every 5 minutes. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.TenMinutes"> <summary> Scan every 10 minutes. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.FifteenMinutes"> <summary> Scan every 15 minutes. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.ThirtyMinutes"> <summary> Scan every 30 minutes. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.OneHour"> <summary> Scan every 1 hour. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.FourHours"> <summary> Scan every 4 hours. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.SixHours"> <summary> Scan every 6 hours. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.TwelveHours"> <summary> Scan every 12 hours. </summary> </member> <member name="F:PrtgAPI.StandardScanningInterval.TwentyFourHours"> <summary> Scan every 24 hours. </summary> </member> <member name="T:PrtgAPI.WmiMode"> <summary> Specifies the method PRTG uses to query a WMI sensor. </summary> </member> <member name="F:PrtgAPI.WmiMode.Default"> <summary> The default query method. </summary> </member> <member name="F:PrtgAPI.WmiMode.Alternative"> <summary> The alternative query method. May resolve errors such as "class not valid" or "invalid data" at the cost of potentially less accurate results. </summary> </member> <member name="F:PrtgAPI.HtmlFunction.AddSensor4"> <summary> Contains the content returned by a request for additional device information from <see cref="F:PrtgAPI.CommandFunction.AddSensor2"/>. </summary> </member> <member name="T:PrtgAPI.HistoricValueMode"> <summary> Specifies how values are displayed for aggregated timespans. </summary> </member> <member name="F:PrtgAPI.HistoricValueMode.Average"> <summary> The average of values in the timespan is used. </summary> </member> <member name="F:PrtgAPI.HistoricValueMode.Minimum"> <summary> The minimum value in the timespan is used. </summary> </member> <member name="F:PrtgAPI.HistoricValueMode.Maximum"> <summary> The maximum value in the timespan is used. </summary> </member> <member name="T:PrtgAPI.Channel"> <summary> <para type="description">A value within a sensor that contains the results of monitoring operations.</para> </summary> </member> <member name="P:PrtgAPI.Channel.Id"> <summary> Unique identifier of this channel within its parent sensor. </summary> </member> <member name="P:PrtgAPI.Channel.Name"> <summary> Name of this channel. </summary> </member> <member name="P:PrtgAPI.Channel.DisplayLastValue"> <summary> Last display value of this channel. If this channel's sensor is currently paused, this may display "No data" </summary> </member> <member name="P:PrtgAPI.Channel.LastValue"> <summary> The raw last value of this channel.<para/> This value is represented in the smallest unit the <see cref="P:PrtgAPI.Channel.Unit"/> can be divided into (seconds, bits, bytes, etc) </summary> </member> <member name="P:PrtgAPI.Channel.ScalingMultiplication"> <summary> A value that multiplies the raw value of this channel. </summary> </member> <member name="P:PrtgAPI.Channel.ScalingDivision"> <summary> A value that divides the raw value of this channel. </summary> </member> <member name="P:PrtgAPI.Channel.SensorId"> <summary> ID of the sensor this channel belongs to. </summary> </member> <member name="P:PrtgAPI.Channel.ShowInGraph"> <summary> Whether this channel should be shown in graphs. </summary> </member> <member name="P:PrtgAPI.Channel.ShowInTable"> <summary> Whether this channel should be shown in tables and API responses. If this value is set to false you will be unable to restore visibility without manual intervention or an existing reference to this object. </summary> </member> <member name="P:PrtgAPI.Channel.ColorMode"> <summary> Whether the line color of this channel in graphs should be automatically chosen or defined manually. </summary> </member> <member name="P:PrtgAPI.Channel.LineColor"> <summary> The line color to use for this channel in graphs. Applies when <see cref="P:PrtgAPI.Channel.ColorMode"/> is <see cref="F:PrtgAPI.AutoMode.Manual"/>. </summary> </member> <member name="P:PrtgAPI.Channel.PercentMode"> <summary> Specifies whether to display the actual value stored in the channel, or display the value as a percentage of a specified maximum. </summary> </member> <member name="P:PrtgAPI.Channel.PercentValue"> <summary> The maximum to use for calculating the percentage to display this channel's value as. Applies when <see cref="P:PrtgAPI.Channel.PercentMode"/> is <see cref="F:PrtgAPI.PercentDisplay.PercentOfMax"/>. </summary> </member> <member name="P:PrtgAPI.Channel.Factor"> <summary> Value multiplication factor for this object's <see cref="P:PrtgAPI.Channel.Unit"/>. Used when modifying certain properties.<para/> For internal use only. </summary> </member> <member name="P:PrtgAPI.Channel.LineWidth"> <summary> The width of this channel's graph line, in pixels. </summary> </member> <member name="P:PrtgAPI.Channel.Unit"> <summary> The unit this channel's value is measured in. </summary> </member> <member name="P:PrtgAPI.Channel.ValueLookup"> <summary> A standard or custom value lookup that allows this sensor's value to be displayed as text in a gauge or a switch. </summary> </member> <member name="P:PrtgAPI.Channel.HistoricValueMode"> <summary> Controls how values are displayed in historic data of a timespan. </summary> </member> <member name="P:PrtgAPI.Channel.DecimalMode"> <summary> Controls how decimal places are displayed for the value of this channel. </summary> </member> <member name="P:PrtgAPI.Channel.DecimalPlaces"> <summary> The number of decimal places use to display the value of this channel. Applies when <see cref="P:PrtgAPI.Channel.DecimalMode"/> is <see cref="F:PrtgAPI.DecimalMode.Custom"/>. </summary> </member> <member name="P:PrtgAPI.Channel.SpikeFilterEnabled"> <summary> Whether values that are too high or too low should be filtered out of graphs and tables. </summary> </member> <member name="P:PrtgAPI.Channel.SpikeFilterMax"> <summary> The upper limit for spike filtering. Values above this value will be ignored. </summary> </member> <member name="P:PrtgAPI.Channel.SpikeFilterMin"> <summary> The lower limit for spike filtering. Values below this value will be ignored. </summary> </member> <member name="P:PrtgAPI.Channel.VerticalAxisScaling"> <summary> Indicates how to scale this channel in graphs. </summary> </member> <member name="P:PrtgAPI.Channel.VerticalAxisMax"> <summary> Maximum value to display on the graphs vertical axis. If <see cref="P:PrtgAPI.Channel.VerticalAxisScaling"/> is <see cref="F:PrtgAPI.AutoMode.Automatic"/> this value has no effect. </summary> </member> <member name="P:PrtgAPI.Channel.VerticalAxisMin"> <summary> Minimum value to display on the graphs vertical axis. If <see cref="P:PrtgAPI.Channel.VerticalAxisScaling"/> is <see cref="F:PrtgAPI.AutoMode.Automatic"/> this value has no effect. </summary> </member> <member name="P:PrtgAPI.Channel.LimitsEnabled"> <summary> Whether warning or error limits are enabled for this channel. When this channel's value crosses these limits, the channel's sensor will transition into an error or warning state. </summary> </member> <member name="P:PrtgAPI.Channel.UpperErrorLimit"> <summary> The upper error for this channel. If the <see cref="P:PrtgAPI.Channel.LastValue"/> of this channel goes above this limit, the channel will begin transitioning into an error state. </summary> </member> <member name="P:PrtgAPI.Channel.UpperWarningLimit"> <summary> The upper warning limit of this channel. If the <see cref="P:PrtgAPI.Channel.LastValue"/> of this channel goes above this limit, the channel will immediately transition into a warning state. </summary> </member> <member name="P:PrtgAPI.Channel.LowerErrorLimit"> <summary> The lower error for this channel. If the <see cref="P:PrtgAPI.Channel.LastValue"/> of this channel goes below this limit, the channel will begin transitioning into an error state. </summary> </member> <member name="P:PrtgAPI.Channel.LowerWarningLimit"> <summary> The lower warning limit of this channel. If the <see cref="P:PrtgAPI.Channel.LastValue"/> of this channel goes below this limit, the channel will immediately transition into a warning state. </summary> </member> <member name="P:PrtgAPI.Channel.ErrorLimitMessage"> <summary> The message to display when the <see cref="P:PrtgAPI.Channel.LastValue"/> of this channel goes above or below the <see cref="P:PrtgAPI.Channel.UpperErrorLimit"/> or <see cref="P:PrtgAPI.Channel.LowerErrorLimit"/> respectively. </summary> </member> <member name="P:PrtgAPI.Channel.WarningLimitMessage"> <summary> The message to display when the <see cref="P:PrtgAPI.Channel.LastValue"/> of this channel goes above or below the <see cref="P:PrtgAPI.Channel.UpperWarningLimit"/> or <see cref="P:PrtgAPI.Channel.LowerWarningLimit"/> respectively. </summary> </member> <member name="M:PrtgAPI.Channel.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.PercentDisplay"> <summary> Specifies how the value on a channel is displayed. </summary> </member> <member name="F:PrtgAPI.PercentDisplay.Actual"> <summary> The actual value of the channel is displayed. </summary> </member> <member name="F:PrtgAPI.PercentDisplay.PercentOfMax"> <summary> The value of the channel is displayed as a percentage of a specified maximum. </summary> </member> <member name="T:PrtgAPI.DecimalMode"> <summary> Specifies how decimal places are displayed. </summary> </member> <member name="F:PrtgAPI.DecimalMode.Automatic"> <summary> The number of decimal places to display is determined automatically. </summary> </member> <member name="F:PrtgAPI.DecimalMode.All"> <summary> All decimal places are displayed. </summary> </member> <member name="F:PrtgAPI.DecimalMode.Custom"> <summary> A specified number of decimal places are displayed. </summary> </member> <member name="T:PrtgAPI.Schedule"> <summary> <para type="description">Represents a schedule used to indicate when monitoring should be active on an object.</para> </summary> </member> <member name="P:PrtgAPI.Schedule.Url"> <summary> URL of this object. </summary> </member> <member name="P:PrtgAPI.Schedule.TimeTable"> <summary> Specifies the times monitoring is active.<para/> If this object was retrieved from a read only user, this value is null. </summary> </member> <member name="M:PrtgAPI.Schedule.#ctor(System.Int32,System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.Schedule"/> class. </summary> <param name="id">The ID of the schedule.</param> <param name="name">The name of the schedule.</param> </member> <member name="M:PrtgAPI.Schedule.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects have the same raw value. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedule.Equals(PrtgAPI.Schedule)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. The specified object is equal to this if both objects have the same raw value. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.Schedule.GetHashCode"> <summary> Returns a hash code for this object. If two Schedules have the same raw value, they will have the same hash code. </summary> <returns>A hash code for the current object.</returns> </member> <member name="T:PrtgAPI.SensorTotals"> <summary> <para type="description">Indicates the total number of each type of sensor on a PRTG Server.</para> </summary> </member> <member name="P:PrtgAPI.SensorTotals.UpSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Up"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.DownSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Down"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.WarningSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Warning"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.DownAcknowledgedSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.DownAcknowledged"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.PartialDownSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.DownPartial"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.UnusualSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Unusual"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.PausedSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.PausedByUser"/>, <see cref="F:PrtgAPI.Status.PausedByDependency"/>, <see cref="F:PrtgAPI.Status.PausedBySchedule"/> or <see cref="F:PrtgAPI.Status.PausedByLicense"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.UndefinedSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Unknown"/> state. </summary> </member> <member name="P:PrtgAPI.SensorTotals.TotalSensors"> <summary> Total number of sensors in any <see cref="T:PrtgAPI.Status"/> state. </summary> </member> <member name="T:PrtgAPI.ServerStatus"> <summary> <para type="description">Status details of a PRTG Server.</para> </summary> </member> <member name="P:PrtgAPI.ServerStatus.DateTime"> <summary> Current system time on the PRTG Core Server. </summary> </member> <member name="P:PrtgAPI.ServerStatus.Version"> <summary> Version of PRTG Network Monitor used by the server. </summary> </member> <member name="P:PrtgAPI.ServerStatus.Is64Bit"> <summary> Whether the PRTG Core is running as 64-bit. </summary> </member> <member name="P:PrtgAPI.ServerStatus.NewLogs"> <summary> The number of new unread log entries since last logon. </summary> </member> <member name="P:PrtgAPI.ServerStatus.NewAlarms"> <summary> The number of new unread red sensor alerts since last logon. </summary> </member> <member name="P:PrtgAPI.ServerStatus.Alarms"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.Down"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.AcknowledgedAlarms"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.DownAcknowledged"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.PartialAlarms"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.DownPartial"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.UnusualSensors"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.Unusual"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.UpSensors"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.Up"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.WarningSensors"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.Warning"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.PausedSensors"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.Paused"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.UnknownSensors"> <summary> The number of sensors currently in a <see cref="F:PrtgAPI.Status.Unknown"/> state. </summary> </member> <member name="P:PrtgAPI.ServerStatus.NewTickets"> <summary> The number of new unread tickets since last logon. </summary> </member> <member name="P:PrtgAPI.ServerStatus.UserId"> <summary> Object ID of your user within PRTG. </summary> </member> <member name="P:PrtgAPI.ServerStatus.UserTimeZone"> <summary> UTC offset of your PRTG Server's timezone. </summary> </member> <member name="P:PrtgAPI.ServerStatus.Favorites"> <summary> Indicates how many sensors have been favorited. </summary> </member> <member name="P:PrtgAPI.ServerStatus.BackgroundTasks"> <summary> The number of miscellaneous background tasks that are currently running. </summary> </member> <member name="P:PrtgAPI.ServerStatus.CorrelationTasks"> <summary> The number of similar sensor analysis tasks that are currently running. </summary> </member> <member name="P:PrtgAPI.ServerStatus.AutoDiscoveryTasks"> <summary> The number of Auto-Discovery tasks that are currently running. </summary> </member> <member name="P:PrtgAPI.ServerStatus.ReportTasks"> <summary> The number of scheduled report tasks that are currently running. </summary> </member> <member name="P:PrtgAPI.ServerStatus.LicenseType"> <summary> Whether PRTG has a Commercial License or is Freeware. </summary> </member> <member name="P:PrtgAPI.ServerStatus.UpdateAvailable"> <summary> Whether a PRTG Update is available for installation. </summary> </member> <member name="P:PrtgAPI.ServerStatus.MaintenanceExpiryDays"> <summary> Number of days until PRTG's licensed maintenance plan expires. </summary> </member> <member name="P:PrtgAPI.ServerStatus.TrialExpiryDays"> <summary> Number of days until or since your PRTG Trial expires/has expired. If a commercial license has been applied, this value is null. </summary> </member> <member name="P:PrtgAPI.ServerStatus.CommercialExpiryDays"> <summary> Number of days until your commercial license expires. In practice, commercial licenses do not expire.<para/> Equal to 1000 years + <see cref="P:PrtgAPI.ServerStatus.MaintenanceExpiryDays"/> + 5. If you do not have a commercial license, this value is null. </summary> </member> <member name="P:PrtgAPI.ServerStatus.OverloadProtection"> <summary> Whether the PRTG server is currently throttling user authentication requests due to excessive failed logons. </summary> </member> <member name="P:PrtgAPI.ServerStatus.ClusterNodeType"> <summary> Indicates whether this node is the Master or a Failover Node in a PRTG Cluster. If this node is not part of a cluster, this value is null. </summary> </member> <member name="P:PrtgAPI.ServerStatus.ClusterNodeName"> <summary> The name of this node in the PRTG Cluster. If this PRTG Server is not part of a PRTG Cluster, this value is null. </summary> </member> <member name="P:PrtgAPI.ServerStatus.IsAdminUser"> <summary> Whether the current user is a member of a group granting administrative rights. </summary> </member> <member name="P:PrtgAPI.ServerStatus.IsCluster"> <summary> Indicates whether this PRTG Server is part of a PRTG Cluster. </summary> </member> <member name="P:PrtgAPI.ServerStatus.ReadOnlyUser"> <summary> Indicates whether the current user is restricted to read-only access to PRTG. </summary> </member> <member name="P:PrtgAPI.ServerStatus.TicketUser"> <summary> Indicates whether the current user has access to the PRTG Ticketing System. </summary> </member> <member name="P:PrtgAPI.ServerStatus.ReadOnlyAllowAcknowledge"> <summary> If this user is a <see cref="P:PrtgAPI.ServerStatus.ReadOnlyUser"/>, indicates whether this user is allowed to acknowledge sensors.<para/> If this user is not a read only user, this value is false. </summary> </member> <member name="P:PrtgAPI.ServerStatus.LowMemory"> <summary> Whether the PRTG Core Server is currently running low on memory. </summary> </member> <member name="P:PrtgAPI.ServerStatus.HostId"> <summary> Host ID of the PRTG Core Server. </summary> </member> <member name="P:PrtgAPI.ServerStatus.MaxSensorCount"> <summary> Maximum number of sensors that can be created. If there is no maximum (as PRTG has an Unlimited license) this value is null. </summary> </member> <member name="P:PrtgAPI.ServerStatus.Activated"> <summary> Whether PRTG's license has been activated. </summary> </member> <member name="T:PrtgAPI.ObjectSettings"> <summary> Settings that apply to Objects within PRTG. </summary> </member> <member name="T:PrtgAPI.SensorSettings"> <summary> Settings that apply to Sensors within PRTG. </summary> </member> <member name="P:PrtgAPI.SensorSettings.InheritAccess"> <summary> Whether to inherit Access Rights settings from the parent object.<para/> Corresponds to Access Rights -> Inherit Access Rights. </summary> </member> <member name="P:PrtgAPI.SensorSettings.Name"> <summary> The name of this sensor.<para/> Corresponds to Basic Sensor Settings -> Name </summary> </member> <member name="P:PrtgAPI.SensorSettings.ParentTags"> <summary> Tags that are inherited from this objects parent.<para/> Corresponds to Basic Sensor Settings -> Parent Tags </summary> </member> <member name="P:PrtgAPI.SensorSettings.Tags"> <summary> Tags that are defined on this object.<para/> Corresponds to Basic Sensor Settings -> Tags </summary> </member> <member name="P:PrtgAPI.SensorSettings.Priority"> <summary> The priority of this sensor.<para/> Corresponds to Basic Sensor Settings -> Priority </summary> </member> <member name="P:PrtgAPI.SensorSettings.DebugMode"> <summary> How raw sensor results should be stored for debugging purposes. Corresponds to:<para/> Debug Options (WMI) -> Sensor Result<para/> Sensor Settings (EXE/XML) -> EXE Result<para/> WMI Service Monitor -> Sensor Result </summary> </member> <member name="P:PrtgAPI.SensorSettings.Url"> <summary> The URL to monitor. If a protocol is not specified, HTTP is used.<para/> Corresponds to HTTP Specific -> URL. </summary> </member> <member name="P:PrtgAPI.SensorSettings.HttpRequestMethod"> <summary> The HTTP Request Method to use for requesting the <see cref="P:PrtgAPI.SensorSettings.Url"/>.<para/> Corresponds to HTTP Specific -> Request Method. </summary> </member> <member name="P:PrtgAPI.SensorSettings.PostData"> <summary> Data to include in POST requests. Applies when <see cref="P:PrtgAPI.SensorSettings.HttpRequestMethod"/> is <see cref="F:PrtgAPI.HttpRequestMethod.POST"/>.<para/> Corresponds to HTTP Specific -> Postdata. </summary> </member> <member name="P:PrtgAPI.SensorSettings.UseCustomPostContent"> <summary> Whether POST requests should use a custom content type. If false, content type "application/x-www-form-urlencoded" will be used.<para/> Corresponds to HTTP Specific -> Content Type. </summary> </member> <member name="P:PrtgAPI.SensorSettings.PostContentType"> <summary> Custom content type to use for POST requests.<para/> Corresponds to HTTP Specific -> Custom Content Type. </summary> </member> <member name="P:PrtgAPI.SensorSettings.SNI"> <summary> The Server Name Indication to use for requests.<para/> Corresponds to HTTP Specific -> Server Name Indication. </summary> </member> <member name="P:PrtgAPI.SensorSettings.UseSNIFromUrl"> <summary> Whether the Server Name Indication is inherited from the parent device, or derived from the specified <see cref="P:PrtgAPI.SensorSettings.Url"/>.<para/> Corresponds to HTTP Specific -> SNI Inheritance. </summary> </member> <member name="P:PrtgAPI.SensorSettings.Timeout"> <summary> The duration (in seconds) this sensor can run for before timing out. Based on the sensor type, the maximum valid value may be different. Corresponds to:<para/> Ping Settings -> Timeout (Max 300)<para/> WMI Remote Ping Configuration -> Timeout (Max 300)<para/> HTTP Specific -> Timeout (Max 900)<para/> Sensor Settings (EXE/XML) -> Timeout (Max 900) </summary> </member> <member name="P:PrtgAPI.SensorSettings.PingPacketSize"> <summary> The packet size to use for Ping Requests (bytes). The default value is 32 bytes. This value must be between 1-10,000 bytes.<para/> Corresponds to Ping Settings -> Packet Size. </summary> </member> <member name="P:PrtgAPI.SensorSettings.PingMode"> <summary> Whether to send a single Ping or Multiple Pings. If <see cref="F:PrtgAPI.PingMode.MultiPing"/> is used, all packets must be most for the sensor to go <see cref="F:PrtgAPI.Status.Down"/>.<para/> Corresponds to Ping Settings -> Ping Method. </summary> </member> <member name="P:PrtgAPI.SensorSettings.PingCount"> <summary> The number of Ping Requests to make, when using <see cref="F:PrtgAPI.PingMode.MultiPing"/>.<para/> Corresponds to Ping Settings -> Ping Count. </summary> </member> <member name="P:PrtgAPI.SensorSettings.PingDelay"> <summary> The delay between each Ping Request, when using <see cref="F:PrtgAPI.PingMode.MultiPing"/> (ms).<para/> Corresponds to Ping Settings -> Ping Delay. </summary> </member> <member name="P:PrtgAPI.SensorSettings.AutoAcknowledge"> <summary> Whether this sensor should auto acknowledge on entering a <see cref="F:PrtgAPI.Status.Down"/> state.<para/> Corresponds to Ping Settings -> Auto Acknowledge. </summary> </member> <member name="P:PrtgAPI.SensorSettings.GraphType"> <summary> Whether channels should be shown independently in graphs, or stacked on top of each other.<para/> Corresponds to Sensor Display -> Graph Type. </summary> </member> <member name="P:PrtgAPI.SensorSettings.ExeFile"> <summary> Name of the EXE or Script File the sensor executes.<para/> Corresponds to Sensor Settings -> EXE/Script </summary> </member> <member name="P:PrtgAPI.SensorSettings.ExeParameters"> <summary> Parameters that will be passed to the specified EXE/Script file.<para/> Corresponds to Sensor Settings -> Parameters. </summary> </member> <member name="P:PrtgAPI.SensorSettings.SetExeEnvironmentVariables"> <summary> Whether PRTG Environment Variables (%host, %windowsusername, etc) will be available as System Environment Variables inside the EXE/Script.<para/> Corresponds to Sensor Settings -> Environment </summary> </member> <member name="P:PrtgAPI.SensorSettings.UseWindowsAuthentication"> <summary> Whether to use the Windows Credentials of the parent device to execute the specified EXE/Script file. If custom credentials are not used, the file will be executed under the credentials of the PRTG Probe Service.<para/> Corresponds to Sensor Settings -> Security Context. </summary> </member> <member name="P:PrtgAPI.SensorSettings.Mutex"> <summary> The mutex name to use. All sensors with the same mutex name will be executed sequentially, reducing resource utilization.<para/> Corresponds to Sensor Settings -> Mutex Name. </summary> </member> <member name="P:PrtgAPI.SensorSettings.WmiMode"> <summary> The method used for performing WMI queries.<para/> Corresponds to WMI Alternative Query -> Alternative Query. </summary> </member> <member name="P:PrtgAPI.SensorSettings.Target"> <summary> The DNS Name or IP Address to target.<para/> Corresponds to WMI Remote Ping Configuration -> Target. </summary> </member> <member name="P:PrtgAPI.SensorSettings.PingRemotePacketSize"> <summary> The packet size to use for Remote Ping Requests (bytes). The default value is 32 bytes. This value must be between 1-10,000 bytes.<para/> Corresponds to WMI remote Ping Configuration -> Packet Size. </summary> </member> <member name="P:PrtgAPI.SensorSettings.ChannelDefinition"> <summary> Channels to display in a sensor factory<para/> Corresponds to Sensor Factory Specific Settings -> Channel Definition </summary> </member> <member name="P:PrtgAPI.SensorSettings.FactoryErrorMode"> <summary> How the sensor should respond when one of its source sensors goes <see cref="F:PrtgAPI.Status.Down"/><para/> Corresponds to Sensor Factory Specific Settings -> Error Handling. </summary> </member> <member name="P:PrtgAPI.SensorSettings.FactoryErrorFormula"> <summary> Custom formula for determining when a sensor sensor factory should go <see cref="F:PrtgAPI.Status.Down"/> when one of its source sensors enters an error state.<para/>Applies when <see cref="P:PrtgAPI.SensorSettings.FactoryErrorMode"/> is <see cref="F:PrtgAPI.FactoryErrorMode.CustomFormula"/><para/> Corresponds to Sensor Factory Specific Settings -> Status Definition. </summary> </member> <member name="P:PrtgAPI.SensorSettings.FactoryMissingDataMode"> <summary> How factory channel values should be calculated when one of their source sensors is <see cref="F:PrtgAPI.Status.Down"/><para/> Corresponds to Sensor Factory Specific Settings -> If a Sensor has No Data </summary> </member> <member name="P:PrtgAPI.SensorSettings.StartStopped"> <summary> Whether PRTG should automatically start this item if it detects it has stopped<para/> Corresponds to WMI Service Monitor -> If Service is Not Running. </summary> </member> <member name="P:PrtgAPI.SensorSettings.NotifyChanged"> <summary> Whether PRTG should trigger any Change notification triggers defined on this object when PRTG starts the object or its value changes.<para/> For specific trigger conditions see documentation for object type. Corresponds to<para/> Sensor Settings -> If Value Changes WMI Service Monitor -> If Service is Restarted. </summary> </member> <member name="P:PrtgAPI.SensorSettings.MonitorPerformance"> <summary> Whether PRTG should monitor just basic information for the target of the sensor, or should also collect additional performance metrics.<para/> Corresponds to WMI Service Monitor -> Monitoring. </summary> </member> <member name="P:PrtgAPI.SensorSettings.ServiceName"> <summary> The name of the service. Is not shown in the PRTG UI; only the Service Display Name is shown. </summary> </member> <member name="P:PrtgAPI.SensorSettings.Database"> <summary> The name of the database this sensor targets.<para/> Corresponds to Database Specific -> Database. </summary> </member> <member name="P:PrtgAPI.SensorSettings.UseCustomInstance"> <summary> Whether to use a custom instance of the SQL Server, or use the server's default instance.<para/> Corresponds to Data Specific -> SQL Server Instance. </summary> </member> <member name="P:PrtgAPI.SensorSettings.InstanceName"> <summary> The name of the custom instance of SQL Server to connect to.<para/> Corresponds to Database Specific -> Instance Name. </summary> </member> <member name="P:PrtgAPI.SensorSettings.SqlEncryptionMode"> <summary> How to encrypt the connection between PRTG and the target database server.<para/> Corresponds to Database Specific -> Encryption. </summary> </member> <member name="P:PrtgAPI.SensorSettings.UseSqlInputParameter"> <summary> Whether to pass any parameters to the specified <see cref="F:PrtgAPI.ObjectProperty.SqlServerQuery"/>.<para/> Corresponds to Data -> Use Input Parameter. </summary> </member> <member name="P:PrtgAPI.SensorSettings.SqlInputParameter"> <summary> Parameters to pass to the specified <see cref="F:PrtgAPI.ObjectProperty.SqlServerQuery"/>.<para/> Corresponds to Data -> Input Parameter. </summary> </member> <member name="P:PrtgAPI.SensorSettings.SqlTransactionMode"> <summary> Whether PRTG should use transactional processing for executing the specified <see cref="F:PrtgAPI.ObjectProperty.SqlServerQuery"/>.<para/> Corresponds to Data -> Use Transaction. </summary> </member> <member name="M:PrtgAPI.SensorSettings.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.SearchFilter"> <summary> <para type="description">Represents a filter used to limit search results returned by a PRTG Request.</para> </summary> </member> <member name="P:PrtgAPI.SearchFilter.Property"> <summary> Gets or sets the property to filter by. </summary> </member> <member name="P:PrtgAPI.SearchFilter.Operator"> <summary> Gets or sets the operator to use to filter <see cref="P:PrtgAPI.SearchFilter.Property"/> with <see cref="P:PrtgAPI.SearchFilter.Value"/>. </summary> </member> <member name="P:PrtgAPI.SearchFilter.Value"> <summary> Gets or sets the value to filter on. </summary> </member> <member name="P:PrtgAPI.SearchFilter.FilterMode"> <summary> Gets or sets whether to validate and/or transform the serialized filter <see cref="P:PrtgAPI.SearchFilter.Value"/> according to the <see cref="P:PrtgAPI.SearchFilter.Property"/>'s required processing rules. </summary> </member> <member name="M:PrtgAPI.SearchFilter.#ctor(PrtgAPI.Property,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.SearchFilter"/> class for specifying a condition where a property is equal to a specified value. </summary> <param name="property">Property to filter on.</param> <param name="value">Value to filter on.</param> </member> <member name="M:PrtgAPI.SearchFilter.#ctor(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.SearchFilter"/> class with a specified property, operator and value. </summary> <param name="property">Property to filter on.</param> <param name="operator">Operator to use to filter <paramref name="property"/> with <paramref name="value"/></param> <param name="value">Value to filter on.</param> </member> <member name="M:PrtgAPI.SearchFilter.#ctor(PrtgAPI.Property,PrtgAPI.FilterOperator,System.Object,PrtgAPI.FilterMode)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.SearchFilter"/> class with a specified property, operator, value and filter mode. </summary> <param name="property">Property to filter on.</param> <param name="operator">Operator to use to filter <paramref name="property"/> with <paramref name="value"/></param> <param name="value">Value to filter on.</param> <param name="filterMode">Specifies whether to validate and/or transform the serialized <paramref name="value"/> according to the <paramref name="property"/>'s required processing rules.</param> </member> <member name="M:PrtgAPI.SearchFilter.ToString"> <summary> Returns the formatted string representation of this filter for use in a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/> </summary> <returns>A string that represents the current object.</returns> </member> <member name="T:PrtgAPI.Access"> <summary> Specifies the Access Rights applied to a PRTG Object. </summary> </member> <member name="F:PrtgAPI.Access.Inherited"> <summary> This object's access is inherited from its parent. </summary> </member> <member name="F:PrtgAPI.Access.None"> <summary> The object is not displayed. Logs, tickets and alarms pertaining to the object are not visible. </summary> </member> <member name="F:PrtgAPI.Access.Read"> <summary> The object can be viewed but not edited. </summary> </member> <member name="F:PrtgAPI.Access.Write"> <summary> The object can be viewed, edited and deleted. </summary> </member> <member name="F:PrtgAPI.Access.Full"> <summary> The object can be viewed, edited and deleted. In addition, Access Rights can be modified. </summary> </member> <member name="F:PrtgAPI.Access.Admin"> <summary> All options are available. </summary> </member> <member name="T:PrtgAPI.AuthMode"> <summary> Specifies the Authentication Mode used to make requests against PRTG. </summary> </member> <member name="F:PrtgAPI.AuthMode.PassHash"> <summary> PRTG PassHash corresponding to a PRTG or Active Directory user account. </summary> </member> <member name="F:PrtgAPI.AuthMode.Password"> <summary> Password corresponding to a PRTG or Active Directory user account. </summary> </member> <member name="T:PrtgAPI.BaseType"> <summary> Specifies the underlying type of a PRTG Object. </summary> </member> <member name="F:PrtgAPI.BaseType.Sensor"> <summary> An object used to monitor data on a system. </summary> </member> <member name="F:PrtgAPI.BaseType.Device"> <summary> A computer or piece of equipment containing one or more sensors monitored by PRTG. </summary> </member> <member name="F:PrtgAPI.BaseType.Group"> <summary> A group used to organize one or more devices. </summary> </member> <member name="F:PrtgAPI.BaseType.Probe"> <summary> A device used to perform monitoring against a site or set of systems. </summary> </member> <member name="T:PrtgAPI.ChannelProperty"> <summary> <para type="description">Specifies the properties of sensor channels that can be interfaced with using the PRTG API.</para> </summary> </member> <member name="F:PrtgAPI.ChannelProperty.Unit"> <summary> The unit that is displayed next to this sensor's value. Note that only certain sensor types (such as SNMP) support modifying the channel unit. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.ValueLookup"> <summary> A standard or custom value lookup that allows this sensor's value to be displayed as text in a gauge or a switch. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.ScalingMultiplication"> <summary> A value that multiplies the raw value of this channel. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.ScalingDivision"> <summary> A value that divides the raw value of this channel. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.ShowInGraph"> <summary> Whether this channel should be shown in graphs. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.ColorMode"> <summary> Whether the line color of this channel in graphs should be automatically chosen or defined manually. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.LineColor"> <summary> The line color to use for this channel in graphs. Applies when <see cref="F:PrtgAPI.ChannelProperty.ColorMode"/> is <see cref="F:PrtgAPI.AutoMode.Manual"/>. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.LineWidth"> <summary> The width of this channel's graph line, in pixels. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.HistoricValueMode"> <summary> Controls how values are displayed in historic data of a timespan. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.DecimalMode"> <summary> Controls how decimal places are displayed for the value of this channel. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.DecimalPlaces"> <summary> The number of decimal places use to display the value of this channel. Applies when <see cref="F:PrtgAPI.ChannelProperty.DecimalMode"/> is <see cref="F:PrtgAPI.DecimalMode.Custom"/>. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.SpikeFilterEnabled"> <summary> Whether spike filtering is enabled for this object. If filtering is enabled, channel results outside expected ranges will be rounded to their <see cref="F:PrtgAPI.ChannelProperty.SpikeFilterMin"/> or <see cref="F:PrtgAPI.ChannelProperty.SpikeFilterMax"/> values. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.SpikeFilterMax"> <summary> The maximum valid value of this channel. Results above this threshold will be rounded to this value. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.SpikeFilterMin"> <summary> The minimum valid value of this channel. Results below this threshold will be rounded to this value. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.PercentMode"> <summary> Specifies whether to display the actual value stored in the channel, or display the value as a percentage of a specified maximum. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.PercentValue"> <summary> The maximum to use for calculating the percentage to display this channel's value as. Applies when <see cref="T:PrtgAPI.PercentDisplay"/> is <see cref="F:PrtgAPI.PercentDisplay.PercentOfMax"/>. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.LimitsEnabled"> <summary> Whether limits are enabled for this object. If limits are disabled, limit thresholds will be ignored. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.UpperErrorLimit"> <summary> The maximum value allowed before the sensor goes into an error state. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.UpperWarningLimit"> <summary> The maximum value allowed before the sensor goes into a warning state. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.LowerErrorLimit"> <summary> The minimum value allowed before the sensor goes into an error state. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.LowerWarningLimit"> <summary> The minimum value allowed before the sensor goes into a warning state. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.ErrorLimitMessage"> <summary> The message to display when this channel's <see cref="F:PrtgAPI.ChannelProperty.UpperErrorLimit"/> or <see cref="F:PrtgAPI.ChannelProperty.LowerErrorLimit"/> is exceeded. </summary> </member> <member name="F:PrtgAPI.ChannelProperty.WarningLimitMessage"> <summary> The message to display when this channel's <see cref="F:PrtgAPI.ChannelProperty.UpperWarningLimit"/> or <see cref="F:PrtgAPI.ChannelProperty.LowerWarningLimit"/> is exceeded. </summary> </member> <member name="T:PrtgAPI.Position"> <summary> Specifies the direction to move an object when repositioning it within the PRTG User Interface. </summary> </member> <member name="F:PrtgAPI.Position.Up"> <summary> Move the object up by one position. </summary> </member> <member name="F:PrtgAPI.Position.Down"> <summary> Move the object down by one position. </summary> </member> <member name="F:PrtgAPI.Position.Top"> <summary> Move the object to the top. All subsequent objects will be shifted down one position. </summary> </member> <member name="F:PrtgAPI.Position.Bottom"> <summary> Move the object to the bottom. All objects previously preceding this object will be shifted up one position. </summary> </member> <member name="T:PrtgAPI.Property"> <summary> <para type="description">Specifies properties that can be retrieved for and filtered by on PRTG Objects.</para> </summary> </member> <member name="F:PrtgAPI.Property.Id"> <summary> Unique identifier of the object. </summary> </member> <member name="F:PrtgAPI.Property.Type"> <summary> <see cref="T:PrtgAPI.ObjectType"/> of the object. When filtering for sensors, specific sensor types must be specified. </summary> </member> <member name="F:PrtgAPI.Property.Name"> <summary> Name of the object or the object an <see cref="T:PrtgAPI.IEventObject"/> applies to. </summary> </member> <member name="F:PrtgAPI.Property.Tags"> <summary> Tags defined on the object or inherited from all parent objects. </summary> </member> <member name="F:PrtgAPI.Property.Active"> <summary> Whether an object is currently active or has been <see cref="F:PrtgAPI.Status.Paused"/>. </summary> </member> <member name="F:PrtgAPI.Property.Downtime"> <summary> Percentage of time an object has been in a down state. </summary> </member> <member name="F:PrtgAPI.Property.TotalDowntime"> <summary> Total amount of time an object has been in a down state. </summary> </member> <member name="F:PrtgAPI.Property.DownDuration"> <summary> Total amount of time an object has been down since it was last up. </summary> </member> <member name="F:PrtgAPI.Property.Uptime"> <summary> Percentage of time an object has been in an up state. </summary> </member> <member name="F:PrtgAPI.Property.TotalUptime"> <summary> Total amount of time an object has been in an up state. </summary> </member> <member name="F:PrtgAPI.Property.UpDuration"> <summary> Total amount of time an object has been up since it was last down. </summary> </member> <member name="F:PrtgAPI.Property.TotalMonitorTime"> <summary> Total amount of time an object has been monitored. </summary> </member> <member name="F:PrtgAPI.Property.DataCollectedSince"> <summary> Datetime when object first received data. </summary> </member> <member name="F:PrtgAPI.Property.Sensor"> <summary> Name of the sensor. </summary> </member> <member name="F:PrtgAPI.Property.Interval"> <summary> Monitoring interval of an object. </summary> </member> <member name="F:PrtgAPI.Property.LastCheck"> <summary> Date/time object last refreshed results. </summary> </member> <member name="F:PrtgAPI.Property.LastUp"> <summary> Date/time object was last in an up status. </summary> </member> <member name="F:PrtgAPI.Property.LastDown"> <summary> Date/time object was last in a down status. </summary> </member> <member name="F:PrtgAPI.Property.Device"> <summary> Name of the parent device. </summary> </member> <member name="F:PrtgAPI.Property.Group"> <summary> Name of the parent group. </summary> </member> <member name="F:PrtgAPI.Property.Probe"> <summary> Name of the parent probe. </summary> </member> <member name="F:PrtgAPI.Property.GrpDev"> <summary> Name of parent device and group seperated by slash. </summary> </member> <member name="F:PrtgAPI.Property.NotificationTypes"> <summary> Number of each trigger type defined for an object. </summary> </member> <member name="F:PrtgAPI.Property.Access"> <summary> Access rights for the current user on an object. </summary> </member> <member name="F:PrtgAPI.Property.Dependency"> <summary> Displays the name the object this object is dependent on. </summary> </member> <member name="F:PrtgAPI.Property.Status"> <summary> <see cref="T:PrtgAPI.Status"/> or <see cref="T:PrtgAPI.LogStatus"/> of the object. </summary> </member> <member name="F:PrtgAPI.Property.Message"> <summary> Message (such as "OK") displayed on an object. </summary> </member> <member name="F:PrtgAPI.Property.Priority"> <summary> Priority of the object. </summary> </member> <member name="F:PrtgAPI.Property.LastValue"> <summary> Last value of a sensor's primary channel. </summary> </member> <member name="F:PrtgAPI.Property.UpSensors"> <summary> Number of sensors currently in an <see cref="F:PrtgAPI.Status.Up"/> state. </summary> </member> <member name="F:PrtgAPI.Property.DownSensors"> <summary> Number of sensors currently in a <see cref="F:PrtgAPI.Status.Down"/> state. </summary> </member> <member name="F:PrtgAPI.Property.DownAcknowledgedSensors"> <summary> Number of sensors currently in a <see cref="F:PrtgAPI.Status.DownAcknowledged"/> state. </summary> </member> <member name="F:PrtgAPI.Property.PartialDownSensors"> <summary> Number of sensors currently in a <see cref="F:PrtgAPI.Status.DownPartial"/> state. </summary> </member> <member name="F:PrtgAPI.Property.WarningSensors"> <summary> Number of sensors currently in a <see cref="F:PrtgAPI.Status.Warning"/> state. </summary> </member> <member name="F:PrtgAPI.Property.PausedSensors"> <summary> Number of sensors currently in any <see cref="F:PrtgAPI.Status.Paused"/> state. </summary> </member> <member name="F:PrtgAPI.Property.UnusualSensors"> <summary> Number of sensors currently in a <see cref="F:PrtgAPI.Status.Unusual"/> state. </summary> </member> <member name="F:PrtgAPI.Property.UnknownSensors"> <summary> Number of sensors currently in a <see cref="F:PrtgAPI.Status.Unknown"/> state. </summary> </member> <member name="F:PrtgAPI.Property.TotalSensors"> <summary> Number of sensors present under an object (including all child objects). </summary> </member> <member name="F:PrtgAPI.Property.Value"> <summary> Value of an object. Used in: Values, TopData </summary> </member> <member name="F:PrtgAPI.Property.Coverage"> <summary> Displays the sensor coverage of a time span in a value table. Used in: Values </summary> </member> <member name="F:PrtgAPI.Property.Favorite"> <summary> Displays an exclamation mark when the sensor tree object is marked as favorite.<para/> Note: when filtering by this property, objects will not have a Favorite of False unless they were previously set to True. </summary> </member> <member name="F:PrtgAPI.Property.UserName"> <summary> Displays the user responsible for a history entry or the user (or user group) a ticket is assigned to. Used in: History, Tickets, TicketData </summary> </member> <member name="F:PrtgAPI.Property.Parent"> <summary> Name of the parent object of the associated object of a log message. Used in: Messages </summary> </member> <member name="F:PrtgAPI.Property.DateTime"> <summary> Timestamp or timespan of an object (for tickets: last modification). Used in: Messages, Tickets, TicketData, Values, History, StoredReports, TopIDX </summary> </member> <member name="F:PrtgAPI.Property.DateOnly"> <summary> Like 'datetime' but only the date part. Used in: Messages, Tickets, History, Values </summary> </member> <member name="F:PrtgAPI.Property.TimeOnly"> <summary> Like 'datetime' but only the date part. Used in: Messages, Tickets, History, Values </summary> </member> <member name="F:PrtgAPI.Property.Schedule"> <summary> For sensor tree objects this displays the name of an associated schedule, for reports this displays the report generation schedule. Used in: Sensors, Devices, Groups, Probes, Reports </summary> </member> <member name="F:PrtgAPI.Property.Period"> <summary> Displays the period of a report (day, week etc.). Used in: Reports </summary> </member> <member name="F:PrtgAPI.Property.Email"> <summary> Displays the email address of a report. Used in: Reports </summary> </member> <member name="F:PrtgAPI.Property.Template"> <summary> Displays the template used by a report. Used in: Reports </summary> </member> <member name="F:PrtgAPI.Property.LastRun"> <summary> Timestamp of the last generation of a report. Used in: Reports </summary> </member> <member name="F:PrtgAPI.Property.NextRun"> <summary> Timestamp of the next generation of a report. Used in: Reports </summary> </member> <member name="F:PrtgAPI.Property.Size"> <summary> Size of a stored report. Used in: StoredReports </summary> </member> <member name="F:PrtgAPI.Property.MiniGraph"> <summary> Numerical data for minigraphs. Numbers are 5 minute averages for the last 24 hours (must be scaled to the maximum of the series). There are two datasets: "|" separates measured value series and error series. Used in: Sensors </summary> </member> <member name="F:PrtgAPI.Property.DeviceIcon"> <summary> Device Icon. Used in: Devices </summary> </member> <member name="F:PrtgAPI.Property.Comments"> <summary> Object comments (for tickets: related object). Used in: All Objects </summary> </member> <member name="F:PrtgAPI.Property.Host"> <summary> Hostname or IP address. Used in: Devices </summary> </member> <member name="F:PrtgAPI.Property.Condition"> <summary> Probe status for probes, auto discovery status for groups. Used in: Groups, Probes </summary> </member> <member name="F:PrtgAPI.Property.ProbeStatus"> <summary> Probe connection status. Equivalent to <see cref="F:PrtgAPI.Property.Condition"/>. </summary> </member> <member name="F:PrtgAPI.Property.BaseType"> <summary> Object type (string). Used in: All Tree Objects </summary> </member> <member name="F:PrtgAPI.Property.Url"> <summary> URL of the object. Used in: All Tree Objects </summary> </member> <member name="F:PrtgAPI.Property.Icon"> <summary> URL of the device icon. Used in: Devices </summary> </member> <member name="F:PrtgAPI.Property.ParentId"> <summary> ID of the parent object or ID of a ticket (e.g. the device of sensor, the probe of a group, etc). Used in: All Tree Objects, Tickets </summary> </member> <member name="F:PrtgAPI.Property.Location"> <summary> Location property (used in Geo Maps). Used in: Groups, Devices </summary> </member> <member name="F:PrtgAPI.Property.Collapsed"> <summary> Subobjects are folded up (true) or down (false); tickets: user (or user group) to which ticket is assinged read it since last change. Used in: Groups, Probes, Tickets </summary> </member> <member name="F:PrtgAPI.Property.TotalGroups"> <summary> Number of groups in a probe/group node. Used in: Groups, Probes </summary> </member> <member name="F:PrtgAPI.Property.TotalDevices"> <summary> Number of devices in a probe/group node. Used in: Groups, Probes </summary> </member> <member name="F:PrtgAPI.Property.TicketType"> <summary> Type of the ticket: user, notification, todo. Used in: Tickets </summary> </member> <member name="F:PrtgAPI.Property.ModifiedBy"> <summary> User who edited the ticket most recently. Used in: Tickets, TicketData </summary> </member> <member name="F:PrtgAPI.Property.Actions"> <summary> Types of all ticket edits. Used in: TicketData </summary> </member> <member name="F:PrtgAPI.Property.Content"> <summary> The text of the ticket that was added with the last edit, or the properties of a notification trigger. Used in: TicketData, Triggers </summary> </member> <member name="F:PrtgAPI.Property.Position"> <summary> Position of the object in PRTG Tables. Internally, this value is represented as position = pos * 10 </summary> </member> <member name="F:PrtgAPI.Property.StartDate"> <summary> Start date to retrieve records from. This is the point in time furthest away from now. Used in: Messages (Logs) </summary> </member> <member name="F:PrtgAPI.Property.EndDate"> <summary> End date to retrieve records to. This is the point in time closest to now. Used in: Messages (Logs) </summary> </member> <member name="F:PrtgAPI.Property.RecordAge"> <summary> Age of records to retrieve. Used in: Messages (Logs) </summary> </member> <member name="F:PrtgAPI.CommandFunction.Rename"> <summary> Renames an object. </summary> </member> <member name="F:PrtgAPI.CommandFunction.Pause"> <summary> Pauses an object indefinitely or resumes an object from a paused or simulated error state. </summary> </member> <member name="F:PrtgAPI.CommandFunction.PauseObjectFor"> <summary> Pauses an object for a specified duration (in minutes). </summary> </member> <member name="F:PrtgAPI.CommandFunction.Simulate"> <summary> Simulates an error on a sensor. </summary> </member> <member name="F:PrtgAPI.CommandFunction.AcknowledgeAlarm"> <summary> Acknowledges a sensor in a <see cref="F:PrtgAPI.Status.Down"/> state. </summary> </member> <member name="F:PrtgAPI.CommandFunction.ScanNow"> <summary> Refreshes an object (as well as any child objects). </summary> </member> <member name="F:PrtgAPI.CommandFunction.DiscoverNow"> <summary> Starts an auto-discovery operation. </summary> </member> <member name="F:PrtgAPI.CommandFunction.SetPosition"> <summary> Repositions an object under its parent object. </summary> </member> <member name="F:PrtgAPI.CommandFunction.DeleteObject"> <summary> Permanently removes an object from PRTG. </summary> </member> <member name="F:PrtgAPI.CommandFunction.DuplicateObject"> <summary> Clones an object and all children to under another object. </summary> </member> <member name="F:PrtgAPI.CommandFunction.MoveObjectNow"> <summary> Moves an object to under a new parent object. </summary> </member> <member name="F:PrtgAPI.CommandFunction.SortSubObjects"> <summary> Sorts the children of an object in alphabetical order. </summary> </member> <member name="F:PrtgAPI.CommandFunction.AddSensor2"> <summary> Initiates a query for device specific information required to create a sensor. </summary> </member> <member name="F:PrtgAPI.CommandFunction.AddSensor5"> <summary> Creates a new sensor. </summary> </member> <member name="F:PrtgAPI.CommandFunction.AddDevice2"> <summary> Creates a new device. </summary> </member> <member name="F:PrtgAPI.CommandFunction.AddGroup2"> <summary> Creates a new group. </summary> </member> <member name="F:PrtgAPI.CommandFunction.ProbeState"> <summary> Approve/Deny new probes </summary> </member> <member name="T:PrtgAPI.Content"> <summary> Specifies the type of content to retrieve from a PRTG API Request. </summary> </member> <member name="F:PrtgAPI.Content.System"> <summary> System objects internally used by PRTG. </summary> </member> <member name="F:PrtgAPI.Content.Probes"> <summary> Site containing PRTG Network Monitor software used to monitor a network. </summary> </member> <member name="F:PrtgAPI.Content.Groups"> <summary> Groups used to organize devices. </summary> </member> <member name="F:PrtgAPI.Content.Devices"> <summary> Computers and pieces of equipment that contain sensors monitored by PRTG. </summary> </member> <member name="F:PrtgAPI.Content.Sensors"> <summary> Objects that monitor and collect data - the fundamental components of PRTG. </summary> </member> <member name="F:PrtgAPI.Content.Channels"> <summary> Values within sensors that hold the results of monitoring operations. </summary> </member> <member name="F:PrtgAPI.Content.Notifications"> <summary> Notification actions for use with notification triggers. </summary> </member> <member name="F:PrtgAPI.Content.Schedules"> <summary> Schedules that indicate when monitoring should be active. </summary> </member> <member name="F:PrtgAPI.Content.Triggers"> <summary> All notification triggers defined on an object, including inherited triggers. </summary> </member> <member name="F:PrtgAPI.Content.Values"> <summary> Historical data of a PRTG Sensor. </summary> </member> <member name="F:PrtgAPI.Content.History"> <summary> Object modification history. </summary> </member> <member name="F:PrtgAPI.Content.Logs"> <summary> Event logs specific to an object and its children. </summary> </member> <member name="F:PrtgAPI.Content.Report"> <summary> A report used to report on the values of sensors. </summary> </member> <member name="F:PrtgAPI.Content.Library"> <summary> A library used to organized objects. </summary> </member> <member name="F:PrtgAPI.Content.UnifiedOptions"> <summary> Web Server settings. </summary> </member> <member name="F:PrtgAPI.Content.Map"> <summary> A dashboard. </summary> </member> <member name="F:PrtgAPI.Content.Objects"> <summary> All content types, including those unsupported by PRTG. Note: PRTG does not recognize "objects" as a valid content type, and as such this property should be used with caution. </summary> </member> <member name="F:PrtgAPI.Content.User"> <summary> A user account capable of logging into PRTG. </summary> </member> <member name="F:PrtgAPI.Content.UserGroup"> <summary> A group used for organizing user accounts. </summary> </member> <member name="F:PrtgAPI.Content.SysInfo"> <summary> Device system information. </summary> </member> <member name="T:PrtgAPI.FilterOperator"> <summary> <para type="description">Specifies operators that can be used for filtering results in a PRTG Request.</para> </summary> </member> <member name="F:PrtgAPI.FilterOperator.Equals"> <summary> Return results equal to a specified value. </summary> </member> <member name="F:PrtgAPI.FilterOperator.NotEquals"> <summary> Return results not equal to a specified value. </summary> </member> <member name="F:PrtgAPI.FilterOperator.GreaterThan"> <summary> Return results greater than a specified value. </summary> </member> <member name="F:PrtgAPI.FilterOperator.LessThan"> <summary> Return results less than a specified value. </summary> </member> <member name="F:PrtgAPI.FilterOperator.Contains"> <summary> Return results that contain a specified substring. Additional substrings can be specified (separated by a comma) to further refine results. </summary> </member> <member name="T:PrtgAPI.Output"> <summary> Specifies how a PRTG Response should be formatted. </summary> </member> <member name="F:PrtgAPI.Output.Xml"> <summary> XML file. </summary> </member> <member name="F:PrtgAPI.Output.XmlTable"> <summary> Table in XML format. </summary> </member> <member name="F:PrtgAPI.Output.CsvTable"> <summary> CSV table. </summary> </member> <member name="F:PrtgAPI.Output.Html"> <summary> HTML table. </summary> </member> <member name="T:PrtgAPI.Parameter"> <summary> Specifies fields to be included in a PRTG API Request. </summary> </member> <member name="F:PrtgAPI.Parameter.UserName"> <summary> Username to authenticate against PRTG. If PRTG has been configured to use Active Directory, this can be the username of a Domain User. </summary> </member> <member name="F:PrtgAPI.Parameter.Password"> <summary> Password to authenticate against PRTG. </summary> </member> <member name="F:PrtgAPI.Parameter.PassHash"> <summary> PassHash to authenticate against PRTG. Alternative to using <see cref="F:PrtgAPI.Parameter.Password"/> </summary> </member> <member name="F:PrtgAPI.Parameter.Content"> <summary> A <see cref="T:PrtgAPI.Content"/> value representing a PRTG object type. </summary> </member> <member name="F:PrtgAPI.Parameter.Columns"> <summary> One or more <see cref="T:PrtgAPI.Property"/> values specifying properties that will be retrieved for a PRTG Object. </summary> </member> <member name="F:PrtgAPI.Parameter.Output"> <summary> A <see cref="F:PrtgAPI.Parameter.Output"/> value specifying the format the PRTG Response will be stored in. </summary> </member> <member name="F:PrtgAPI.Parameter.Count"> <summary> Maximum number of records returned from a PRTG Request. </summary> </member> <member name="F:PrtgAPI.Parameter.Start"> <summary> Record number to start with. Used in conjunction with <see cref="F:PrtgAPI.Parameter.Count"/> to request data page by page. </summary> </member> <member name="F:PrtgAPI.Parameter.FilterXyz"> <summary> Used to filter objects returned based on the value of a specified <see cref="T:PrtgAPI.Property"/>. When submitting a PRTG Request, the name of the Property being filtered on should be added to the value of this parameter (e.g. filter_name). </summary> </member> <member name="F:PrtgAPI.Parameter.SortBy"> <summary> A <see cref="T:PrtgAPI.Property"/> used to specify which property to sort PRTG Response by. </summary> </member> <member name="F:PrtgAPI.Parameter.Show"> <summary> A <see cref="T:PrtgAPI.CustomValueFormat"/> specifying how values should be displayed. </summary> </member> <member name="F:PrtgAPI.Parameter.Id"> <summary> ID of the object to operate upon. </summary> </member> <member name="F:PrtgAPI.Parameter.Name"> <summary> The <see cref="F:PrtgAPI.Property.Name"/> to use for <see cref="F:PrtgAPI.Parameter.Id"/> or to operate upon. </summary> </member> <member name="F:PrtgAPI.Parameter.Value"> <summary> The value to store in the property referenced by <see cref="F:PrtgAPI.Parameter.Name"/>. </summary> </member> <member name="F:PrtgAPI.Parameter.PauseMessage"> <summary> Message to display on a paused object. </summary> </member> <member name="F:PrtgAPI.Parameter.Action"> <summary> Action to perform for a PRTG Function. Meaning of value is dependent on function being excuted. Simulate an error: 1 (on simulate.htm). Pause indefinitely: 0 (on pause.htm). Resume monitoring of an object: 1 (on pause.htm) </summary> </member> <member name="F:PrtgAPI.Parameter.Duration"> <summary> Duration to pause or acknowledge an object for, in minutes. </summary> </member> <member name="F:PrtgAPI.Parameter.AcknowledgeMessage"> <summary> Message to display on an acknowledged sensor. </summary> </member> <member name="F:PrtgAPI.Parameter.NewPos"> <summary> The new position of the object. </summary> </member> <member name="F:PrtgAPI.Parameter.Host"> <summary> The hostname of the new object. </summary> </member> <member name="F:PrtgAPI.Parameter.TargetId"> <summary> The object targeted by the API call. </summary> </member> <member name="F:PrtgAPI.Parameter.SubId"> <summary> The ID of the object. </summary> </member> <member name="F:PrtgAPI.Parameter.SubType"> <summary> The type of object to change properties for. </summary> </member> <member name="F:PrtgAPI.Parameter.Approve"> <summary> Whether or not approval is granted to perform an action. </summary> </member> <member name="F:PrtgAPI.Parameter.StartDate"> <summary> The start date to retrieve data for. </summary> </member> <member name="F:PrtgAPI.Parameter.EndDate"> <summary> The end date to retrieve data for. </summary> </member> <member name="F:PrtgAPI.Parameter.Average"> <summary> The value to average with. </summary> </member> <member name="F:PrtgAPI.Parameter.Custom"> <summary> Allows using custom parameters not known to PrtgAPI, including parameters whose names are dynamically generated. For use with <see cref="T:PrtgAPI.Parameters.CustomParameter"/> </summary> </member> <member name="F:PrtgAPI.Parameter.Channel"> <summary> ID of the channel to retrieve properties for. </summary> </member> <member name="F:PrtgAPI.Parameter.ObjectType"> <summary> The type of object to retrieve details for. </summary> </member> <member name="F:PrtgAPI.Parameter.SensorType"> <summary> The type of sensor to create. </summary> </member> <member name="F:PrtgAPI.Parameter.Template"> <summary> The templates to use for performing an operation. </summary> </member> <member name="F:PrtgAPI.Parameter.Fold"> <summary> Whether to collapse or show an item. </summary> </member> <member name="F:PrtgAPI.Parameter.Category"> <summary> Object category request should apply to. </summary> </member> <member name="F:PrtgAPI.Parameter.Kind"> <summary> Object kind request should apply to. </summary> </member> <member name="F:PrtgAPI.Parameter.Service"> <summary> The details of a WMI Service to create. </summary> </member> <member name="F:PrtgAPI.Parameter.DeviceTemplate"> <summary> The templates to use for performing an auto-discovery on a device. </summary> </member> <member name="F:PrtgAPI.Parameter.TmpId"> <summary> Temp ID that identifies the session being used to create a new sensor. </summary> </member> <member name="T:PrtgAPI.ParameterType"> <summary> Specifies how <see cref="T:PrtgAPI.Parameter"/> values can be formatted when inserted in a <see cref="T:PrtgAPI.Request.PrtgRequestMessage"/>. </summary> </member> <member name="F:PrtgAPI.ParameterType.SingleValue"> <summary> <see cref="T:PrtgAPI.Parameter"/> is used with a single value under a single parameter instance, i.e. param=value. </summary> </member> <member name="F:PrtgAPI.ParameterType.MultiValue"> <summary> <see cref="T:PrtgAPI.Parameter"/> is used with multiple values under a single parameter instance, i.e. param=value1,value2. </summary> </member> <member name="F:PrtgAPI.ParameterType.MultiParameter"> <summary> <see cref="T:PrtgAPI.Parameter"/> is used with multiple values under multiple instances of a parameter (one value per instance), i.e. param=value1&param=value2. </summary> </member> <member name="T:PrtgAPI.PauseAction"> <summary> Specifies states that allow an object to be paused or resumed. </summary> </member> <member name="F:PrtgAPI.PauseAction.Pause"> <summary> Pause the object. </summary> </member> <member name="F:PrtgAPI.PauseAction.Resume"> <summary> Resume (unpause) an object. </summary> </member> <member name="T:PrtgAPI.Priority"> <summary> Specifies the order in which objects are displayed in PRTG table lists, with objects with higher priorities displayed first. </summary> </member> <member name="F:PrtgAPI.Priority.None"> <summary> This object does not have a priority specified. </summary> </member> <member name="F:PrtgAPI.Priority.One"> <summary> Priority 1 (lowest priority). </summary> </member> <member name="F:PrtgAPI.Priority.Two"> <summary> Priority 2. </summary> </member> <member name="F:PrtgAPI.Priority.Three"> <summary> Priority 3 (default). </summary> </member> <member name="F:PrtgAPI.Priority.Four"> <summary> Priority 4. </summary> </member> <member name="F:PrtgAPI.Priority.Five"> <summary> Priority 5 (highest priority). </summary> </member> <member name="T:PrtgAPI.RecordAge"> <summary> <para type="description">Specifies time spans for filtering records by.</para> </summary> </member> <member name="F:PrtgAPI.RecordAge.Today"> <summary> Records that were created today. </summary> </member> <member name="F:PrtgAPI.RecordAge.Yesterday"> <summary> Records that were created yesterday. </summary> </member> <member name="F:PrtgAPI.RecordAge.LastWeek"> <summary> Records that were created within the last 7 days. </summary> </member> <member name="F:PrtgAPI.RecordAge.LastMonth"> <summary> Records that were created within the last 30 days. </summary> </member> <member name="F:PrtgAPI.RecordAge.LastSixMonths"> <summary> Records that were created within the last 6 months. </summary> </member> <member name="F:PrtgAPI.RecordAge.LastYear"> <summary> Records that were created within the last 12 months. </summary> </member> <member name="F:PrtgAPI.RecordAge.All"> <summary> All records present in the PRTG Server. By default, PRTG only stores 30 days. </summary> </member> <member name="T:PrtgAPI.Status"> <summary> <para type="description">Specifies states capable of being held by sensors, devices, groups and probes. Not all states may apply to all object types.</para> </summary> </member> <member name="F:PrtgAPI.Status.None"> <summary> Sensor is transitioning between states or is <see cref="F:PrtgAPI.Status.Unknown"/> but is malfunctioning. </summary> </member> <member name="F:PrtgAPI.Status.Unknown"> <summary> Sensor is unable to collect data. </summary> </member> <member name="F:PrtgAPI.Status.Collecting"> <summary> Sensor is waiting for more monitoring data before deciding on the final sensor state. Used by Business Process Sensors. </summary> </member> <member name="F:PrtgAPI.Status.Up"> <summary> Object is in an up and working state. </summary> </member> <member name="F:PrtgAPI.Status.Warning"> <summary> Sensor is behaving abnormally, but has not yet failed. </summary> </member> <member name="F:PrtgAPI.Status.Down"> <summary> Object is down and has failed. </summary> </member> <member name="F:PrtgAPI.Status.NoProbe"> <summary> This value is no longer used by PRTG, however is considered analogous to <see cref="F:PrtgAPI.Status.Unknown"/>. </summary> </member> <member name="F:PrtgAPI.Status.PausedByUser"> <summary> Object has been paused indefinitely by a user. </summary> </member> <member name="F:PrtgAPI.Status.PausedByDependency"> <summary> Object has been paused due to a dependency on another sensor (e.g. the device is not pingable) </summary> </member> <member name="F:PrtgAPI.Status.PausedBySchedule"> <summary> Object has been paused automatically by a schedule used to control monitoring windows. </summary> </member> <member name="F:PrtgAPI.Status.Unusual"> <summary> Sensor data is outside of normal ranges, potentially indicating an issue. </summary> </member> <member name="F:PrtgAPI.Status.PausedByLicense"> <summary> Sensor has been paused due to sensor limits imposed by the PRTG license. </summary> </member> <member name="F:PrtgAPI.Status.PausedUntil"> <summary> Object has been paused temporarily by a user until a specified time period. </summary> </member> <member name="F:PrtgAPI.Status.DownAcknowledged"> <summary> Sensor is down but has been acknowledged by a user. </summary> </member> <member name="F:PrtgAPI.Status.DownPartial"> <summary> Sensor is down for at least one node in a PRTG Cluster. </summary> </member> <member name="F:PrtgAPI.Status.Paused"> <summary> Object is in any paused state. </summary> </member> <member name="T:PrtgAPI.XmlFunction"> <summary> Specifies API Request Pages that return XML. </summary> </member> <member name="F:PrtgAPI.XmlFunction.TableData"> <summary> Retrieve data stored by PRTG in tables (Sensors, Devices, Probes, etc). </summary> </member> <member name="F:PrtgAPI.XmlFunction.GetObjectProperty"> <summary> Retrieve the value of a <see cref="T:PrtgAPI.Property"/> for a specified PRTG Object. </summary> </member> <member name="F:PrtgAPI.XmlFunction.GetObjectStatus"> <summary> Alternate method of retrieving the value of a <see cref="T:PrtgAPI.Property"/> for a specified PRTG Object. Does not support all <see cref="T:PrtgAPI.Property"/> values. </summary> </member> <member name="F:PrtgAPI.XmlFunction.GetTreeNodeStats"> <summary> Retrieve the total number sensors in each sensor status (up, down, paused, etc) on a PRTG Server. </summary> </member> <member name="F:PrtgAPI.XmlFunction.HistoricData"> <summary> Retrieve historic channel data over a custom timeframe for a PRTG Sensor. </summary> </member> <member name="T:PrtgAPI.CustomValueFormat"> <summary> Specifies alternate methods of formatting values returned from PRTG Requests. </summary> </member> <member name="F:PrtgAPI.CustomValueFormat.Text"> <summary> Display as text, using symbols instead of numbers and escaping invalid characters, e.g. five stars (*****) for <see cref="F:PrtgAPI.Priority.Five"/> and &amp; instead of &. </summary> </member> <member name="F:PrtgAPI.CustomValueFormat.NoHtmlEncode"> <summary> Display as a raw value without HTML encoding, using numbers instead of symbols and not escaping invalid characters (such as using & instead of &amp;) </summary> </member> <member name="T:PrtgAPI.PrtgRequestException"> <summary> The exception that is thrown when a PRTG Request returns an error. </summary> </member> <member name="M:PrtgAPI.PrtgRequestException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgRequestException"/> class. </summary> </member> <member name="M:PrtgAPI.PrtgRequestException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgRequestException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.PrtgRequestException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgRequestException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.PrtgRequestException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgRequestException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.XmlDeserializationException"> <summary> The exception that is thrown when an XML document cannot be deserialized. </summary> </member> <member name="M:PrtgAPI.XmlDeserializationException.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.XmlDeserializationException"/> class. </summary> </member> <member name="M:PrtgAPI.XmlDeserializationException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.XmlDeserializationException"/> class with a specified error message. </summary> <param name="message">The error message that explains the reason for the exception.</param> </member> <member name="M:PrtgAPI.XmlDeserializationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.XmlDeserializationException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.XmlDeserializationException.#ctor(System.Type,System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.XmlDeserializationException"/> class with the outer type that was being deserialized and the XML that is believed to have caused the exception. </summary> <param name="type">The outer type that was being deserialized.</param> <param name="xml">The XML believed to have caused the exception.</param> </member> <member name="M:PrtgAPI.XmlDeserializationException.#ctor(System.Type,System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.XmlDeserializationException"/> class with the outer type that was being deserialized, the XML that is believed to have caused the exception and a reference to the inner exception that is the cause of this exception. </summary> <param name="type">The outer type that was being deserialized.</param> <param name="xml">The XML believed to have caused the exception.</param> <param name="inner">The exception that is the cause of the current exception. If the <paramref name="inner"/> parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:PrtgAPI.XmlDeserializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.XmlDeserializationException"/> class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> </member> <member name="T:PrtgAPI.NotificationTypes"> <summary> Specifies the number of notification triggers on a PRTG Object, as well as whether any triggers are inherited from parent objects </summary> </member> <member name="P:PrtgAPI.NotificationTypes.StateTriggers"> <summary> Number of State Triggers defined on a PRTG Object. </summary> </member> <member name="P:PrtgAPI.NotificationTypes.ThresholdTriggers"> <summary> Number of Threshold Triggers defined on a PRTG Object. </summary> </member> <member name="P:PrtgAPI.NotificationTypes.ChangeTriggers"> <summary> Number of Change Triggers defined on a PRTG Object. </summary> </member> <member name="P:PrtgAPI.NotificationTypes.SpeedTriggers"> <summary> Number of Speed Triggers defined on a PRTG Object. </summary> </member> <member name="P:PrtgAPI.NotificationTypes.VolumeTriggers"> <summary> Number of Volume Triggers defined on a PRTG Object. </summary> </member> <member name="P:PrtgAPI.NotificationTypes.TotalTriggers"> <summary> Total number of triggers. This property is language indendent, and as such may not reflect the sum of all State/Threshold/Speed/Volume/Change Triggers </summary> </member> <member name="P:PrtgAPI.NotificationTypes.InheritTriggers"> <summary> Whether notification triggers are inherited from a PRTG Object's parent object. </summary> </member> <member name="M:PrtgAPI.NotificationTypes.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.NotificationTypes"/> class. </summary> <param name="rawNotificationTypes">Raw <see cref="F:PrtgAPI.Property.NotificationTypes"/> value returned from a PRTG Request.</param> </member> <member name="M:PrtgAPI.NotificationTypes.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.NotificationTypes.Equals(System.Object)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.NotificationTypes.Equals(PrtgAPI.NotificationTypes)"> <summary> Returns a boolean indicating if the passed in object obj is Equal to this. </summary> <param name="other">The object to compare with the current object.</param> <returns>True if the specified object is equal to the current object; otherwise, false.</returns> </member> <member name="M:PrtgAPI.NotificationTypes.GetHashCode"> <summary> Returns a hash code for this object. </summary> <returns>A hash code for the current object.</returns> </member> <member name="T:PrtgAPI.Probe"> <summary> <para type="description">A device used to perform monitoring against a site or set of systems.</para> </summary> </member> <member name="P:PrtgAPI.Probe.ProbeStatus"> <summary> Connected status of the probe. </summary> </member> <member name="T:PrtgAPI.DeviceOrGroupOrProbe"> <summary> <para type="description">Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</para> </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.UpSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Up"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.DownSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Down"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.DownAcknowledgedSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.DownAcknowledged"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.PartialDownSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.DownPartial"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.WarningSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Warning"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.PausedSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.PausedByUser"/>, <see cref="F:PrtgAPI.Status.PausedByDependency"/>, <see cref="F:PrtgAPI.Status.PausedBySchedule"/> or <see cref="F:PrtgAPI.Status.PausedByLicense"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.UnusualSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Unusual"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.UnknownSensors"> <summary> Number of sensors in <see cref="F:PrtgAPI.Status.Unknown"/> state. </summary> </member> <member name="P:PrtgAPI.DeviceOrGroupOrProbe.TotalSensors"> <summary> Total number of sensors contained under this object in any <see cref="T:PrtgAPI.Status"/> state. </summary> </member> <member name="T:PrtgAPI.Device"> <summary> <para type="description">A computer or piece of equipment containing one or more sensors monitored by PRTG.</para> </summary> </member> <member name="P:PrtgAPI.Device.Location"> <summary> Location of this object. </summary> </member> <member name="P:PrtgAPI.Device.Host"> <summary> The Hostname or IP Address of this device. </summary> </member> <member name="P:PrtgAPI.Device.Group"> <summary> Group this device is contained in. </summary> </member> <member name="P:PrtgAPI.Device.Probe"> <summary> Probe that monitors this device's sensors. </summary> </member> <member name="P:PrtgAPI.Device.Favorite"> <summary> Whether this object has been marked as a favorite. </summary> </member> <member name="P:PrtgAPI.Device.Condition"> <summary> Auto-discovery progress (if one is in progress). Otherwise, null. </summary> </member> <member name="T:PrtgAPI.Group"> <summary> <para type="description">A group used to organize one or more groups or devices.</para> </summary> </member> <member name="P:PrtgAPI.Group.Probe"> <summary> Probe that manages the execution of the sensors contained within this group's devices. </summary> </member> <member name="P:PrtgAPI.Group.Condition"> <summary> Auto-discovery progress (if one is in progress). Otherwise, null. </summary> </member> <member name="T:PrtgAPI.Sensor"> <summary> <para type="description">An object that monitors and collects information according to a defined scanning interval.</para> </summary> </member> <member name="P:PrtgAPI.Sensor.Probe"> <summary> Probe that manages the execution of this sensor. </summary> </member> <member name="P:PrtgAPI.Sensor.Group"> <summary> Group this sensor's <see cref="P:PrtgAPI.Sensor.Device"/> is contained in. </summary> </member> <member name="P:PrtgAPI.Sensor.Favorite"> <summary> Whether this object has been marked as a favorite. </summary> </member> <member name="P:PrtgAPI.Sensor.DisplayLastValue"> <summary> Last value of this sensor's primary channel with value unit. If this sensor's primary channel has been recently changed, the sensor may need to be paused and unpaused (otherwise it may just display "No data"). </summary> </member> <member name="P:PrtgAPI.Sensor.LastValue"> <summary> The raw last value of this sensor's primary channel. </summary> </member> <member name="P:PrtgAPI.Sensor.Device"> <summary> Device this sensor monitors. </summary> </member> <member name="P:PrtgAPI.Sensor.Downtime"> <summary> Percentage indicating overall downtime of this object over its entire lifetime. See also: <see cref="P:PrtgAPI.Sensor.Uptime"/>. </summary> </member> <member name="P:PrtgAPI.Sensor.TotalDowntime"> <summary> Total amount of time sensor has ever been in a <see cref="F:PrtgAPI.Status.Down"/> or <see cref="F:PrtgAPI.Status.DownAcknowledged"/> state. </summary> </member> <member name="P:PrtgAPI.Sensor.DownDuration"> <summary> Amount of time passed since this object was last in an <see cref="F:PrtgAPI.Status.Up"/> state. If this object is currently <see cref="F:PrtgAPI.Status.Up"/>, this value is null. </summary> </member> <member name="P:PrtgAPI.Sensor.Uptime"> <summary> Percentage indicating overall uptime of this object over its entire lifetime. See also: <see cref="P:PrtgAPI.Sensor.Downtime"/>. </summary> </member> <member name="P:PrtgAPI.Sensor.TotalUptime"> <summary> Total amount of time sensor has ever been in a <see cref="F:PrtgAPI.Status.Up"/> state. </summary> </member> <member name="P:PrtgAPI.Sensor.UpDuration"> <summary> Amount of time passed since sensor was last in a <see cref="F:PrtgAPI.Status.Down"/> state. If sensor is currently <see cref="F:PrtgAPI.Status.Down"/>, this value is null. </summary> </member> <member name="P:PrtgAPI.Sensor.TotalMonitorTime"> <summary> Total amount of time this sensor has been in an up or down state. </summary> </member> <member name="P:PrtgAPI.Sensor.DataCollectedSince"> <summary> When data collection on this sensor began. </summary> </member> <member name="P:PrtgAPI.Sensor.LastCheck"> <summary> When this sensor last checked for a value. </summary> </member> <member name="P:PrtgAPI.Sensor.LastUp"> <summary> When this object was last in an <see cref="F:PrtgAPI.Status.Up"/> state. </summary> </member> <member name="P:PrtgAPI.Sensor.LastDown"> <summary> When this value was last in a down state. </summary> </member> <member name="P:PrtgAPI.Sensor.MiniGraph"> <summary> CSV of sensor values for the past 24 hours. Numbers are stored as 5 minute averages. Value contains two sets of CSVs: measured values and errors. Sets are separated by a pipe . If MiniGraphs are disabled, this value is null. </summary> </member> <member name="T:PrtgAPI.GroupOrProbe"> <summary> <para type="description">Base class for Groups and Probes, containing properties that apply to both object types.</para> </summary> </member> <member name="P:PrtgAPI.GroupOrProbe.Collapsed"> <summary> Whether the object is currently expanded or collapsed in the PRTG Interface. </summary> </member> <member name="P:PrtgAPI.GroupOrProbe.TotalGroups"> <summary> Number of groups contained under this object and all sub-objects. </summary> </member> <member name="P:PrtgAPI.GroupOrProbe.TotalDevices"> <summary> Number of devices contained under this object and all sub-objects. </summary> </member> <member name="T:PrtgAPI.PrtgObject"> <summary> <para type="description">Represents a uniquely identifiable object within PRTG.</para> </summary> </member> <member name="P:PrtgAPI.PrtgObject.Id"> <summary> Unique identifier of this object within PRTG. </summary> </member> <member name="P:PrtgAPI.PrtgObject.Name"> <summary> Name of this object. </summary> </member> <member name="P:PrtgAPI.PrtgObject.Tags"> <summary> Tags contained on this object. </summary> </member> <member name="P:PrtgAPI.PrtgObject.DisplayType"> <summary> The display type of this object. Certain objects may simply report their <see cref="T:PrtgAPI.BaseType"/>, while others may get more specific (e.g. a sensor of type "Ping"). </summary> </member> <member name="P:PrtgAPI.PrtgObject.Type"> <summary> The type of this object. </summary> </member> <member name="P:PrtgAPI.PrtgObject.Active"> <summary> Whether or not the object is currently active (in a monitoring state). If false, the object is paused. </summary> </member> <member name="M:PrtgAPI.PrtgObject.ToString"> <summary> Returns a string that represents the current object. </summary> <returns>A string that represents the current object.</returns> </member> <member name="M:PrtgAPI.PrtgObject.#ctor"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgObject"/> class. </summary> </member> <member name="M:PrtgAPI.PrtgObject.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:PrtgAPI.PrtgObject"/> class with the raw representation of an object. </summary> <param name="raw">The raw representation of the object, containing the object's ID and Name.</param> </member> <member name="T:PrtgAPI.SensorOrDeviceOrGroupOrProbe"> <summary> <para type="description">Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</para> </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Schedule"> <summary> Monitoring schedule of this object. If this object is a report, this property displays the report generation schedule. If this object does not have a schedule, this value is null. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.BaseType"> <summary> Base type of this object ("sensor", "device", etc) </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Url"> <summary> URL of this object. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.ParentId"> <summary> ID of this object's parent. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.NotificationTypes"> <summary> Number of each notification trigger type defined on this object, as well as whether this object inherits any triggers from its parent object.<para/> This property does not work in non-English version of PRTG. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Interval"> <summary> Scanning interval for this sensor or default scanning interval for sensors under this object. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.InheritInterval"> <summary> Whether this object's Interval is inherited from its parent object. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Access"> <summary> An <see cref="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Access"/> value specifying the access rights of the API Request User on the specified object. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Dependency"> <summary> Name of the object the monitoring of this object is dependent on. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Position"> <summary> Position of this object within its parent object. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Status"> <summary> <see cref="T:PrtgAPI.Status"/> indicating this object's monitoring state. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbe.Comments"> <summary> Comments present on this object. </summary> </member> <member name="T:PrtgAPI.SensorOrDeviceOrGroupOrProbeOrTicket"> <summary> Base class for Sensors, Devices, Groups, Probes, Logs and Tickets, containing properties that apply to all six object types. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbeOrTicket.Priority"> <summary> <see cref="P:PrtgAPI.SensorOrDeviceOrGroupOrProbeOrTicket.Priority"/> of this object. </summary> </member> <member name="T:PrtgAPI.SensorOrDeviceOrGroupOrProbeOrTicketOrTicketDataOrHistory"> <summary> Base class for Sensors, Devices, Groups, Probes, Logs, Tickets, TicketData and History, containing properties that apply to all eight object types. </summary> </member> <member name="P:PrtgAPI.SensorOrDeviceOrGroupOrProbeOrTicketOrTicketDataOrHistory.Message"> <summary> Message or subject displayed on an object. </summary> </member> </members> </doc> |