Storefront Powershell SDK 2411

Unprotect-STFConfigurationExport

November 28, 2024

Contributed by:

Creates a decrypted copy of the supplied ctxzip file containing configuration elements that form a Citrix StoreFront deployment using the supplied PSCredential.

Syntax

Unprotect-STFConfigurationExport -EncryptedConfigurationZip <String> -Credential <PSCredential> -OutputFolder <String> [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Creates a decrypted copy of the supplied ctxzip file containing configuration elements that form a Citrix StoreFront deployment using the supplied PSCredential.

Parameters

Name	Description	Required?	Pipeline Input
EncryptedConfigurationZip	The path to the backup archive WITH its correct file extension .ctxzip	true	true (ByValue)
Credential	A predefined PowerShell credential object containing the same password that was used to export the backup archive.	true	false
OutputFolder	The folder that the resultant decrypted configuration zip file should be saved to.	true	false

Input Type

System.String

Parameter EncryptedConfigurationZip: The .NET System.String reference type

System.Management.Automation.PSCredential

Parameter Credential: The .NET System.Management.Automation.PSCredential reference type

System.String

Parameter OutputFolder: The .NET System.String reference type

Return Values

None

Examples

EXAMPLE 1 Decrypt Config Export

Unprotect-STFConfigurationExport -EncryptedConfigurationZip "$env:userprofile\desktop\ConfigBackup.ctxzip" -Credential $CredObject -OutputFolder 'C:\exampleFolder\exampleSubfolder' -Force
<!--NeedCopy-->

REMARKS

Using the password supplied in $CredObject this will decrypt and convert the ConfigBackup.ctxzip backup archive to an unencrypted .zip backup archive and save it to C:\exampleFolder\exampleSubfolder\ConfigBackup.zip overwriting any existing ConfigBackup.zip files that may exist at that location.

Example PSCredential:

$User = Any non empty string will suffice here. The exported configuration is secured by only using the $Password.

$Password = ‘Secret’

$Password = $Password

ConvertTo-SecureString -asPlainText -Force

$CredObject = New-Object System.Management.Automation.PSCredential($User,$Password)

Create a PowerShell credential object containing a username and password for symmetric encryption and decryption of configuration backup archives. PowerShell credential objects store passwords as secure strings in memory.

The user is irrelevant but mandatory to create a PowerShell credential object. The example code uses the currently logged in user.

The password is used for symmetric encryption/decryption of the backup archive. NOTE: The password DOES NOT need to match the user’s password to create a valid credential object.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Unprotect-STFConfigurationExport

November 28, 2024

Contributed by:

November 28, 2024

Contributed by:

Unprotect-STFConfigurationExport

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

System.Management.Automation.PSCredential

System.String

Return Values

None

Examples

EXAMPLE 1 Decrypt Config Export

In this article