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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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 output zip file to save the platform configuration in.

    .PARAMETER sessionToken
    Hashtable containing the session token returned from New-PASSession

    .PARAMETER WebSession
    WebRequestSession object returned from New-PASSession

    .PARAMETER BaseURI
    PVWA Web Address
    Do not include "/PasswordVault/"

    .PARAMETER PVWAAppName
    The name of the CyberArk PVWA Virtual Directory.
    Defaults to PasswordVault

    .PARAMETER ExternalVersion
    The External CyberArk Version, returned automatically from the New-PASSession function from version 9.7 onwards.
    If the minimum version requirement of this function is not satisfied, execution will be halted.
    Omitting a value for this parameter, or supplying a version of "0.0" will skip the version check.

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

    Exports UnixSSH to Platform.zip platform package.

    .INPUTS
    SessionToken, ImportFile, WebSession & BaseURI can be piped by property name

    .OUTPUTS
    None

    .NOTES
    Minimum CyberArk version 10.4

    #>

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

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ -PathType Leaf -IsValid})]
        [ValidatePattern( '\.zip$' )]
        [string]$path,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [hashtable]$SessionToken,

        [parameter(
            ValueFromPipelinebyPropertyName = $true
        )]
        [Microsoft.PowerShell.Commands.WebRequestSession]$WebSession,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$BaseURI,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$PVWAAppName = "PasswordVault",

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [System.Version]$ExternalVersion = "0.0"

    )

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

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for request
        $URI = "$baseURI/$PVWAAppName/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 -Headers $SessionToken -WebSession $WebSession -Debug:$false

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

                try {

                    $output = @{
                        Path     = $path
                        Value    = $result
                        Encoding = "Byte"
                    }

                    If($IsCoreCLR) {

                        #amend parameters for splatting if we are in Core
                        $output.Add("AsByteStream", $true)
                        $output.Remove("Encoding")

                    }

                    #write it to a file
                    Set-Content @output -ErrorAction Stop

                } catch {throw "Error Saving $path"}

            }

        }

    }#process

    END {}#end

}