Functions/Platforms/Export-PASPlatform.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
function Export-PASPlatform {
    <#
    .SYNOPSIS
    Export a platform

    .DESCRIPTION
    Export a platform to a zip file in order to import it to a different Vault environment.
    Vault Admin group membership required.

    .PARAMETER PlatformID
    The name of the platform.

    .PARAMETER Path
    The folder to export the platform configuration to.

    .EXAMPLE
    Export-PASPlatform -PlatformID YourPlatform -Path C:\Platform.zip

    Exports UnixSSH to Platform.zip platform package.

    .NOTES
    Minimum CyberArk version 10.4

    #>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$PlatformID,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateScript( { Test-Path -Path $_ -IsValid })]
        [string]$path
    )

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

    PROCESS {

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

        #Create URL for request
        $URI = "$Script:BaseURI/API/Platforms/$PlatformID/Export?platformID=$PlatformID"

        if ($PSCmdlet.ShouldProcess($PlatformID, "Exports Platform Package")) {

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

            #if we get a platform byte array
            if ($result) {

                Out-PASFile -InputObject $result -Path $path

            }

        }

    }#process

    END { }#end

}