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!
Set-XDCredentials
Saves XD credentials to persistent store (-StoreAs) or temporarily for the shell using shell variable $XDStoredCredentials.
Syntax
Set-XDCredentials
[-ProfileName <String>]
[<CommonParameters>]
<!--NeedCopy-->
Set-XDCredentials
[-ProfileType <SDKProfileType>]
[-StoreAs <String>]
[-CustomerId <String>]
-APIKey <String>
[-SecretKey <String>]
[<CommonParameters>]
<!--NeedCopy-->
Set-XDCredentials
[-ProfileType <SDKProfileType>]
[-StoreAs <String>]
[-CustomerId <String>]
-SecureClientFile <String>
[<CommonParameters>]
<!--NeedCopy-->
Set-XDCredentials
[-ProfileType <SDKProfileType>]
[-StoreAs <String>]
[-CustomerId <String>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Saves credentials to persistent store (-StoreAs) or temporarily for the current shell using variable $XDStoredCredentials.
Examples
EXAMPLE 1
Loads the credentials contained in the specified profile and sets them active for all cmdlets in the current shell.
Set-XDCredentials -ProfileName myCredentials
<!--NeedCopy-->
EXAMPLE 2
Stores a default CloudApi credentials profile for customer acme, with the specified API key and secret.
Set-XDCredentials -StoreAs default -ProfileType CloudApi -CustomerId acme -APIKey xxxxxxxx -SecretKey yyyyyyyyy
<!--NeedCopy-->
EXAMPLE 3
Sets temporary CloudApi credentials for customer testcust in the current shell.
Set-XDCredentials -ProfileType CloudApi -CustomerId testcust -SecureClientFile C:\Temp\secureclient.csv.
<!--NeedCopy-->
Parameters
-APIKey
The Citrix Cloud Secure Client API key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecureClientFile
The Citrix Cloud Secure Client File containing an API key and Secret Key.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProfileName
The user-defined name of a credentials profile containing credential information. If the specified profile is found in the secure credential store, it will be loaded and used as the default for the duration of the session in shell variable $XDStoredCredentials.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProfileType
- OnPrem: Kerberos (for communicating with on-premises Controllers).
- CloudMC: Prompt for MyCitrix credentials for each PowerShell session.
- CloudApi: A customer ID and API Key stored in the user’s Windows profile.
- CloudToken: A customer ID and current Citrix Cloud bearer token which is not persisted across PowerShell sessions.
| Type: | SDKProfileType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StoreAs
The name to be used to identify the profile in the secure credential store. Use this with the -ProfileName parameter on cmdlets to load the stored credentials.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomerId
Citrix Cloud Customer name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecretKey
The Citrix Cloud Secure Client Secret.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You cannot pipe input into this cmdlet.
Outputs
None
By default, this cmdlet returns no output.
Related Links
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.