en-US/about_DRMMDevice.help.txt
|
TOPIC
about_DRMMDevice SHORT DESCRIPTION Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. LONG DESCRIPTION The DRMMDevice class models a device within the DRMM platform, providing properties that describe the device's attributes and state, as well as methods to retrieve related information such as alerts and to perform actions like opening the device portal. This class inherits from DRMMObject. ## PROPERTIES The DRMMDevice class exposes the following properties: Property Type Description -------------------------- ------------------------- ---------------------------------------- Id long The unique identifier of the device. Uid guid The unique identifier (UID) of the de... SiteId long The unique identifier of the site to ... SiteUid guid The unique identifier (UID) of the si... SiteName string The name of the site to which the dev... DeviceType DRMMDeviceType The type of the device. Hostname string The hostname of the device. IntIpAddress string The internal IP address of the device. OperatingSystem string The operating system running on the d... LastLoggedInUser string The user who last logged into the dev... Domain string The domain to which the device belongs. CagVersion string The version of the CAG agent installe... DisplayVersion string The display version of the device. ExtIpAddress string The external IP address of the device. Description string The device's description. A64Bit bool Indicates whether the device is runni... RebootRequired bool Indicates whether the device requires... Online bool Indicates whether the device is curre... Suspended bool Indicates whether the device is curre... Deleted bool Indicates whether the device has been... LastSeen Nullable[datetime] The last time the device was seen onl... LastReboot Nullable[datetime] The date and time when the device was... LastAuditDate Nullable[datetime] The date when the device was last aud... CreationDate Nullable[datetime] The date when the device was created ... Udfs DRMMDeviceUdfs User-defined fields associated with t... SnmpEnabled bool Indicates whether SNMP is enabled on ... DeviceClass string The class of the device, which may in... PortalUrl string The URL to access the device's portal... WarrantyDate string The date when the device's warranty e... Antivirus DRMMDeviceAntivirusInfo Information about the device's antivi... PatchManagement DRMMDevicePatchManagement Information about the device's patch ... SoftwareStatus string Information about the device's softwa... WebRemoteUrl string The URL for web remote access to the ... NetworkProbe bool Information about the device's networ... OnboardedViaNetworkMonitor bool Indicates whether the device was onbo... ## METHODS The DRMMDevice class provides the following methods: ### GetAlerts() Retrieves the alerts associated with the device, filtered by status. **Returns:** `DRMMAlert[]` - Represents an alert in the DRMM system, including its properties, context, source information, and response actions. ### GetAlerts([String]$Status) Retrieves the alerts associated with the device, filtered by a specified status. **Returns:** `DRMMAlert[]` - Represents an alert in the DRMM system, including its properties, context, source information, and response actions. **Parameters:** - `[String]$Status` - TODO: Describe this parameter ### OpenPortal() Opens the device's portal URL in the default web browser. **Returns:** `void` - Returns void ### OpenWebRemote() Opens the device's web remote URL in the default web browser. **Returns:** `void` - Returns void ### GetUdfAsJson([Int32]$UdfNumber) Retrieves the value of a specified User-Defined Field (UDF) as a JSON object. **Returns:** `object` - Returns object **Parameters:** - `[Int32]$UdfNumber` - TODO: Describe this parameter ### GetUdfAsCsv([Int32]$UdfNumber, [String[]]$Headers) Retrieves the value of a specified User-Defined Field (UDF) as a CSV object with custom headers. **Returns:** `pscustomobject` - Returns pscustomobject **Parameters:** - `[Int32]$UdfNumber` - TODO: Describe this parameter - `[String[]]$Headers` - TODO: Describe this parameter ### GetUdfAsCsv([Int32]$UdfNumber, [String]$Delimiter, [String[]]$Headers) Retrieves the value of a specified User-Defined Field (UDF) as a CSV object with a custom delimiter and headers. **Returns:** `pscustomobject` - Returns pscustomobject **Parameters:** - `[Int32]$UdfNumber` - TODO: Describe this parameter - `[String]$Delimiter` - TODO: Describe this parameter - `[String[]]$Headers` - TODO: Describe this parameter ### GetSummary() Generates a summary string for the device, including its hostname and device type. **Returns:** `string` - Returns string ### ResolveAllAlerts() Resolves all open alerts associated with the device. **Returns:** `void` - Returns void ### GetAudit() Gets the most recent audit information for this device. **Returns:** `DRMMDeviceAudit` - Represents a comprehensive audit of a device, including hardware, software, and network information. ### GetSoftware() Gets the software information for this device. **Returns:** `DRMMDeviceAuditSoftware[]` - Represents the software information of a device in a device audit, including its name and version. ### SetUdf([Hashtable]$UdfFields) Sets the value of one or more User-Defined Fields (UDFs) for the device. **Returns:** `DRMMDevice` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. **Parameters:** - `[Hashtable]$UdfFields` - TODO: Describe this parameter ### ClearUdf([Int32]$UdfNumber) Clears the value of a specified User-Defined Field (UDF) for the device. **Returns:** `DRMMDevice` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. **Parameters:** - `[Int32]$UdfNumber` - TODO: Describe this parameter ### ClearUdfs() Clears the values of all User-Defined Fields (UDFs) for the device. **Returns:** `DRMMDevice` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. ### SetWarranty([DateTime]$WarrantyDate) Sets the warranty date for the device. **Returns:** `DRMMDevice` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. **Parameters:** - `[DateTime]$WarrantyDate` - TODO: Describe this parameter ### RunQuickJob([Guid]$ComponentUid, [Hashtable]$Variables) Runs a quick job on the device for a specified job component and variables. **Returns:** `DRMMJob` - Represents a job in the DRMM system, including its ID, unique identifier, name, creation date, and status. **Parameters:** - `[Guid]$ComponentUid` - TODO: Describe this parameter - `[Hashtable]$Variables` - TODO: Describe this parameter ### Move([Guid]$TargetSiteUid) Moves the device to a different site within the DRMM system. **Returns:** `DRMMDevice` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. **Parameters:** - `[Guid]$TargetSiteUid` - TODO: Describe this parameter ## NOTES This class is defined in the DattoRMM.Core module's class system. SEE ALSO Online Documentation https://github.com/TheShadowTek/DattoRMM.Core/blob/main/docs/about/classes/DRMMDevice/about_DRMMDevice.md |