Functions/SystemHealth/Get-PASComponentDetail.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
Function Get-PASComponentDetail {
    <#
.SYNOPSIS
Returns details & health information about CyberArk component instances.
 
.DESCRIPTION
Returns details about specific components and all their installed instances,
as well as system health information for each one.
 
.PARAMETER ComponentID
Specify component type to return information on (PVWA, SessionManagement, CPM or AIM)
 
.EXAMPLE
Get-PASComponentDetail -ComponentID CPM
 
Displays CPM Component information
 
.EXAMPLE
Get-PASComponentDetail -ComponentID PVWA
 
Displays PVWA Component information
 
.EXAMPLE
Get-PASComponentDetail -ComponentID SessionManagement
 
Displays PSM Component information
 
.INPUTS
All parameters can be piped to the function by propertyname
 
.OUTPUTS
 
.NOTES
Requires minimum version of CyberArk 10.1.
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateSet("PVWA", "SessionManagement", "CPM", "AIM")]
        [string]$ComponentID

    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.1"
    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for request
        $URI = "$Script:BaseURI/api/ComponentsMonitoringDetails/$ComponentID"

        #send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        if($result) {

            #output returned data
            $result | Select-Object -ExpandProperty ComponentsDetails

        }

    }#process

    END {}#end
}