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: $true o $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.

Per maggiori informazioni sui parametri e su come utilizzarli, vedere Parametri di migrazione granulare.

Cmdlet di base

Cmdlet da on-premise a cloud

• Export-CvadAcToFile - Esporta i file on-premise in file YAML.

  Esporta la configurazione dalla configurazione on-premise. Questa è l’operazione di esportazione predefinita per la configurazione automatica. Non vengono apportate modifiche alla configurazione del sito on-premise. 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-premise esportata.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migra per componenti	Vedere Migra per componenti		SwitchParameters
  Filtro per nomi di oggetti	Vedere Filtrare per nomi di oggetti		Elenco di stringhe
  TargetFolder	Specifica la cartella di destinazione dell’esportazione.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  AdminAddress	Specifica l’indirizzo DNS o IP del Delivery Controller quando l’esportazione non viene eseguita sul Delivery Controller.		Stringa
  CheckUserAndMachines	Verifica se utenti e macchine sono in Active Directory. Utenti e macchine che non sono in Active Directory potrebbero causare errori di importazione.		$true o $false
  ZipResults	Comprime 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

  Restituisce:

  • Vedere Valori restituiti del cmdlet

Esistono tre modi per importare dati nel cloud. L’esecuzione di cmdlet specifici può portare a una delle tre combinazioni di azioni sul sito cloud:

• Aggiungi, Aggiorna ed Elimina
• Solo Aggiungi e Aggiorna
• Solo Aggiungi

• Import-CvadAcToSite - Importa file YAML nel cloud. Supporta operazioni di creazione, aggiornamento ed eliminazione.

  Importa tutti i file locali nel cloud. Questo comando garantisce che lo stato finale del cloud sia identico allo stato locale. Questa opzione elimina tutte le modifiche esistenti nel cloud. I file di configurazione del sito importati provengono da %HOMEPATH%\Documents\Citrix\AutoConfig. Usare con cautela.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione 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
  SourceFolder	Identifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di registro al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del registro.		$true o $false
  Merge	Se impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su $false per rimuovere i componenti.		$true o $false
  AddOnly	Se impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina i componenti esistenti. Impostare su $false per consentire aggiornamenti ed eliminazioni. Merge viene ignorato quando questo parametro è $true.		$true o $false
  MergePolicies	Unire 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 quando si verificano conflitti tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter
  OnErrorAction	Vedere parametro OnErrorAction.		String

  Restituisce:

  • Vedere valori restituiti del 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
  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
  SourceFolder	Identifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log.		$true o $false
  Merge	Se impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su $false per rimuovere i componenti.		$true o $false
  AddOnly	Se impostato su $true, aggiunge solo nuovi componenti, non aggiorna né elimina i componenti esistenti. Impostare su $false per consentire aggiornamenti ed eliminazioni. Merge viene ignorato quando questo parametro è $true.		$true o $false
  MergePolicies	Unisce 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 quando si verificano collisioni tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter
  OnErrorAction	Vedere parametro OnErrorAction.		Stringa

  Restituisce:

  • Vedere Valori restituiti del cmdlet

• New-CvadAcToSite - Importa file YAML nel cloud. Supporta operazioni di creazione e aggiornamento.

  Importa la configurazione del sito on-premise 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
  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
  SourceFolder	Identifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di registro al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del registro.		$true o $false
  OnErrorAction	Vedere OnErrorAction parameter.		Stringa

  Restituisce:

  • Vedere Cmdlet return values

• Sync-CvadAcToSite - Esporta e importa in un unico passaggio.

  La sincronizzazione esegue sia un’esportazione che un’importazione in un unico passaggio. Utilizzare il parametro SourceTargetFolder per specificare la cartella di destinazione dell’esportazione/importazione.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migra per componenti	Vedere Migrate by components		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
  SourceTargetFolder	Specifica la cartella di destinazione per l’esportazione/importazione.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  AdminAddress	Specifica l’indirizzo DNS o IP del delivery controller quando l’esportazione non viene eseguita sul delivery controller.		Stringa
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di registro al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del registro.		$true o $false
  Merge	Se impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su $false per rimuovere i componenti.		$true o $false
  AddOnly	Se impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina componenti esistenti. Impostare su $false per consentire aggiornamenti ed eliminazioni. Merge viene ignorato quando questo parametro è $true.		$true o $false
  MergePolicies	Unire 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 quando si verificano collisioni tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter

  Restituisce:

  • Vedere Valori restituiti del cmdlet

Cmdlet da cloud a cloud

• Backup-CvadAcToFile - Esegue il backup di tutta la configurazione dal sito cloud.

  Esporta la configurazione 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
  Migra per componenti	Vedere Migra per componenti		SwitchParameters
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud		SwitchParameters
  TargetFolder	Specifica la cartella di destinazione dell’esportazione.		String
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		String
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del log.		$true o $false
  ZipResults	Comprime i file YAML di backup in un singolo file zip. Il file si trova nella stessa cartella dei file YAML di cui è stato eseguito il backup e ha lo stesso nome della cartella.		SwitchParameter

  Restituisce:

  • Vedere Valori restituiti del cmdlet

• Restore-CvadAcToSite - Ripristina i file YAML di backup nel sito cloud. Questo sito cloud può essere uguale 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.		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
  RestoreFolder	Identifica la cartella contenente i file .yml da ripristinare nel sito cloud. Deve essere una specifica di cartella completa.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  Quiet	Sopprimi la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log.		$true o $false
  Merge	Se impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su $false per rimuovere i componenti.		$true o $false
  AddOnly	Se impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina i componenti esistenti. Impostare su $false per consentire aggiornamenti ed eliminazioni. Merge viene ignorato quando questo parametro è $true.		$true o $false
  MergePolicies	Unire 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 quando si verificano collisioni tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter
  OnErrorAction	Vedere parametro OnErrorAction.		String

  Restituisce:

  • Vedere Valori restituiti del cmdlet

• Remove-CvadAcFromSite – Rimuovere i membri del componente dal cloud.

  Può reimpostare l’intero sito o rimuovere elementi membro da un componente (Ad esempio, rimuovendo un catalogo macchine dall’elenco dei cataloghi). Questo può essere utilizzato in combinazione con il parametro IncludeByName per rimuovere selettivamente membri specifici.

  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
  Quiet	Sopprime la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di registro al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del registro.		$true o $false

  Restituisce:

  • Vedere Valori restituiti del cmdlet

Altri cmdlet di base

• Compare-CvadAcToSite - Confronta i file .yml locali con la configurazione cloud, producendo un rapporto delle modifiche apportate da un cmdlet Import, Merge o Restore.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione 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
  SourceFolder	Identifica una cartella radice sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo leggibile dall’uomo che può essere esportato.		Stringa
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del log.		$true o $false
  Merge	Se impostato su $true, aggiunge solo componenti al sito cloud. I componenti non vengono rimossi. Impostare su $false per rimuovere i componenti.		$true o $false
  AddOnly	Se impostato su $true, aggiunge solo nuovi componenti, non aggiorna o elimina i componenti esistenti. Impostare su $false per consentire aggiornamenti ed eliminazioni. Merge viene ignorato quando questo parametro è $true.		$true o $false
  OnErrorAction	Vedere parametro OnErrorAction.		Stringa

  Restituisce:

  • Vedere Valori restituiti dal 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:

• All
• Tags
• AdminRoles
• AdminScopes
• HostConnections
• MachineCatalogs
• StoreFronts
• DeliveryGroups
• ApplicationGroups
• ApplicationFolders
• Applications
• GroupPolicies
• UserZonePreference

Filtro per nomi di oggetti

Migrazione per nomi di componenti

I parametri IncludeByName e ExcludeByName consentono di includere ed escludere i membri dei componenti nei cmdlet per nome. È possibile scegliere un solo componente (ad esempio, i gruppi di distribuzione) alla volta in uno qualsiasi dei cmdlet supportati. Se un membro del componente si trova in entrambe le aree, l’esclusione ha la precedenza su qualsiasi altro parametro e viene creata una voce nell’elenco di correzione del log che identifica il componente e il nome del membro escluso.

IncludeByName e ExcludeByName accettano un elenco di nomi di membri del componente. 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 quando un nome di membro contiene caratteri speciali.

• * Corrisponde a un numero qualsiasi di caratteri
• ? Corrisponde a un singolo carattere

IncludeByName e ExcludeByName possono anche accettare un file contenente un elenco di membri, dove ogni membro può essere esplicito o contenere caratteri jolly. Ogni riga nel 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 distribuzione i cui nomi iniziano con DgSite1 e contengono Home2 sarebbe scritto:

Merge-CvadAcToSite –DeliveryGroups –IncludeByName DgSite1*,*Home2*

Per nome del gruppo di distribuzione

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 un numero qualsiasi 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 esclude dalle operazioni di importazione tutte le applicazioni e i gruppi di applicazioni disabilitati. ExcludeDisabled è impostato per impostazione predefinita su false, il che significa che tutte le applicazioni e i gruppi di applicazioni vengono importati indipendentemente dal loro stato abilitato.

Per nome macchina

ByMachineName filtra per nome macchina per cataloghi 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 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 un numero qualsiasi di caratteri
• ? corrisponde a un singolo carattere

Quando si esporta o si importa e si utilizza ByMachineName e un filtro per nome macchina non produce macchine nel catalogo macchine o nel gruppo di consegna, il catalogo macchine o il gruppo di consegna viene escluso dall’esportazione o dall’importazione.

Nota:

L’uso di ByMachineName in qualsiasi cmdlet di tipo importazione comporta l’impostazione di MergeMachines su $true.

Unisci macchine

MergeMachines, quando impostato su $true, indica all’operazione di importazione di aggiungere macchine solo al catalogo 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 file .yml del catalogo macchine o del gruppo di consegna. MergeMachines è impostato su $true quando viene utilizzato ByMachineName, ma può essere sovrascritto impostando MergeMachines su false.

Cmdlet relativi 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
  CustomerId	ID cliente.	x	Stringa
  ClientId	ID client del cliente creato su Citrix Cloud. CustomerId e Secret devono essere specificati quando si utilizza questo parametro.	Condizionalmente	Stringa
  Secret	Chiave segreta del cliente creata su Citrix Cloud. CustomerId e ClientId devono essere specificati quando si utilizza questo parametro.	Condizionalmente	Stringa
  Environment	Ambiente Production, ProductionGov o ProductionJP.		Enumerazione
  LogFileName	Modificare il prefisso del file di log da CitrixLog a qualcos’altro.		Stringa
  AltRootUrl	Utilizzare solo sotto la direzione di Citrix.		Stringa
  StopOnError	Interrompe l’operazione al primo errore.		$true o $false
  TargetFolder	Utilizzare la cartella specificata come cartella radice anziché %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Utilizzare la lingua specificata anziché quella derivata dal sistema su cui viene eseguito lo strumento.		Stringa
  Editor	Utilizzare 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 dell’editor e l’editor deve accettare la specifica del file di log come unico parametro.		Stringa
  SecurityCsvFileSpec	La specifica del file completa che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. Il CustomerId deve essere specificato quando si utilizza questo parametro.		Stringa

  Restituisce:

  • Vedere Valori restituiti del cmdlet

• Set-CvadAcCustomerInfoFile - Aggiorna un file di informazioni 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
  CustomerId	ID del cliente.		Stringa
  ClientId	ID client del cliente creato su Citrix Cloud.		Stringa
  Secret	Chiave segreta del cliente creata su Citrix Cloud.		Stringa
  Environment	Ambiente Production, ProductionGov o ProductionJP.		Enumerazione
  LogFileName	Modifica il prefisso del file di log da CitrixLog a qualcos’altro.		Stringa
  StopOnError	Interrompe l’operazione al primo errore.		$true o $false
  TargetFolder	Usa la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Utilizzare le impostazioni locali specificate invece di quelle derivate dal sistema su cui viene eseguito lo strumento.		Stringa
  Editor	Utilizzare 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.		Stringa
  SecurityCsvFileSpec	La specifica del file completa che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. Il CustomerId deve essere specificato quando si utilizza questo parametro.		Stringa

  Restituisce:

  • Vedere Valori restituiti del cmdlet

Parametri relativi ai prerequisiti

Insieme ai parametri di accesso al cloud, i seguenti parametri possono essere utilizzati con i cmdlet relativi 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 – Usa la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig.
• Locale – usa il locale specificato invece del locale derivato dal sistema su cui viene eseguito lo strumento.
• Editor – usa 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 nel file zip. Il file Icon.yml è anch’esso 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
  TargetFolder	Specifica una cartella di destinazione in cui creare e salvare il file zip.		Stringa
  Quiet	Sopprimi la registrazione nella console.		SwitchParameter

  Restituisce:

  • 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 per 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		SwitchParameters
  SiteId	Identifica il sito a cui connettersi.		Stringa
  AdminAddress	Questo è l’indirizzo DNS o IP del Delivery Controller on-premise utilizzato per verificare il livello di accesso degli amministratori. È richiesto se lo strumento non viene eseguito su un Delivery Controller.		Stringa

  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
  Quiet	Elimina 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
  CustomerInfoFileSpec	La 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.		Stringa
  CustomerId	L’ID del cliente. Questo parametro sovrascrive lo stesso valore nel file CustomerInfo.yml.		Stringa

  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:

  • Vedere Parametri di accesso al cloud

  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
  TargetFolder	Specifica la cartella di destinazione dell’esportazione.		Stringa

  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 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 tutti i file YAML nella cartella corrente e in tutte le sottocartelle. Utilizzare FindSourceFolder per limitare il numero di file da cercare.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Esegui la migrazione per componenti	Vedere Esegui la migrazione per componenti. Nota: Il valore -All non è valido.		SwitchParameters
  IncludeByName	Un 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
  Unique	Riporta solo i membri trovati unici.		SwitchParameter
  IncludeYaml	Includere il YAML specifico del membro.		SwitchParameter
  FindSourceFolder	La cartella in cui la ricerca inizia.		String
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log.		SwitchParameter
  Quiet	Sopprime la registrazione nella console.		SwitchParameter

  Restituisce:

  • Crea un report 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 locale su attivo o inattivo.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud		SwitchParameters
  SiteActive	Quando presente, imposta il sito locale su attivo rimuovendo la modalità di manutenzione da tutti i gruppi di consegna. Quando questo parametro non è presente, la modalità di manutenzione viene impostata su tutti i gruppi di consegna.		SwitchParameter
  IncludeByName	Un 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
  ExcludeByName	Un 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
  Quiet	Elimina la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di registro al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del registro.		$true or $false

  Restituisce:

  • 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
  SiteActive	Quando presente, imposta il sito cloud come attivo, rimuovendo la modalità di manutenzione da tutti i gruppi di consegna. Quando questo parametro non è presente, la modalità di manutenzione viene impostata su tutti i gruppi di consegna.		SwitchParameter
  IncludeByName	Un 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
  ExcludeByName	Un 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
  Quiet	Sopprimi la registrazione nella console.		SwitchParameter
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log.		$true or $false

  Restituisce:

  • Vedere Valori restituiti del cmdlet

Cmdlet per l’unione di più siti locali

Per maggiori informazioni sull’unione di siti e sull’utilizzo di questi cmdlet, vedere Unire più siti in un singolo sito.

• New-CvadAcSiteMergingInfo - Crea un set di informazioni su prefissi/suffissi per l’unione di siti. Non è necessario conoscere tutti i prefissi o i suffissi all’inizio. Possono essere aggiornati con Set-CvadAcSiteMergingInfo o modificando manualmente il file SiteMerging.yml. Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  SiteName	Il nome utilizzato per identificare l’insieme 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
  Quiet	Elimina la registrazione nella console.		SwitchParameter

  Restituisce:

  • Nessuno

• Set-CvadAcSiteMergingInfo - Aggiorna un set di informazioni esistente per prefissi/suffissi di unione del sito.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  SiteName	Il nome utilizzato per identificare l’insieme 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
  Quiet	Elimina la registrazione nella console.		SwitchParameter

  Restituisce:

  • Nessuno

• Remove-CvadAcSiteMergingInfo - Rimuove un set di informazioni esistente per prefissi/suffissi di unione del sito.

  Parametri:

  • SiteName – identifica l’insieme di prefissi e suffissi del sito. Si tratta di una stringa ed è obbligatorio.

  Restituisce:

  • Nessuno

Parametri di unione del sito

I seguenti parametri possono essere utilizzati durante l’esecuzione dei cmdlet di unione del sito. Tutti i parametri elencati sono stringhe.

• SiteName – il nome utilizzato per identificare l’insieme 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 dell’amministratore.
• ApplicationPrefix - il prefisso da applicare alle applicazioni.
• ApplicationFolderPrefix – il prefisso da applicare alle cartelle delle applicazioni; ApplicationFolderPrefix può essere combinato con ApplicationFolderRoot.
• ApplicationFolderRoot – la nuova cartella radice per le cartelle delle applicazioni. Questo crea una gerarchia di cartelle aggiuntiva. ApplicationFolderRoot può essere combinato con ApplicationFolderPrefix.
• 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 dell’amministratore.
• ApplicationSuffix - il suffisso da applicare alle applicazioni.
• ApplicationFolderSuffix – il suffisso da applicare alle cartelle delle applicazioni; ApplicationFolderSuffix può essere combinato con ApplicationFolderRoot.
• 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 di StoreFront.
• TagSuffix – il suffisso da applicare ai tag.
• SiteRootFolder – il nome completo della cartella da utilizzare per le esportazioni e le 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, ClientId e Secret possono essere inseriti nel file CustomerInfo.yml o specificati con il cmdlet utilizzando i seguenti parametri. Quando sono specificati in entrambi i posti, i parametri del cmdlet hanno la precedenza.

• CustomerId – L’ID cliente utilizzato nelle API REST e necessario 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 è necessario per ottenere il token di portatore richiesto per l’autenticazione per tutte le API REST.
• Secret – La chiave segreta creata sul sito web di Citrix Cloud Identity and Access Management. Questo è necessario per ottenere il token di portatore richiesto 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 maggiore 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 – Se true, chiede agli utenti di confermare che desiderano apportare modifiche alla configurazione del sito cloud. Il cmdlet Remove mostra un prompt a causa della sua natura distruttiva. Impostare su false se non si desidera alcun prompt, ad esempio durante l’esecuzione all’interno di script automatizzati. Confirm è impostato su true per impostazione predefinita.
• SecurityFileFolder – Questa è la cartella completa contenente il file CustomerInfo.yml che 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 prefisso e il suffisso 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 dal 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 riuscito e false significa non riuscito.

Individual_Success restituisce uno o tre valori per ogni componente principale. Il risultato di un componente può essere Successo, Errore o Saltato. Saltato indica che il componente non è stato selezionato per l’esecuzione dal cmdlet.

CustomResult è specifico del cmdlet.

CustomResult

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 Export e Template non 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;
                }
                Where:
                public enum ActionResultValues
               {
                    Add,
                    Update,
                    Delete,
                    Identical,
                    DoNothing
                }
                public enum EvaluationResults
                {
                    Success,
                    Failure,
                    Skipped
                }

EvaluationResults visualizza un elenco con una voce per componente selezionato. La chiave è il nome del componente e il valore è un elenco di ciascun membro del componente e l’azione intrapresa su tale membro del componente. Le azioni possono essere uno qualsiasi dei valori 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 un errore 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 di origine 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 davanti al cmdlet.

Get-Help Import-CvadAcToSite