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

function Get-SmartClientProfile {
    <#
    .SYNOPSIS
        Gets one or more Smart Client Profile objects including their SettingsXml property which defines all parameters
    .DESCRIPTION
        Working with View Groups is not currently supported in MIP SDK, however the redistributable SDK
        includes an assembly containing the VmoClient which is a component used internally by the SDK
        and applications like XProtect Management Client.
 
        This function makes use of this VmoClient to manipulate the View Groups to enable complex tasks
        required in some environments.
    .EXAMPLE
        PS C:\> Get-SmartClientProfile -Name 'Remote Guards'
        Gets the Smart Client Profile named 'Remote Guards'
    .EXAMPLE
        PS C:\> Get-SmartClientProfile -Name 'Limited*'
        Gets the Smart Client Profile(s) with names beginning with the word 'Limited'
    .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()]
    param(
        # Specifies the display name of the ViewGroup. Wildcards are supported.
        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [string]
        $Name = '*'
    )

    begin {
        $vmo = Get-VmoClient
    }

    process {
        try {
            $profiles = $vmo.ManagementServer.ClientProfileSection.SmartClientProfiles | Select-Object
            $profiles | Foreach-Object {
                if ($_.Name -like $Name) {
                    Write-Output $_
                    $vmo.ManagementServer.ClientProfileSection.SmartClientProfiles.Refresh($true)
                }
            }
        }
        catch {
            $vmo.Dispose()
            throw
        }
    }

    end {
        $vmo.Dispose()
    }
}