en-US/about_DRMMSite.help.txt
|
TOPIC
about_DRMMSite SHORT DESCRIPTION Represents a site in the DRMM system, including its properties, settings, and associated devices and variables. LONG DESCRIPTION The DRMMSite class models a site within the DRMM platform, encapsulating properties such as Id, Uid, AccountUid, Name, Description, Notes, OnDemand status, SplashtopAutoInstall setting, ProxySettings, DevicesStatus, SiteSettings, Variables, Filters, AutotaskCompanyName, AutotaskCompanyId, and PortalUrl. It provides a constructor and a static method to create an instance from API response data. The class also includes methods to generate a summary string of the site's information, update site properties, retrieve associated alerts and devices, and open the site's portal URL in a web browser. This class inherits from DRMMObject. ## PROPERTIES The DRMMSite class exposes the following properties: Property Type Description -------------------- --------------------- ---------------------------------------- Id long The unique identifier of the site. Uid guid The unique identifier (UID) of the site. AccountUid string The unique identifier (UID) of the ac... Name string The name of the site. Description string The description of the site. Notes string Additional notes about the site. OnDemand bool Indicates whether the site is on-demand. SplashtopAutoInstall bool Indicates whether Splashtop auto-inst... ProxySettings DRMMSiteProxySettings The proxy settings for the site. DevicesStatus DRMMDevicesStatus The status of the devices associated ... SiteSettings DRMMSiteSettings The settings for the site. Variables DRMMVariable[] The variables associated with the site. Filters DRMMFilter[] The filters associated with the site. AutotaskCompanyName string The name of the Autotask company asso... AutotaskCompanyId string The identifier of the Autotask compan... PortalUrl string The URL of the site portal. ## METHODS The DRMMSite class provides the following methods: ### GetSummary() Generates a summary string for the site, including its name, unique identifier, and device count. **Returns:** `string` - Returns string ### Set([Hashtable]$Properties) Updates the properties of the site based on the provided hashtable of property names and values. **Returns:** `DRMMSite` - Represents a site in the DRMM system, including its properties, settings, and associated devices and variables. **Parameters:** - `[Hashtable]$Properties` - TODO: Describe this parameter ### GetAlerts() Retrieves alerts associated with the site, optionally 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 alerts associated with the site, optionally filtered by 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 portal URL associated with the site in the default web browser. **Returns:** `void` - Returns void ### GetDevices() Retrieves devices associated with the site, optionally filtered by a specific filter ID. **Returns:** `DRMMDevice[]` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. ### GetDevices([Int64]$FilterId) Retrieves devices associated with the site, optionally filtered by a specific filter ID. **Returns:** `DRMMDevice[]` - Represents a device in the DRMM system, encapsulating properties and methods for interacting with the device. **Parameters:** - `[Int64]$FilterId` - TODO: Describe this parameter ### GetDeviceCount() Retrieves the count of devices associated with the site. **Returns:** `int` - Returns int ### GetVariables() Retrieves variables associated with the site. **Returns:** `DRMMVariable[]` - Represents a variable in the DRMM system, including its name, value, scope, and other attributes. ### GetVariable([String]$Name) Retrieves a specific variable associated with the site by name. **Returns:** `DRMMVariable` - Represents a variable in the DRMM system, including its name, value, scope, and other attributes. **Parameters:** - `[String]$Name` - TODO: Describe this parameter ### NewVariable([String]$Name, [String]$Value) Creates a new variable associated with the site. **Returns:** `DRMMVariable` - Represents a variable in the DRMM system, including its name, value, scope, and other attributes. **Parameters:** - `[String]$Name` - TODO: Describe this parameter - `[String]$Value` - TODO: Describe this parameter ### NewVariable([String]$Name, [String]$Value, [Boolean]$Masked) Creates a new variable associated with the site, with an option to mask the value. **Returns:** `DRMMVariable` - Represents a variable in the DRMM system, including its name, value, scope, and other attributes. **Parameters:** - `[String]$Name` - TODO: Describe this parameter - `[String]$Value` - TODO: Describe this parameter - `[Boolean]$Masked` - TODO: Describe this parameter ### GetFilters() Retrieves filters associated with the site. **Returns:** `DRMMFilter[]` - Represents a filter in the DRMM system, including its name, description, type, and scope. ### GetFilter([String]$Name) Retrieves a specific filter associated with the site by name. **Returns:** `DRMMFilter` - Represents a filter in the DRMM system, including its name, description, type, and scope. **Parameters:** - `[String]$Name` - TODO: Describe this parameter ### GetSettings() Retrieves the site settings for the site. **Returns:** `DRMMSiteSettings` - Represents the overall settings for a site in the DRMM system, including general settings, proxy settings, mail recipients, and site UID. ### SetProxy([String]$ProxyHost, [Int32]$Port, [String]$Type) Sets the proxy settings for the site. **Returns:** `DRMMSiteSettings` - Represents the overall settings for a site in the DRMM system, including general settings, proxy settings, mail recipients, and site UID. **Parameters:** - `[String]$ProxyHost` - TODO: Describe this parameter - `[Int32]$Port` - TODO: Describe this parameter - `[String]$Type` - TODO: Describe this parameter ### SetProxy([String]$ProxyHost, [Int32]$Port, [String]$Type, [String]$Username, [SecureString]$Password) Sets the proxy settings for the site, including authentication credentials. **Returns:** `DRMMSiteSettings` - Represents the overall settings for a site in the DRMM system, including general settings, proxy settings, mail recipients, and site UID. **Parameters:** - `[String]$ProxyHost` - TODO: Describe this parameter - `[Int32]$Port` - TODO: Describe this parameter - `[String]$Type` - TODO: Describe this parameter - `[String]$Username` - TODO: Describe this parameter - `[SecureString]$Password` - TODO: Describe this parameter ### RemoveProxy() Removes the proxy settings for the site. **Returns:** `DRMMSiteSettings` - Represents the overall settings for a site in the DRMM system, including general settings, proxy settings, mail recipients, and site UID. ## 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/DRMMSite/about_DRMMSite.md |