Functions/Platforms/Export-PASPlatform.ps1
|
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 } |