Public/Get-CAMLicense.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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
function Get-CAMLicense
{
<#
    .SYNOPSIS
        Function to retrieve License from the Cireson Asset Management
     
    .DESCRIPTION
        Function to retrieve License from the Cireson Asset Management
     
    .PARAMETER DisplayName
        Specifies the DisplayName
     
    .PARAMETER ID
        Specifies the ID of the License. Typically the GUID.
     
    .PARAMETER Filter
        Specifies the filter you want to apply
 
    .EXAMPLE
        Get-CAMLicense
         
        Retrieve all the Licenses
     
    .EXAMPLE
        Get-CAMLicense -DisplayName "Antidote*"
         
        Retrieve the Licenses with the displayname Antidote
     
    .EXAMPLE
        Get-CAMLicense -id '3cbgg558-a09c-b717-2401-05aef430b01f'
         
        Retrieve the specific License with the ID '3cbgg558-a09c-b717-2401-05aef430b01f'
 
    .EXAMPLE
        Get-CAMLicense -filter "SeatsRemaining -gt 1"
         
        Retrieve Licenses with more thant 1 seat available
     
    .NOTES
        Francois-Xavier Cat
        www.lazywinadmin.com
        @lazywinadm
#>

    
    [CmdletBinding(DefaultParameterSetName = 'All')]
    param
    (
        [Parameter(ParameterSetName = 'DisplayName')]
        [System.String]$DisplayName,
        
        [Parameter(ParameterSetName = 'ID')]
        $Id,
        
        [Parameter(ParameterSetName = 'Filter')]
        [System.String]$Filter
    )
    
    BEGIN
    {
        
        if (-not (Get-Module -Name SMLets)) { Import-Module -Name SMLets -ErrorAction Stop }
        
        Write-Debug -Message "ParameterSetName: $($PSCmdlet.ParameterSetName)"
        Write-Debug -Message "Parameters: $($PSBoundParameters.Keys)"
    }
    PROCESS
    {
        TRY
        {
            $Splatting = @{
                Class = (Get-SCSMClass -name 'Cireson.AssetManagement.Licence')
            }
            
            IF ($PSBoundParameters['DisplayName']){Get-Scsmobject @Splatting -Filter "DisplayName -like $DisplayName"}
            ELSEIF ($PSBoundParameters['ID']){Get-Scsmobject @Splatting -Filter "Id -eq $ID"}
            ELSEIF ($PSBoundParameters['Filter']){get-scsmobject @Splatting -Filter $Filter}
            ELSEIF ($PSBoundParameters['DaysLeft'])
            {
                get-scsmobject @Splatting -Filter "ContractEndDate -lt $((Get-Date).AddDays($DaysLeft))" #-and ContractEndDate -ge $(Get-Date)"
            }
            ELSE{get-scsmobject @Splatting}
        }
        CATCH
        {
            Write-Error -Message "[PROCESS] An Error occured"
            $Error[0].Exception.Message
        }
    }
}