This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Export-STFConfiguration
Exports a zip file containing configuration elements that form a Citrix StoreFront deployment. This zip file may be unencrypted in the form of a ‘.zip’ file or encrypted in the form of a ‘.ctxzip’.
Syntax
Export-STFConfiguration -TargetFolder <String> -ZipFileName <String> [-Credential <PSCredential>] [-Force <SwitchParameter>] [-NoEncryption <SwitchParameter>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Exports a zip file containing configuration elements that form a Citrix StoreFront deployment. This zip file may be unencrypted in the form of a ‘.zip’ file or encrypted in the form of a ‘.ctxzip’.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| TargetFolder | The folder to export the backup archive to. | true | true (ByValue) | |
| ZipFileName | The name of the backup archive WITHOUT its file extension. | true | true (ByValue) | |
| Credential | Use this parameter if you wish to encrypt the exported configuration. The backup archive will have the file extension .ctxzip. | false | false | |
| Force | Use the force parameter to silently overwrite any previous backups with the same name as the one you are currently exporting. | false | false | |
| NoEncryption | Use this parameter if you wish to export the configuration unencrypted. The backup archive will have the file extension .zip. | false | true (ByValue) |
Input Type
System.String
Parameter TargetFolder: The .NET System.String reference type
System.String
Parameter ZipFileName: The .NET System.String reference type
System.Management.Automation.PSCredential
Parameter Credential: The .NET System.Management.Automation.PSCredential reference type
System.Management.Automation.SwitchParameter
Parameter Force: The .NET System.Management.Automation.SwitchParameter value type
System.Management.Automation.SwitchParameter
Parameter NoEncryption: The .NET System.Management.Automation.SwitchParameter value type
Return Values
None
Examples
EXAMPLE 1 Basic Config Export
Export-STFConfiguration -$targetFolder '$env:userprofile\desktop\' -zipFileName 'ConfigBackup' -NoEncryption
<!--NeedCopy-->
REMARKS
This example creates an unencrypted ‘.zip’ file at ‘$env:userprofile\desktop' called ConfigBackup.
EXAMPLE 2 Encrypted Config Export
Export-STFConfiguration -$targetFolder '$env:userprofile\desktop' -zipFileName 'ConfigBackup' -credential $CredObject
<!--NeedCopy-->
REMARKS
This example creates an encrypted .ctxzip file as above using a pre-defined PSCredential object.
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.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.