PSDataConduIT

2.0.0

Public/Get-Panel.ps1

<#
    .SYNOPSIS
    Gets a panel.
 
    .DESCRIPTION
    Gets all panels or a single panel if a panel id is specified.
 
    If the result returns null, try the parameter "-Verbose" to get more details.
 
    .EXAMPLE
    Get-Panel
 
    .LINK
    https://github.com/erwindevreugd/PSDataConduIT
 
    .EXTERNALHELP PSDataConduIT-help.xml
#>
function Get-Panel {
    [CmdletBinding()]
    param
    (
        [Parameter(
            Position = 0,
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = 'The name of the server where the DataConduIT service is running or localhost.')]
        [string]
        $Server = $Script:Server,

        [Parameter(
            Position = 1,
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = 'The credentials used to authenticate the user to the DataConduIT service.')]
        [PSCredential]
        $Credential = $Script:Credential,

        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = 'Specifies the id of the panel to get.')]
        [int]
        $PanelID,

        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = 'Specifies the name of the panel to get. Wildcards are permitted.')]
        [string]
        $Name,

        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true,
            HelpMessage = 'Specifies the type of the panel to get. Wildcards are permitted.')]
        [string]
        $Type
    )

    process {
        $query = "SELECT * FROM Lnl_Panel WHERE __CLASS='Lnl_Panel'"

        if ($PanelID) {
            $query += " AND ID=$PanelID"
        }

        if ($Name) {
            $query += " AND Name like '$(ToWmiWildcard $Name)'"
        }

        if ($Type) {
            $query += " AND PanelType like '$(ToWmiWildcard $Type)'"
        }

        LogQuery $query

        $parameters = @{
            ComputerName = $Server;
            Namespace    = $Script:OnGuardNamespace;
            Query        = $query
        }

        if ($Credential -ne $null) {
            $parameters.Add("Credential", $Credential)
        }

        Get-WmiObject @parameters | ForEach-Object { New-Object PSObject -Property @{
                Class                     = $_.__CLASS;
                SuperClass                = $_.__SUPERCLASS;
                Server                    = $_.__SERVER;
                ComputerName              = $_.__SERVER;
                Path                      = $_.__PATH;
                Credential                = $Credential;
                PanelID                   = $_.ID;
                Type                      = $_.PanelType;
                Online                    = $_.IsOnline;
                Name                      = $_.Name;
                Workstation               = $_.Workstation;
                PrimaryDialupHostNumber   = $_.PrimaryDialupHostNumber;
                SecondaryDialupHostNumber = $_.PrimaryDialupHostNumber;
                PrimaryIPAddress          = IntToIPAddress $_.PrimaryIPAddress;
                SegmentID                 = $_.SegmentId;
                DownloadDatabase          = $_.DownloadDatabase;
                DownloadFirmware          = $_.DownloadFirmware;
                ResetUseLimit             = $_.ResetUseLimit;
                UpdateHardwareStatus      = $_.UpdateHardwareStatus;
                Connect                   = $_.Connect;
                Disconnect                = $_.Disconnect;
                SetClock                  = $_.SetClock;
                GetHardwareStatus         = $_.GetHardwareStatus
            } | Add-ObjectType -TypeName "DataConduIT.LnlPanel"
        }
    }
}