Cmdlet dello strumento di configurazione automatizzata per la migrazione
Questa pagina elenca tutti i cmdlet e i parametri supportati dallo strumento per i casi d’uso di migrazione.
-
Tutti i cmdlet accettano parametri di uno dei seguenti tipi.
- Stringa
- Elenco di stringhe
- Booleano:
$trueo$false - SwitchParameter: la presenza del parametro significa
$true; l’assenza del parametro significa$false
Nota:
SwitchParameter è il metodo preferito per le selezioni vero o falso, ma i booleani sono ancora utilizzati nello strumento a causa di problemi di compatibilità.
La tabella seguente riassume tutti i cmdlet. Consultare ogni singola sezione per trovare i parametri supportati da ciascun cmdlet.
| Categoria | Cmdlet | Descrizione |
|---|---|---|
|
Migrazione da on-premises a cloud
|
Export-CvadAcToFile |
Esporta i file on-premises in file YAML. |
Import-CvadAcToSite |
Importa i file YAML nel cloud. Supporta operazioni di creazione, aggiornamento ed eliminazione. | |
Merge-CvadAcToSite |
Importa i file YAML nel cloud. Supporta operazioni di creazione e aggiornamento. | |
New-CvadAcToSite |
Importa i file YAML nel cloud. Supporta operazioni di creazione e aggiornamento. | |
Sync-CvadAcToSite |
Esporta e importa in un unico passaggio. | |
Migrazione granulare Per i componenti, utilizzare i parametri con i comandi precedenti. Esempi: MachineCatalogs, Tags. Per i nomi dei componenti, utilizzare i parametri con i comandi precedenti. Esempi: IncludeByName, ExcludeByName. |
Migra selettivamente solo componenti o nomi di componenti | |
|
Cmdlet da cloud a cloud
|
Backup-CvadAcToFile |
Esegue il backup di tutta la configurazione dal sito cloud. |
Restore-CvadAcToSite |
Ripristina i file YAML di backup nel sito cloud. Questo sito cloud può essere uguale o diverso dal sito cloud di origine. | |
Remove-CvadAcFromSite |
Rimuove i membri del componente dal cloud. | |
Migrazione granulare Per i componenti, utilizzare i parametri con i comandi precedenti. Esempi: MachineCatalogs, Tags. Per i nomi dei componenti, utilizzare i parametri con i comandi precedenti. Esempi: IncludeByName, ExcludeByName. |
Migra selettivamente solo componenti o nomi di componenti | |
| Altri cmdlet di base | Compare-CvadAcToSite |
Confronta i file .yml on-premises con la configurazione cloud. |
|
Cmdlet relativi ai prerequisiti
|
New-CvadAcCustomerInfoFile |
Crea un file di informazioni sul cliente. |
Set-CvadAcCustomerInfoFile |
Aggiorna un file di informazioni sul cliente esistente. | |
|
Cmdlet di supporto e risoluzione dei problemi
|
New-CvadAcZipInfoForSupport |
Comprime tutti i file di log e .yml in un unico file zip da inviare a Citrix® per il supporto. |
Get-CvadAcStatus |
Utilizzare per testare la connettività e assicurarsi che tutti i prerequisiti siano soddisfatti. Restituisce informazioni sullo strumento come il numero di versione e la connettività con il cloud e lo stato del connettore. | |
Test-CvadAcConnectionWithSite |
Testa la connessione con il sito cloud. | |
Find-CvadAcConnector |
Individua i connettori esistenti e ne determina lo stato di esecuzione. | |
Get-CvadAcCustomerSites |
Restituisce l’elenco di tutti i siti del cliente. | |
New-CvadAcTemplateToFile |
Crea un file modello per i componenti selezionati. | |
Show-CvadAcDocument |
Visualizza questa documentazione nel browser predefinito. | |
Find-CvadAcInFile |
La ricerca nel file cerca nei file YAML dei componenti membri che corrispondono a uno o più nomi che possono contenere caratteri jolly. | |
|
Cmdlet di attivazione del sito
|
Set-CvadAcSiteActiveStateOnPrem |
Imposta lo stato del sito on-premises su attivo o inattivo. |
Set-CvadAcSiteActiveStateCloud |
Imposta lo stato del sito cloud su attivo o inattivo. |
- |\[Cmdlet di unione di più siti on-premises]\(#merging-multiple-on-premises-sites-cmdlets)|`New-CvadAcSiteMergingInfo`|Crea un set di informazioni prefisso/suffisso per l'unione di siti.| |^^|`Set-CvadAcSiteMergingInfo`|Aggiorna un set di informazioni prefisso/suffisso per l'unione di siti esistente.| |^^|`Remove-CvadAcSiteMergingInfo`|Rimuove un set di informazioni prefisso/suffisso per l'unione di siti esistente.|
Per maggiori informazioni sui parametri e sul loro utilizzo, consultare Parametri di migrazione granulare.
Cmdlet di base
Cmdlet da on-premises a cloud
-
Export-CvadAcToFile- Esporta i file on-premises in file YAML.Esporta la configurazione dalla configurazione on-premises. Questa è l’operazione di esportazione predefinita per la configurazione automatizzata. Non vengono apportate modifiche alla configurazione del sito on-premises. I file esportati vengono inseriti nella directory %HOMEPATH%\Documents\Citrix\AutoConfig in una sottocartella Export con un nome univoco. La cartella %HOMEPATH%\Documents\Citrix\AutoConfig contiene sempre l’ultima configurazione del sito on-premises esportata.
- Parametri:
-
Nome Descrizione Obbligatorio? Tipo - |—|—|—|—|
-
Migra per componenti Vedere Migra per componenti Filtro per nomi di oggetti Vedere Filtro per nomi di oggetti TargetFolderSpecifica la cartella di destinazione dell’esportazione. LocaleSpecifica la lingua del testo leggibile che può essere esportato. QuietSopprime la registrazione nella console. AdminAddressSpecifica l’indirizzo DNS o IP del Delivery Controller quando l’esportazione non viene eseguita sul Delivery Controller.
-
-
CheckUserAndMachinesVerifica se utenti e macchine sono in Active Directory. Utenti e macchine non presenti in Active Directory potrebbero causare errori di importazione. ZipResultsComprime i file YAML di backup in un unico file zip. Il file si trova nella stessa cartella dei file YAML di backup e ha lo stesso nome della cartella. Restituisce:
- Vedere Valori restituiti dai cmdlet
Esistono tre modi per importare dati nel cloud. L’esecuzione di cmdlet specifici può comportare una delle tre combinazioni di azioni sul sito cloud:
- Aggiungi, Aggiorna ed Elimina
- Solo Aggiungi e Aggiorna
- Solo Aggiungi
| Cmdlet | Aggiungi | Aggiorna | Elimina |
|---|---|---|---|
| Importa | X | X | X |
| Unisci | X | X |
- | Nuovo | X | | |
-
Import-CvadAcToSite- Importa i file YAML nel cloud. Supporta operazioni di creazione, aggiornamento ed eliminazione.Importa tutti i file on-premises nel cloud. Questo comando garantisce che lo stato finale del cloud sia identico allo stato on-premises. Questa opzione elimina qualsiasi modifica esistente nel cloud. I file di configurazione del sito importati provengono da %HOMEPATH%\Documents\Citrix\AutoConfig. Usare con cautela.
Parametri:
Nome Descrizione Obbligatorio? Tipo Migra per componenti Vedere Migra per componenti. SwitchParameters Filtro per nomi di oggetti Vedere Filtro per nomi di oggetti. Elenco di stringhe Parametri di accesso al cloud Vedere Parametri di accesso al cloud. SwitchParameters SourceFolderIdentifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig. Stringa LocaleSpecifica la lingua del testo leggibile che può essere esportato. Stringa QuietSopprime la registrazione nella console. SwitchParameter DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper sopprimere la visualizzazione del log.$trueo$falseMergeSe impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su$falseper rimuovere i componenti.$trueo$false-
AddOnlySe impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina componenti esistenti. Impostare su$falseper consentire aggiornamenti ed eliminazioni.Mergeviene ignorato quando questo parametro è$true.
-
-
MergePoliciesUnisce le impostazioni e i filtri dei criteri. L’unione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato dell’unione dei criteri è che i criteri del DDC cloud contengono le impostazioni e i filtri che già possedevano, oltre a eventuali nuove impostazioni e filtri importati. Si noti che in caso di collisioni tra impostazioni e filtri, i valori importati hanno la precedenza. OnErrorActionVedere parametro OnErrorAction. Restituisce:
- Vedere Valori restituiti dal cmdlet
-
Merge-CvadAcToSite- Importa file YAML nel cloud. Supporta operazioni di creazione e aggiornamento.Unisce i file locali al cloud, ma non elimina alcun componente nel cloud o nel sito locale. Ciò preserva le modifiche già apportate nel cloud. Se un componente esiste in Citrix Cloud con lo stesso nome, questo comando può modificare tale componente. Questa è l’operazione di importazione predefinita per la configurazione automatizzata. I file di configurazione del sito uniti provengono da %HOMEPATH%\Documents\Citrix\AutoConfig.
Parametri:
|Nome|Descrizione|Obbligatorio?|Tipo|
- |—|—|—|—|
-
Migrazione per componenti Vedere Migrazione per componenti. Filtro per nomi oggetto Vedere Filtro per nomi oggetto. Parametri di accesso al cloud Vedere Parametri di accesso al cloud. SourceFolderIdentifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig. LocaleSpecifica la lingua del testo leggibile dall’uomo che può essere esportato. QuietElimina la registrazione nella console. DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.MergeSe impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su$falseper rimuovere i componenti.AddOnlySe impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina componenti esistenti. Impostare su$falseper consentire aggiornamenti ed eliminazioni.Mergeviene ignorato quando questo parametro è$true.MergePoliciesUnisce le impostazioni e i filtri dei criteri. L’unione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato dell’unione dei criteri è che i criteri DDC cloud contengono le impostazioni e i filtri che già avevano, oltre a eventuali nuove impostazioni e filtri importati. Si noti che in caso di collisioni tra impostazioni e filtri, i valori importati hanno la precedenza. OnErrorActionVedere Parametro OnErrorAction. Restituisce:
- Vedere Valori restituiti dal cmdlet
-
New-CvadAcToSite- Importa file YAML nel cloud. Supporta operazioni di creazione e aggiornamento.Importa la configurazione del sito locale nel cloud, ma aggiunge solo nuovi componenti. I componenti del sito cloud esistenti non vengono né aggiornati né eliminati. Utilizzare questo comando se i componenti del sito cloud esistenti devono rimanere invariati.
Parametri:
Nome Descrizione Obbligatorio? Tipo Migrazione per componenti Vedere Migrazione per componenti. SwitchParameters Filtro per nomi oggetto Vedere Filtro per nomi oggetto. List of strings Parametri di accesso al cloud Vedere Parametri di accesso al cloud. SwitchParameters SourceFolderIdentifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig. String LocaleSpecifica la lingua del testo leggibile dall’uomo che può essere esportato. String QuietElimina la registrazione nella console. SwitchParameter DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.$trueo$falseOnErrorActionVedere Parametro OnErrorAction. String -
Restituisce:
- Vedere Valori restituiti dal cmdlet
-
Sync-CvadAcToSite- Esporta e importa in un unico passaggio.Sync esegue sia un’esportazione che un’importazione in un unico passaggio. Utilizzare il parametro
SourceTargetFolderper specificare la cartella di destinazione di esportazione/importazione.Parametri:
Nome Descrizione Obbligatorio? Tipo Migrazione per componenti Vedere Migrazione per componenti SwitchParameters Filtro per nomi oggetto Vedere Filtro per nomi oggetto List of strings Parametri di accesso al cloud Vedere Parametri di accesso al cloud SwitchParameters SourceTargetFolderSpecifica la cartella di destinazione di esportazione/importazione. String LocaleSpecifica la lingua del testo leggibile dall’uomo che può essere esportato. String -
AdminAddressSpecifica l’indirizzo DNS o IP del controller di consegna quando l’esportazione non viene eseguita sul controller di consegna.
-
-
QuietElimina la registrazione nella console. DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.MergeSe impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su$falseper rimuovere i componenti.AddOnlySe impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina componenti esistenti. Impostare su$falseper consentire aggiornamenti ed eliminazioni.Mergeviene ignorato quando questo parametro è$true.MergePoliciesUnisce le impostazioni e i filtri dei criteri. L’unione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato dell’unione dei criteri è che i criteri DDC cloud contengono le impostazioni e i filtri che già avevano, oltre a eventuali nuove impostazioni e filtri importati. Si noti che in caso di collisioni tra impostazioni e filtri, i valori importati hanno la precedenza. Restituisce:
- Vedere Valori restituiti dal cmdlet
Cmdlet da cloud a cloud
-
Backup-CvadAcToFile- Esegue il backup di tutta la configurazione dal sito cloud.Esporta la configurazione del cloud in file .yml. Questo backup può essere utilizzato in un processo di backup e ripristino per ripristinare i componenti persi.
Parametri:
Nome Descrizione Obbligatorio? Tipo Migrazione per componenti Vedere Migrazione per componenti SwitchParameters Parametri di accesso al cloud Vedere Parametri di accesso al cloud SwitchParameters TargetFolderSpecifica la cartella di destinazione dell’esportazione. String LocaleSpecifica la lingua del testo leggibile dall’uomo che può essere esportato. String QuietElimina la registrazione nella console. SwitchParameter DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.$trueo$falseZipResultsComprime i file YAML di backup in un singolo file zip. Il file si trova nella stessa cartella dei file YAML di backup e ha lo stesso nome della cartella. SwitchParameter -
Valori restituiti:
-
Vedere Valori restituiti del cmdlet
-
-
Restore-CvadAcToSite- Ripristina i file YAML di backup nel sito cloud. Questo sito cloud può essere lo stesso o diverso dal sito cloud di origine. -
Ripristina il sito cloud alla configurazione precedente. I file importati provengono dalla cartella specificata utilizzando il parametro
-RestoreFolder, che identifica la cartella contenente i file .yml da ripristinare nel sito cloud. Deve trattarsi di una specifica di cartella completa. Questo cmdlet può essere utilizzato per ripristinare la configurazione precedente o per eseguire il backup e il ripristino del sito cloud. Questo comando può aggiungere, eliminare e aggiornare il sito cloud. -
Parametri:
-
Nome Descrizione Obbligatorio? Tipo - |—|—|—|—|
-
Migrazione per componenti Vedere Migrazione per componenti. -
Filtro per nomi di oggetti Vedere Filtro per nomi di oggetti. -
Parametri di accesso al cloud Vedere Parametri di accesso al cloud. -
RestoreFolderIdentifica la cartella contenente i file .yml da ripristinare nel sito cloud. Deve trattarsi di una specifica di cartella completa. -
LocaleSpecifica la lingua del testo leggibile che può essere esportato. QuietElimina la registrazione nella console. DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.MergeSe impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su$falseper rimuovere i componenti.AddOnlySe impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina componenti esistenti. Impostare su$falseper consentire aggiornamenti ed eliminazioni.Mergeviene ignorato quando questo parametro è$true.-
MergePoliciesUnisce le impostazioni e i filtri dei criteri. L’unione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato dell’unione dei criteri è che i criteri del DDC cloud contengono le impostazioni e i filtri che già aveva, oltre a eventuali nuove impostazioni e filtri importati. Si noti che in caso di collisioni tra impostazioni e filtri, i valori importati hanno la precedenza.
-
-
OnErrorActionVedere parametro OnErrorAction. Valori restituiti:
- Vedere Valori restituiti del cmdlet
-
Remove-CvadAcFromSite– Rimuove i membri dei componenti dal cloud. -
Può reimpostare l’intero sito o rimuovere elementi membri da un componente (ad esempio, rimuovere un catalogo macchine dall’elenco dei cataloghi). Questo può essere utilizzato in combinazione con il parametro
IncludeByNameper rimuovere selettivamente membri specifici.Parametri:
Nome Descrizione Obbligatorio? Tipo Migrazione per componenti Vedere Migrazione per componenti SwitchParameters Filtro per nomi di oggetti Vedere Filtro per nomi di oggetti List of strings -
Parametri di accesso al cloud Vedere Parametri di accesso al cloud -
QuietElimina la registrazione nella console. DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.Valori restituiti:
- Vedere Valori restituiti del cmdlet
Altri cmdlet di base
-
Compare-CvadAcToSite- Confronta i file .yml locali con la configurazione cloud, producendo un report delle modifiche apportate da un cmdletImport,MergeoRestore.Parametri:
Nome Descrizione Obbligatorio? Tipo Migrazione per componenti Vedere Migrazione per componenti. SwitchParameters Filtro per nomi di oggetti Vedere Filtro per nomi di oggetti. List of strings Parametri di accesso al cloud Vedere Parametri di accesso al cloud. SwitchParameters SourceFolderIdentifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig. String LocaleSpecifica la lingua del testo leggibile che può essere esportato. String QuietElimina la registrazione nella console. SwitchParameter DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper eliminare la visualizzazione del log.$trueo$falseMergeSe impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su$falseper rimuovere i componenti.$trueo$falseAddOnlySe impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina componenti esistenti. Impostare su$falseper consentire aggiornamenti ed eliminazioni.Mergeviene ignorato quando questo parametro è$true.$trueo$falseOnErrorActionVedere parametro OnErrorAction. String -
Valori restituiti:
- Vedere Valori restituiti del cmdlet
Parametri di migrazione granulare
Migrazione per componenti
I seguenti componenti possono essere specificati con i cmdlet che li supportano. L’opzione All viene selezionata automaticamente quando non vengono specificati parametri di componente. Per evitare errori, si consiglia di migrare i componenti nel seguente ordine:
- Tutti
- Tag
- Ruoli amministrativi
- Ambiti amministrativi
- Connessioni host
- Cataloghi macchine
- StoreFront
- Gruppi di consegna
- Gruppi di applicazioni
- Cartelle applicazioni
- Applicazioni
- Criteri di gruppo
- Preferenza zona utente
Filtro per nomi di oggetti
Migrazione per nomi di componenti
I parametri IncludeByName ed ExcludeByName consentono di includere ed escludere membri di componenti nei cmdlet per nome. Solo un componente (ad esempio, gruppi di consegna) può essere scelto alla volta in uno qualsiasi dei cmdlet supportati. Se un membro del componente si trova in entrambe le aree, l’esclusione prevale su qualsiasi altro parametro e viene creata una voce nell’elenco di correzione del log che identifica il componente e il nome del membro che è stato escluso.
IncludeByName ed ExcludeByName accettano un elenco di nomi di membri di componenti. Qualsiasi nome può contenere uno o più caratteri jolly. Sono supportati due tipi di caratteri jolly. L’elenco dei nomi dei membri del componente deve essere racchiuso tra virgolette singole se un nome di membro contiene caratteri speciali.
- `*` Corrisponde a qualsiasi numero di caratteri
-
?Corrisponde a un singolo carattere
IncludeByName ed ExcludeByName possono anche accettare un file contenente un elenco di membri in cui ogni membro può essere esplicito o contenere caratteri jolly. Ogni riga del file può contenere un membro. Gli spazi iniziali e finali vengono rimossi dal nome del membro. Il nome del file deve essere preceduto dal segno @ ed essere racchiuso tra virgolette singole (un requisito di PowerShell affinché il @ non venga reinterpretato). È possibile elencare più file, oltre a mescolarli con i nomi dei membri.
Un esempio di unione di tutti i gruppi di consegna i cui nomi iniziano con DgSite1 e contengono Home2 sarebbe scritto:
Merge-CvadAcToSite –DeliveryGroups –IncludeByName DgSite1*,*Home2*
- #### Per nome del gruppo di consegna
ByDeliveryGroupName filtra per nome del gruppo di consegna per applicazioni e gruppi di applicazioni. Questo parametro è sempre un elenco di inclusione che identifica i membri da includere in base alla loro associazione al gruppo di consegna.
ByDeliveryGroupName accetta un elenco di nomi di gruppi di consegna. Qualsiasi nome può contenere uno o più caratteri jolly. Sono supportati due tipi di caratteri jolly.
-
*corrisponde a qualsiasi numero di caratteri-
?corrisponde a un singolo carattere
-
- L’esempio seguente unisce tutte le applicazioni che fanno riferimento a tutti i nomi di gruppi di consegna che iniziano con
EastDg.
Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*
Escludi disabilitati
ExcludeDisabled filtra dalle operazioni di importazione tutte le applicazioni e i gruppi di applicazioni disabilitati. ExcludeDisabled è impostato su false per impostazione predefinita, il che significa che tutte le applicazioni e i gruppi di applicazioni vengono importati indipendentemente dal loro stato abilitato.
- #### Per nome della macchina
- `ByMachineName` filtra per nome della macchina per cataloghi di macchine e gruppi di consegna. Questo parametro è sempre un elenco di inclusione che identifica i membri da includere in base alla loro associazione al nome della macchina.
- `ByMachineName` accetta un elenco di nomi di macchine in cui qualsiasi nome può contenere uno o più caratteri jolly. Sono supportati due tipi di caratteri jolly.
-
*corrisponde a qualsiasi numero di caratteri-
?corrisponde a un singolo carattere
-
Quando si esporta o si importa e si utilizza ByMachineName e un filtro per nome della macchina non produce macchine nel catalogo di macchine o nel gruppo di consegna, il catalogo di macchine o il gruppo di consegna viene escluso dall’esportazione o dall’importazione.
Nota: - > - > L’uso di
ByMachineNamein qualsiasi cmdlet di tipo importazione comporta l’impostazione diMergeMachinessu$true.
- #### Unisci macchine
- `MergeMachines`, quando impostato su `$true`, istruisce l'operazione di importazione ad aggiungere macchine solo al catalogo di macchine o al gruppo di consegna. Le macchine non vengono rimosse, consentendo operazioni additive incrementali.
MergeMachines è impostato su false per impostazione predefinita, il che significa che le macchine vengono rimosse se non sono presenti nel catalogo macchine o nel file .yml del gruppo di consegna. MergeMachines è impostato su $true quando viene utilizzato ByMachineName, ma può essere sovrascritto impostando MergeMachines su false.
Cmdlet correlati ai prerequisiti
-
New-CvadAcCustomerInfoFile- Crea un file di informazioni sul cliente. Per impostazione predefinita, il file di informazioni sul cliente si trova in %HOMEPATH%\Documents\Citrix\AutoConfig.Parametri:
Nome Descrizione Obbligatorio? Tipo CustomerIdID del cliente. x Stringa -
ClientIdID client del cliente creato su Citrix Cloud. CustomerIdeSecretdevono essere specificati quando si utilizza questo parametro.Condizionale Stringa SecretChiave segreta del cliente creata su Citrix Cloud. CustomerIdeClientIddevono essere specificati quando si utilizza questo parametro.Condizionale Stringa EnvironmentAmbiente Production, ProductionGov o ProductionJP. Enumerazione
-
-
LogFileNameModifica il prefisso del file di log da CitrixLog a qualcos’altro. AltRootUrlUtilizzare solo sotto la direzione di Citrix. StopOnErrorInterrompe l’operazione al primo errore. TargetFolderUtilizza la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig. LocaleUtilizza le impostazioni locali specificate invece di quelle derivate dal sistema su cui viene eseguito lo strumento. EditorUtilizza l’editor specificato per visualizzare il log al completamento di ogni cmdlet. Notepad.exe è l’editor predefinito. Questo parametro deve includere la specifica del file completa per l’editor e l’editor deve accettare la specifica del file di log come unico parametro. SecurityCsvFileSpecLa specifica del file completa che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. CustomerIddeve essere specificato quando si utilizza questo parametro.Valori restituiti:
- Vedere Valori restituiti dai cmdlet
-
Set-CvadAcCustomerInfoFile- Aggiorna un file di informazioni sul cliente esistente. Vengono modificati solo i parametri specificati dal cmdlet. Tutti i valori dei parametri non specificati nel file CustomerInfo.yml rimangono invariati.Parametri:
Nome Descrizione Obbligatorio? Tipo CustomerIdID del cliente. Stringa ClientIdID client del cliente creato su Citrix Cloud. Stringa SecretChiave segreta del cliente creata su Citrix Cloud. Stringa EnvironmentAmbiente Production, ProductionGov o ProductionJP. Enumerazione LogFileNameModifica il prefisso del file di log da CitrixLog a qualcos’altro. Stringa -
StopOnErrorInterrompe l’operazione al primo errore. TargetFolderUtilizza la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig. LocaleUtilizza le impostazioni locali specificate invece di quelle derivate dal sistema su cui viene eseguito lo strumento.
-
-
EditorUtilizza l’editor specificato per visualizzare il log al completamento di ogni cmdlet. Notepad.exe è l’editor predefinito. Questo parametro deve includere la specifica del file completa per l’editor e l’editor deve accettare la specifica del file di log come unico parametro. SecurityCsvFileSpecLa specifica del file completa che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. CustomerIddeve essere specificato quando si utilizza questo parametro.Valori restituiti:
- Vedere Valori restituiti dai cmdlet
Parametri correlati ai prerequisiti
-
Insieme ai parametri di accesso al cloud, i seguenti parametri possono essere utilizzati con i cmdlet correlati ai prerequisiti:
-
Environment– Ambiente Production o ProductionGov. -
LogFileName– Modifica il prefisso del file di log da CitrixLog a qualcos’altro. -
StopOnError– Interrompe l’operazione al primo errore. -
AlternateRootFolder– Utilizza la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig. -
Locale– utilizza le impostazioni locali specificate invece di quelle derivate dal sistema su cui viene eseguito lo strumento. -
Editor– utilizza l’editor specificato per visualizzare il log al completamento di ogni cmdlet. Notepad.exe è l’editor predefinito. Questo parametro deve includere la specifica del file completa per l’editor e l’editor deve accettare la specifica del file di log come unico parametro. -
Cmdlet di supporto e risoluzione dei problemi
-
New-CvadAcZipInfoForSupport- Comprime tutti i file di log e .yml in un unico file zip da inviare a Citrix per il supporto. Le informazioni sensibili del cliente (CustomerInfo.yml e CvadAcSecurity.yml) non sono incluse nello zip. Anche il file Icon.yml è escluso a causa delle sue dimensioni. Il file zip viene posizionato in %HOMEPATH%\Documents\Citrix\AutoConfig e denominato CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip, in base alla data e all’ora. Questo file zip può anche fungere da backup.- Parametri:
Nome Descrizione Obbligatorio? Tipo - |—-|—-|—-|—-|
-
TargetFolderSpecifica una cartella di destinazione per creare e salvare il file zip. -
QuietElimina la registrazione nella console. -
Valori restituiti:
- Il file zip con il nome e la posizione del file zip viene visualizzato nel prompt dei comandi.
-
Get-CvadAcStatus- Utilizzare per testare la connettività e assicurarsi che tutti i prerequisiti siano soddisfatti. Restituisce informazioni sullo strumento, come il numero di versione e la connettività con il cloud e lo stato del connettore. -
Parametri:
-
Nome Descrizione Obbligatorio? Tipo - |—-|—-|—-|—-|
-
Parametri di accesso al cloud Vedere Parametri di accesso al cloud -
SiteIdIdentifica il sito a cui connettersi. -
AdminAddressQuesto è l’indirizzo DNS o IP del Delivery Controller locale utilizzato per verificare il livello di accesso degli amministratori. Questo è richiesto se lo strumento non viene eseguito su un Delivery Controller. -
Restituisce:
- Visualizza i risultati per ogni elemento.
-
Test-CvadAcConnectionWithSite– Testa la connessione con il sito cloud per verificare che la connessione di comunicazione funzioni. Questo cmdlet utilizza i parametri di accesso al cloud o il file CustomerInfo.yml per specificare le informazioni di connessione del cliente. -
Parametri:
-
Nome Descrizione Obbligatorio? Tipo Parametri di accesso al cloud Vedere Parametri di accesso al cloud SwitchParameters QuietElimina la registrazione nella console. SwitchParameter Restituisce:
- I risultati del test vengono visualizzati sulla riga di comando.
-
Find-CvadAcConnector- Individua i connettori esistenti e ne determina lo stato di esecuzione. Questo cmdlet utilizza le informazioni del file CustomerInfo.yml o il parametro ID cliente per individuare i connettori del cliente.Parametri:
-
Nome Descrizione Obbligatorio? Tipo - |–|–|–|–|
-
CustomerInfoFileSpecLa specifica del file che punta a un file di informazioni del cliente per sovrascrivere la posizione e il nome predefiniti. Questo parametro viene ignorato quando viene fornito il parametro CustomerId. -
CustomerIdL’ID del cliente. Questo parametro sovrascrive lo stesso valore nel file CustomerInfo.yml. -
Restituisce:
- I risultati vengono visualizzati sulla riga di comando.
-
Get-CvadAcCustomerSites- Restituisce l’elenco di tutti i siti del cliente. Questo cmdlet utilizza i parametri di accesso al cloud o il file CustomerInfo.yml per specificare le informazioni di connessione del cliente.Parametri:
Restituisce:
- Visualizza un elenco degli ID dei siti cliente trovati.
-
New-CvadAcTemplateToFile– Crea un file modello per i componenti selezionati, consentendo di creare manualmente un file di importazione.Parametri:
Nome Descrizione Obbligatorio? Tipo Migra per componenti Vedere Migra per componenti SwitchParameters TargetFolderSpecifica la cartella di destinazione dell’esportazione. String Restituisce:
- Vedere Valori restituiti del cmdlet
-
Show-CvadAcDocument- Visualizza questa documentazione nel browser predefinito.Parametri:
- Nessuno.
Restituisce:
- Visualizza questa pagina web nel browser web predefinito.
-
Find-CvadAcInFile- La funzione “Trova nel file” cerca nei file YAML dei componenti i membri che corrispondono a uno o più nomi che possono contenere caratteri jolly. Il risultato è un rapporto dei membri trovati. La funzione “Trova nel file” può cercare un solo componente alla volta. La funzione “Trova nel file” cerca in tutti i file YAML nella cartella corrente e in tutte le sottocartelle. UtilizzareFindSourceFolderper limitare il numero di file da cercare.Parametri:
Nome Descrizione Obbligatorio? Tipo Migrazione per componenti Vedere Migrazione per componenti. Nota: il valore -Allnon è valido.SwitchParameters IncludeByNameUn elenco che specifica i nomi dei gruppi di consegna da includere quando si imposta lo stato attivo del sito su attivo. I caratteri jolly ‘*’ e ‘?’ sono supportati nei nomi. Elenco di stringhe UniqueRiporta solo i membri trovati unici. SwitchParameter IncludeYamlIncludi lo YAML specifico del membro. SwitchParameter FindSourceFolderLa cartella in cui inizia la ricerca. Stringa DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper sopprimere la visualizzazione del log.SwitchParameter QuietSopprime la registrazione nella console. SwitchParameter Restituisce:
- Crea un rapporto contenente i membri trovati per il componente specificato.
Cmdlet di attivazione del sito
Per maggiori informazioni sull’attivazione dei siti e sull’utilizzo di questi cmdlet, vedere Attivazione dei siti.
-
Set-CvadAcSiteActiveStateOnPrem- Imposta lo stato del sito on-premise su attivo o inattivo.Parametri:
Nome Descrizione Obbligatorio? Tipo Parametri di accesso al cloud Vedere Parametri di accesso al cloud SwitchParameters SiteActiveSe presente, imposta il sito on-premise su attivo, rimuovendo la modalità di manutenzione da tutti i gruppi di consegna. Se questo parametro non è presente, la modalità di manutenzione viene impostata su tutti i gruppi di consegna. SwitchParameter IncludeByNameUn elenco che specifica i nomi dei gruppi di consegna da includere quando si imposta lo stato attivo del sito su attivo. I caratteri jolly ‘*’ e ‘?’ sono supportati nei nomi. Elenco di stringhe ExcludeByNameUn elenco che specifica i nomi dei gruppi di consegna da escludere quando si imposta lo stato attivo del sito su attivo. I caratteri jolly ‘*’ e ‘?’ sono supportati nei nomi. Elenco di stringhe QuietSopprime la registrazione nella console. SwitchParameter DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper sopprimere la visualizzazione del log.$true o $falseRestituisce:
- Vedere Valori restituiti dal cmdlet
-
Set-CvadAcSiteActiveStateCloud- Imposta lo stato del sito cloud su attivo o inattivo.Parametri:
Nome Descrizione Obbligatorio? Tipo Parametri di accesso al cloud Vedere Parametri di accesso al cloud SwitchParameters SiteActiveSe presente, imposta il sito cloud su attivo, rimuovendo la modalità di manutenzione da tutti i gruppi di consegna. Se questo parametro non è presente, la modalità di manutenzione viene impostata su tutti i gruppi di consegna. SwitchParameter IncludeByNameUn elenco che specifica i nomi dei gruppi di consegna da includere quando si imposta lo stato attivo del sito su attivo. I caratteri jolly ‘*’ e ‘?’ sono supportati nei nomi. Elenco di stringhe ExcludeByNameUn elenco che specifica i nomi dei gruppi di consegna da escludere quando si imposta lo stato attivo del sito su attivo. I caratteri jolly ‘*’ e ‘?’ sono supportati nei nomi. Elenco di stringhe QuietSopprime la registrazione nella console. SwitchParameter DisplayLogVisualizza il file di log al completamento del cmdlet. Impostare su $falseper sopprimere la visualizzazione del log.$true o $falseRestituisce:
- Vedere Valori restituiti dal cmdlet
Cmdlet per l’unione di più siti on-premise
Per maggiori informazioni sull’unione dei siti e sull’utilizzo di questi cmdlet, vedere Unire più siti in un unico sito.
-
New-CvadAcSiteMergingInfo- Crea un set di informazioni sui prefissi/suffissi per l’unione dei siti. Non è necessario conoscere tutti i prefissi o i suffissi all’inizio. Possono essere aggiornati conSet-CvadAcSiteMergingInfoo modificando manualmente il file SiteMerging.yml. Parametri:Nome Descrizione Obbligatorio? Tipo SiteNameIl nome utilizzato per identificare il set di prefissi/suffissi per un sito specifico. Può corrispondere al nome del sito effettivo, ma non è obbligatorio. x Stringa Parametri di unione del sito Vedere Parametri di unione del sito SwitchParameters QuietSopprime la registrazione nella console. SwitchParameter Restituisce:
- Nessuno
-
Set-CvadAcSiteMergingInfo- Aggiorna un set di informazioni esistente per prefissi/suffissi di unione di siti.Parametri:
Nome Descrizione Obbligatorio? Tipo SiteNameIl nome utilizzato per identificare il set di prefissi/suffissi per un sito specifico. Può corrispondere al nome del sito effettivo, ma non è obbligatorio. x Stringa Parametri di unione siti Vedere Parametri di unione siti SwitchParameters QuietSopprime la registrazione sulla console. SwitchParameter Restituisce:
- Nessuno
-
Remove-CvadAcSiteMergingInfo- Rimuove un set di informazioni esistente per prefissi/suffissi di unione di siti.Parametri:
-
SiteName– identifica il set di prefissi e suffissi del sito. È una stringa ed è obbligatorio.
Restituisce:
- Nessuno
-
Parametri di unione siti
I seguenti parametri possono essere utilizzati durante l’esecuzione dei cmdlet di unione siti. Tutti i parametri elencati sono stringhe.
-
SiteName– il nome utilizzato per identificare il set di prefissi/suffissi per un sito specifico. Può corrispondere al nome del sito effettivo, ma non è obbligatorio.SiteNameè un parametro obbligatorio. -
AdminScopedPrefix– il prefisso da applicare agli ambiti amministrativi. -
ApplicationPrefix- il prefisso da applicare alle applicazioni. -
ApplicationFolderPrefix– il prefisso da applicare alle cartelle delle applicazioni;ApplicationFolderPrefixpuò essere combinato conApplicationFolderRoot. -
ApplicationFolderRoot– la nuova cartella radice per le cartelle delle applicazioni. Questo crea una gerarchia di cartelle aggiuntiva.ApplicationFolderRootpuò essere combinato conApplicationFolderPrefix. -
ApplicationGroupPrefix– il prefisso per i gruppi di applicazioni. -
ApplicationUserPrefix– il prefisso da applicare al nome dell’applicazione visualizzato dall’utente. -
ApplicationAdminPrefix– il prefisso da applicare al nome dell’applicazione visualizzato dall’amministratore. -
DeliveryGroupPrefix– il prefisso da applicare ai gruppi di consegna. -
GroupPolicyPrefix– il prefisso da applicare ai nomi dei criteri. -
HostConnectionPrefix– il prefisso da applicare alle connessioni host. -
MachineCatalogPrefix– il prefisso da applicare ai cataloghi di macchine. -
StoreFrontPrefix– il prefisso da applicare ai nomi StoreFront™. -
TagPrefix– il prefisso da applicare ai tag. -
AdminScopedSuffix– il suffisso da applicare agli ambiti amministrativi. -
ApplicationSuffix- il suffisso da applicare alle applicazioni. -
ApplicationFolderSuffix– il suffisso da applicare alle cartelle delle applicazioni;ApplicationFolderSuffixpuò essere combinato conApplicationFolderRoot. -
ApplicationGroupSuffix– il suffisso per i gruppi di applicazioni. -
ApplicationUserSuffix– il suffisso da applicare al nome dell’applicazione visualizzato dall’utente. -
ApplicationAdminSuffix– il suffisso da applicare al nome dell’applicazione visualizzato dall’amministratore. -
DeliveryGroupSuffix– il suffisso da applicare ai gruppi di consegna. -
GroupPolicySuffix– il suffisso da applicare ai nomi dei criteri. -
HostConnectionSuffix– il suffisso da applicare alle connessioni host. -
MachineCatalogSuffix– il suffisso da applicare ai cataloghi di macchine. -
StoreFrontSuffix– il suffisso da applicare ai nomi StoreFront. -
TagSuffix– il suffisso da applicare ai tag. -
SiteRootFolder– il nome della cartella completo da utilizzare per esportazioni e importazioni; può essere una cartella locale o una condivisione di file.
Parametri generici
Parametri di accesso al cloud
Tutti i cmdlet che accedono al cloud supportano i seguenti parametri aggiuntivi.
Nota:
CustomerId,ClientIdeSecretpossono essere inseriti nel fileCustomerInfo.ymlo specificati con il cmdlet utilizzando i seguenti parametri. Se specificati in entrambi i posti, i parametri del cmdlet hanno la precedenza.
-
CustomerId– L’ID cliente utilizzato nelle API Rest ed è obbligatorio per accedere a tutte le API Rest. L’ID cliente si trova in Citrix Cloud. -
ClientId– L’ID client creato sul sito web di Citrix Cloud Identity and Access Management. Questo è obbligatorio per ottenere il token bearer necessario per l’autenticazione per tutte le API Rest. -
Secret– La chiave segreta creata sul sito web di Citrix Cloud Identity and Access Management. Questo è obbligatorio per ottenere il token bearer necessario per l’autenticazione per tutte le API Rest. -
CustomerInfoFileSpec– La specifica del file che punta a un file di informazioni del cliente per sovrascrivere la posizione e il nome predefiniti.
Parametri della modalità di migrazione
I cmdlet che modificano la configurazione del sito cloud (Import, Restore, Merge, New e Sync) supportano i seguenti parametri aggiuntivi per fornire ulteriore flessibilità.
-
CheckMode– Esegue l’operazione di importazione ma non apporta modifiche. Tutte le modifiche previste vengono segnalate prima del completamento dell’importazione. È possibile utilizzare questo comando per testare l’importazione prima che avvenga. -
BackupFirst– Esegue il backup dei contenuti del cloud in file .yml prima di modificare la configurazione del cloud. Questa opzione è abilitata per impostazione predefinita. -
Confirm– Setrue, chiede agli utenti di confermare che desiderano apportare modifiche alla configurazione del sito cloud. Il cmdletRemovemostra una richiesta a causa della sua natura distruttiva. Impostare sufalsese non si desidera alcuna richiesta, ad esempio quando si esegue all’interno di script automatizzati.Confirmè impostato sutrueper impostazione predefinita. -
SecurityFileFolder– Questa è la cartella completa contenente il fileCustomerInfo.ymlche potrebbe puntare a una cartella locale o a una cartella di condivisione di rete che potrebbe essere sotto controllo di autenticazione. Lo strumento non richiederà le credenziali; l’accesso alla risorsa controllata deve essere ottenuto prima di eseguire lo strumento. -
SiteName– Specifica il set di prefissi e suffissi di unione del sito da utilizzare durante l’importazione. -
SiteActive– Specifica se il sito importato è attivo o inattivo. Per impostazione predefinita, questo parametro è impostato su$false, il che significa che il sito importato è inattivo.
Parametri di visualizzazione del log
I cmdlet Export, Import, Sync, Restore, Backup, Compare e Remove visualizzano il file di log al completamento dell’operazione. È possibile sopprimere la visualizzazione impostando il parametro -DisplayLog su $false. Notepad.exe viene utilizzato per impostazione predefinita per visualizzare il file di log. È possibile specificare un editor diverso nel file CustomerInfo.yml.
Editor: C:\Program Files\Notepad++\notepad++.exe
Valori restituiti dei cmdlet
ActionResult
Tutti i cmdlet restituiscono il seguente valore.
public class ActionResult
{
public bool Overall_Success;
public Dictionary<string, string> Individual_Success;
public object CustomResult;
}
Overall_Success restituisce un singolo valore booleano che indica il successo complessivo del cmdlet su tutti i componenti selezionati: true significa successo e false significa insuccesso.
Individual_Success restituisce uno o tre valori per ogni componente principale. Il risultato di un componente può essere Successo, Errore o Ignorato. Ignorato indica che il componente non è stato selezionato per l’esecuzione da parte del cmdlet.
CustomResult è specifico del cmdlet.
CustomResult
I cmdlet Import, Merge, Restore, Sync, Compare, Compare File e Remove restituiscono le seguenti informazioni sui risultati personalizzati a una singola istanza di EvaluationResultData.
Nota:
I cmdlet
ExporteTemplatenon restituiscono un risultato personalizzato.
public class EvaluationResultData
{
public Dictionary<string, Dictionary<string, ActionResultValues >> EvaluationResults;
public int Added;
public int Updated;
public int Deleted;
public int NoChange;
public int TotalChanged;
public EvaluationResults OverallResult;
public string CloudBackupFolder;
public string SourceBackupFolder;
}
Dove:
public enum ActionResultValues
{
Add,
Update,
Delete,
Identical,
DoNothing
}
public enum EvaluationResults
{
Success,
Failure,
Skipped
}
EvaluationResults visualizza un elenco con una voce per ogni componente selezionato. La chiave è il nome del componente e il valore è un elenco di ogni membro del componente e l’azione intrapresa su quel membro del componente. Le azioni possono essere uno qualsiasi dei valori di ActionResultValues.
Added, Updated, Deleted e NoChange indicano il numero totale di membri del componente aggiunti, aggiornati, eliminati o per i quali non è stata intrapresa alcuna azione, in quest’ordine.
TotalChanged è la somma di Added, Updated e Deleted.
OverallResult è un singolo valore booleano che indica il risultato del cmdlet. True indica il successo totale su tutti i componenti e false indica il fallimento nell’elaborazione di uno o più componenti.
CloudBackupFolder è la specifica del file completamente qualificata del backup della configurazione del sito cloud prima che il cmdlet esegua qualsiasi azione di modifica del cloud.
SourceBackupFolder è la specifica del file completamente qualificata del backup del file sorgente effettuato dopo il completamento del cmdlet. Per impostazione predefinita, questi file si trovano in %HOMEPATH%\Documents\Citrix\AutoConfig.
Guida di PowerShell
La guida di PowerShell è disponibile per ogni cmdlet. Tutti i parametri sono documentati con ogni cmdlet, insieme a una breve spiegazione del cmdlet. Per accedere alla guida per qualsiasi cmdlet, digitare Get-Help prima del cmdlet.
Get-Help Import-CvadAcToSite