Export-VPASPlatform


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

EXPORT PLATFORM FROM CYBERARK


Description:

USE THIS FUNCTION TO EXPORT A PLATFORM FROM CYBERARK


Syntax:

Export-VPASPlatform -PlatformName <String> [-Directory <String>] [-HideOutput] [-token <Hashtable>] [<CommonParameters>]

Export-VPASPlatform -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-PlatformName <String>
Unique target PlatformName that will be exported

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-Directory <String>
Location where the exported files should be placed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-HideOutput [<SwitchParameter>]
Suppress any output to the console

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$ExportPlatformStatus = Export-VPASPlatform -PlatformName {PLATFORMNAME VALUE}

$ExportPlatformStatus = Export-VPASPlatform -PlatformName {PLATFORMNAME VALUE} -Directory {C:\ExampleDir}

$InputParameters = @{
        PlatformName = "TargetPlatformID"
        Directory = "C:\temp\platformExports"
        HideOutput = $true|$false
}
$ExportPlatformStatus = Export-VPASPlatform -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed