Public/SmartClientProfiles/Get-EffectiveSmartClientProfile.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
#Requires -Modules 'MilestonePSTools'

function Get-EffectiveSmartClientProfile {
    <#
    .SYNOPSIS
        Gets the effective Smart Client Profile for the given user account Sid
    .DESCRIPTION
        If the given Sid is not valid or recognized, the Default Smart Client Profile will be returned. Otherwise,
    .EXAMPLE
        PS C:\> Get-EffectiveSmartClientProfile -Sid $userSid | Select Name, Id
        Gets the effective Smart Client profile for the given $userSid value, and selects the Name and Id properties to show in the terminal
    .OUTPUTS
        The output of this function will be a [VideoOS.Management.VmoClient.SmartClientProfile] object
        with the following properties:
 
        Name : Remote Guard
        Description :
        LastModified : 1/22/2021 7:59:12 PM
        SettingsXml : <Settings>
                                        <Setting key="SettingKeyName">
                                        <Value>Example</Value>
                                        <Locked>False</Locked>
                                        </Setting>
                                      </Settings>
        IsDefaultProfile : False
        AttachedRoles : {}
        Id : e73e6ddf-8493-48e9-8e48-04b36023538d
        IsDirty : False
        IsCreated : True
        IsDeleted : False
        Exists : True
        CustomProperties : {}
        IsCustomPropertiesSupported : True
        ServerVersion : 20.3.1
    #>

    [CmdletBinding()]
    [OutputType([VideoOS.Management.VmoClient.SmartClientProfile])]
    param(
        # Specifies the display name of the ViewGroup. Wildcards are supported.
        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
        [ValidateNotNullOrEmpty()]
        [string]
        $Sid
    )

    begin {
        $vmo = Get-VmoClient
    }

    process {
        try {
            Write-Output ($vmo.ManagementServer.ClientProfileSection.GetSmartClientProfileBySid($Sid))
        }
        catch {
            $vmo.Dispose()
            throw
        }
    }

    end {
        $vmo.Dispose()
    }
}