Cmdlet dello strumento Automated Configuration

Questa pagina elenca tutti i cmdlet e i parametri supportati dallo strumento.

Tutti i cmdlet accettano parametri con uno dei seguenti tipi.

• Stringa
• Elenco di stringhe
• Booleano: $true o $false
• SwitchParameter: presenza del parametro significa $true; assenza del parametro significa $false

Nota:

SwitchParameter è il metodo preferito per le selezioni true o false, ma le variabili booleane sono ancora utilizzate nello strumento a causa di problemi legacy.

La tabella seguente è un riepilogo di tutti i cmdlet. Vedere ogni singola sezione per scoprire quali parametri sono supportati da ciascun cmdlet.

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

Cmdlet di base

Cmdlet da on-premise a cloud

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

  Esporta la configurazione dalla configurazione on-premise. Questa è l’operazione di esportazione predefinita per Automated Configuration. Non vengono apportate modifiche alla configurazione del sito on-premise. I file esportati vengono inseriti nella directory %HOMEPATH%\Documents\Citrix\AutoConfig in una sottocartella dal nome univoco Export (Esporta). La cartella %HOMEPATH%\Documents\Citrix\AutoConfig contiene sempre l’ultima configurazione del sito on-premise esportata.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio per nomi di oggetti		Elenco di stringhe
  TargetFolder	Specifica la cartella di destinazione dell’esportazione.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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 gli utenti e le macchine si trovano in Active Directory. Gli utenti e le macchine che non si trovano in Active Directory potrebbero causare errori di importazione.		$true o $false
  ZipResults	Comprime il backup dei file YAML in un unico 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 dai cmdlet

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

• Add (Aggiungi), Update (Aggiorna) e Delete (Elimina)
• Solo Add (Aggiungi) e Update (Aggiorna)
• Solo Add (Aggiungi)

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

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

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti.		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio per nomi di oggetti.		Elenco di stringhe
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud.		SwitchParameters
  SourceFolder	Identifica una cartella principale sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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 componenti solo 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	Unire impostazioni e filtri dei criteri. L’unione avviene 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 già presenti, in aggiunta a eventuali nuovi filtri e impostazioni importati. Tenere presente che quando si verificano conflitti tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter
  OnErrorAction	Vedere OnErrorAction parameter.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

• Merge-CvadAcToSite - Importare file YAML nel cloud. Supporta operazioni di creazione e aggiornamento.

  Unisce i file on-premise nel cloud, ma non elimina alcun componente nel cloud o nel sito on-premise. In questo modo vengono conservate le modifiche già apportate nel cloud. Se in Citrix Cloud esiste un componente con lo stesso nome, questo comando può modificare quel componente. Questa è l’operazione di importazione predefinita per Automated Configuration. 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.		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio per nomi di oggetti.		Elenco di stringhe
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud.		SwitchParameters
  SourceFolder	Identifica una cartella principale sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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 componenti solo 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	Unire impostazioni e filtri dei criteri. L’unione avviene 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 già presenti, in aggiunta a eventuali nuovi filtri e impostazioni importati. Tenere presente che quando si verificano conflitti tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter
  OnErrorAction	Vedere OnErrorAction parameter.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

• New-CvadAcToSite - Importare 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 esistenti del sito cloud non vengono né aggiornati né eliminati. Utilizzare questo comando se i componenti esistenti del sito cloud devono rimanere invariati.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti.		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio per nomi di oggetti.		Elenco di stringhe
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud.		SwitchParameters
  SourceFolder	Identifica una cartella principale sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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
  OnErrorAction	Vedere OnErrorAction parameter.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

• Sync-CvadAcToSite - Esportare e importare in un unico passaggio.

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

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio 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 umanamente leggibile 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	Eliminare 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 componenti solo 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	Unire impostazioni e filtri dei criteri. L’unione avviene 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 già presenti, in aggiunta a eventuali nuovi filtri e impostazioni importati. Tenere presente che quando si verificano conflitti tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter

  Restituisce:

  • Vedere Valori restituiti dai 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
  Migrazione per componenti	Vedere Migrazione per componenti		SwitchParameters
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud		SwitchParameters
  TargetFolder	Specifica la cartella di destinazione dell’esportazione.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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 il backup dei file YAML in un unico 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 dai 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. Questa deve essere 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
  Filtraggio per nomi di oggetti	Vedere Filtraggio 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. Questa deve essere una specifica di cartella completa.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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 componenti solo 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	Unire impostazioni e filtri dei criteri. L’unione avviene 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 già presenti, in aggiunta a eventuali nuovi filtri e impostazioni importati. Tenere presente che quando si verificano conflitti tra impostazioni e filtri, i valori importati hanno la precedenza.		SwitchParameter
  OnErrorAction	Vedere OnErrorAction parameter.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

• Remove-CvadAcFromSite - Rimuovere i membri dei componenti dal cloud.

  Può reimpostare l’intero sito o rimuovere elementi membri da un componente (ad esempio, la rimozione di un catalogo delle macchine dall’elenco dei cataloghi). Questo può essere utilizzato in abbinamento al parametro IncludeByName per rimuovere in modo selettivo membri specifici.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio per nomi di oggetti		Elenco di stringhe
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud		SwitchParameters
  Quiet	Eliminare 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

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

Altri cmdlet di base

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

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti.		SwitchParameters
  Filtraggio per nomi di oggetti	Vedere Filtraggio per nomi di oggetti.		Elenco di stringhe
  Parametri di accesso al cloud	Vedere Parametri di accesso al cloud.		SwitchParameters
  SourceFolder	Identifica una cartella principale sostitutiva per %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Specifica la lingua del testo umanamente leggibile che può essere esportato.		Stringa
  Quiet	Eliminare 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 componenti solo 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
  OnErrorAction	Vedere OnErrorAction parameter.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai 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 dei componenti. 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

Filtraggio 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 in base al nome. È possibile scegliere un solo componente (ad esempio gruppi di consegna) alla volta in uno qualsiasi dei cmdlet supportati. Se un membro del componente si trova in entrambe le aree, l’esclusione sostituisce qualsiasi altro parametro e nell’elenco di correzione del log viene inserita una voce che identifica il nome del componente e del membro esclusi.

IncludeByName e ExcludeByName utilizzano un elenco di nomi dei membri dei componenti. Qualsiasi nome può contenere uno o più caratteri jolly. Sono supportati due tipi di caratteri jolly. L’elenco dei nomi dei membri dei componenti deve essere racchiuso tra virgolette singole quando il nome di un 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 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 tagliati dal nome del membro. Il nome del file deve essere preceduto dal segno @ ed essere racchiuso tra virgolette singole (un requisito di PowerShell in modo che @ non venga reinterpretato). È possibile elencare più file oltre ad associarli 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:

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

Per nome del gruppo di consegna

ByDeliveryGroupName filtra in base al 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 contiene un elenco dei nomi dei 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 dei gruppi di consegna che iniziano con EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Esclusione degli elementi disabilitati

ExcludeDisabled filtra dalle operazioni di importazione tutte le applicazioni e i gruppi di applicazioni disabilitati. Il valore predefinito di ExcludeDisabled è 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 i cataloghi delle macchine e i gruppi di consegna in base al nome della macchina. Questo parametro è sempre un elenco di inclusione che identifica i membri da includere in base all’associazione del 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 un numero qualsiasi di caratteri
• ? corrisponde a un singolo carattere

Quando si importa o si esporta utilizzando ByMachineName e il filtro del nome di una macchina non restituisce macchine nel catalogo delle macchine o nel gruppo di consegna, il catalogo delle macchine o il gruppo di consegna viene escluso dall’esportazione o dall’importazione.

Nota:

L’utilizzo di ByMachineName in qualsiasi cmdlet di tipo importazione fa sì che MergeMachines sia impostato su $true.

Unione di macchine

MergeMachines, se impostato su $true, indica all’operazione di importazione di aggiungere macchine solo al catalogo delle macchine o al gruppo di consegna. Le macchine non vengono rimosse, consentendo operazioni di aggiunta incrementali.

L’impostazione predefinita di MergeMachines è false, il che significa che le macchine vengono rimosse se non sono presenti nel file .yml del catalogo delle macchine o del gruppo di consegna. MergeMachines è impostato su $true quando ByMachineName viene utilizzato, ma può essere sovrascritto impostando MergeMachines su false.

Cmdlet relativi ai prerequisiti

• New-CvadAcCustomerInfoFile - Creare un file di informazioni dei clienti. Per impostazione predefinita, il file di informazioni dei clienti si trova in %HOMEPATH%\Documents\Citrix\AutoConfig.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  CustomerId	ID del cliente.	x	Stringa
  ClientId	ID client del cliente creato su Citrix Cloud. I valori CustomerId e Secret devono essere specificati quando si utilizza questo parametro.	A seconda delle condizioni	Stringa
  Secret	Chiave segreta del cliente creata su Citrix Cloud. I valori CustomerId e ClientId devono essere specificati quando si utilizza questo parametro.	A seconda delle condizioni	Stringa
  Environment	Ambiente Production, ProductionGov o ProductionJP.		Enumerazione
  LogFileName	Cambia il prefisso del file di log da CitrixLog a un altro valore.		Stringa
  AltRootUrl	Da usare solo sotto la direzione di Citrix.		Stringa
  StopOnError	Interrompe l’operazione al primo errore.		$true o $false
  TargetFolder	Utilizzare la cartella specificata come cartella principale anziché %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Utilizzare le impostazioni internazionali specificate anziché le impostazioni internazionali del 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 le specifiche di file complete per l’editor e l’editor deve acquisire la specifica del file di log come unico parametro.		Stringa
  SecurityCsvFileSpec	La specifica di file completa che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. Il valore CustomerId deve essere specificato quando si utilizza questo parametro.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

• Set-CvadAcCustomerInfoFile - Aggiornare un file di informazioni dei clienti esistente. Vengono modificati solo i parametri specificati dal cmdlet. Tutti i valori dei parametri non specificati nel file CustomerInfo.yml sono 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	Cambia il prefisso del file di log da CitrixLog a un altro valore.		Stringa
  StopOnError	Interrompe l’operazione al primo errore.		$true o $false
  TargetFolder	Utilizzare la cartella specificata come cartella principale anziché %HOMEPATH%\Documents\Citrix\AutoConfig.		Stringa
  Locale	Utilizzare le impostazioni internazionali specificate anziché le impostazioni internazionali del 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 le specifiche di file complete per l’editor e l’editor deve acquisire la specifica del file di log come unico parametro.		Stringa
  SecurityCsvFileSpec	La specifica di file completa che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. Il valore CustomerId deve essere specificato quando si utilizza questo parametro.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

Parametri relativi ai prerequisiti

Insieme ai parametri di accesso al cloud, è possibile utilizzare i seguenti parametri con i cmdlet relativi ai prerequisiti:

• Environment - Ambiente Production o ProductionGov.
• LogFileName - Cambiare il prefisso del file di log da CitrixLog a un altro valore.
• StopOnError - Interrompe l’operazione al primo errore.
• AlternateRootFolder - Utilizzare la cartella specificata come cartella principale anziché %HOMEPATH%\Documents\Citrix\AutoConfig
• Locale - Utilizzare le impostazioni internazionali specificate anziché le impostazioni internazionali del sistema su cui viene eseguito lo strumento.
• Editor - Utilizzare l’editor specificato per visualizzare il log al completamento di ogni cmdlet. Notepad.exe è l’editor predefinito. Questo parametro deve includere le specifiche di file complete per l’editor e l’editor deve acquisire la specifica del file di log come unico parametro.

Cmdlet per assistenza e risoluzione dei problemi

• New-CvadAcZipInfoForSupport - Comprime tutti i file di log e i file .yml in un unico file zip da inviare a Citrix per assistenza. Le informazioni sensibili dei clienti (CustomerInfo.yml e CvadAcSecurity.yml) non sono incluse nel file zip. Anche il file Icon.yml è escluso a causa delle sue dimensioni. Il file zip viene inserito 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 per creare e salvare il file zip.		Stringa
  Quiet	Eliminare la registrazione nella console.		SwitchParameter

  Restituisce:

  • Il file zip con nome e posizione del file zip viene visualizzato nel prompt dei comandi.

• Get-CvadAcStatus - Da utilizzare per testare la connettività e garantire 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. Questo è necessario se lo strumento non viene eseguito su un Delivery Controller.		Stringa

  Restituisce:

  • Visualizza i risultati per ogni elemento.

• Test-CvadAcConnectionWithSite - Testare la connessione con il sito cloud per verificare che la connessione della 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	Eliminare 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 funzionamento. 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 dei clienti 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 sostituisce lo stesso valore nel file CustomerInfo.yml.		Stringa

  Restituisce:

  • I risultati sono mostrati sulla riga di comando.

• Get-CvadAcCustomerSites - Restituisce l’elenco di tutte le sedi dei clienti. 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 di ID delle sedi dei clienti trovate.

• New-CvadAcTemplateToFile - Crea un file modello per i componenti selezionati, che consente di creare manualmente un file di importazione.

  Parametri:

  Nome	Descrizione	Obbligatorio?	Tipo
  Migrazione per componenti	Vedere Migrazione per componenti		SwitchParameters
  TargetFolder	Specifica la cartella di destinazione dell’esportazione.		Stringa

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

• Show-CvadAcDocument - Visualizza questa documentazione nel browser predefinito.

  Parametri:

  • None (Nessuno).

  Restituisce:

  • Visualizza questa pagina Web nel browser Web predefinito.

• Find-CvadAcInFile - La funzionalità Find in file (Trova nei file) esegue ricerche nei file YAML dei componenti e cerca membri corrispondenti a uno o più nomi che possono contenere caratteri jolly. Il risultato è un report dei membri trovati. Find in file (Trova nei file) può cercare solo un componente alla volta. Find in file (Trova nei 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
  Migrazione per componenti	Vedere 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	Segnala solo membri trovati in modo univoco.		SwitchParameter
  IncludeYaml	Includi il file YAML specifico per i membri.		SwitchParameter
  FindSourceFolder	La cartella in cui viene avviata la ricerca.		Stringa
  DisplayLog	Visualizza il file di log al completamento del cmdlet. Impostare su $false per eliminare la visualizzazione del log.		SwitchParameter
  Quiet	Eliminare la registrazione nella console.		SwitchParameter

  Risultato:

  • Crea un report contenente i membri trovati per il componente specificato.

Cmdlet per l’attivazione del sito

Per ulteriori 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
  SiteActive	Se presente, imposta il sito on-premise su attivo rimuovendo la modalità di manutenzione da tutti i gruppi di consegna. Quando questo parametro non è presente, la modalità di manutenzione è 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	Eliminare 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 or $false

  Restituisce:

  • Vedere Valori restituiti dai 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	Se presente, imposta il sito cloud su attivo rimuovendo la modalità di manutenzione da tutti i gruppi di consegna. Quando questo parametro non è presente, la modalità di manutenzione è 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	Eliminare 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 or $false

  Restituisce:

  • Vedere Valori restituiti dai cmdlet

Unione di più cmdlet di siti on-premise

Per ulteriori 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 sul prefisso/suffisso per l’unione dei 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 è necessario.	x	Stringa
  Parametri di unione dei siti	Vedere Parametri di unione dei siti		SwitchParameters
  Quiet	Eliminare la registrazione nella console.		SwitchParameter

  Restituisce:

  • Nessuna

• Set-CvadAcSiteMergingInfo - Aggiorna un set di informazioni prefisso/suffisso esistente per l’unione dei siti.

  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 è necessario.	x	Stringa
  Parametri di unione dei siti	Vedere Parametri di unione dei siti		SwitchParameters
  Quiet	Eliminare la registrazione nella console.		SwitchParameter

  Restituisce:

  • Nessuna

• Remove-CvadAcSiteMergingInfo - Rimuove un set di informazioni prefisso/suffisso esistente per l’unione dei siti.

  Parametri:

  • SiteName - Identifica l’insieme di prefissi e suffissi del sito. Questa è una stringa ed è obbligatoria.

  Restituisce:

  • Nessuna

Parametri di unione dei siti

I seguenti parametri possono essere utilizzati per l’esecuzione dei cmdlet di unione dei siti. 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 è necessario. 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 principale 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 delle 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 delle macchine.
• StoreFrontSuffix - Il suffisso da applicare ai nomi 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 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 vengono specificati in entrambe le posizioni, i parametri del cmdlet hanno la precedenza.

• CustomerId - L’ID cliente utilizzato nelle API Rest, necessario per accedere a tutte le API Rest. L’ID cliente si trova in Citrix Cloud.
• ClientId - Il clientID creato sul sito Web Citrix Cloud Identity and Access Management. È necessaria per ottenere il token di connessione richiesto per l’autenticazione per tutte le API Rest.
• Secret - La chiave segreta creata sul sito Web Citrix Cloud Identity and Access Management. È necessaria per ottenere il token di connessione richiesto per l’autenticazione per tutte le API Rest.
• CustomerInfoFileSpec - La specifica del file che punta a un file di informazioni dei clienti 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 verificare l’importazione prima che venga eseguita.
• BackupFirst - Esegue il backup dei contenuti cloud in file .yml prima di modificare la configurazione cloud. Questo parametro è abilitato per impostazione predefinita.
• Confirm - Se è impostato su 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 questo parametro su false se non si desidera alcun prompt, ad esempio nel caso di esecuzione all’interno di script automatici. 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 una condivisione di rete a cui potrebbe essere applicato il controllo dell’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 per l’unione dei siti da utilizzare durante l’importazione.
• SiteActive - Specifica se il sito importato è attivo o inattivo. Per impostazione predefinita, questo parametro è impostato su $false, il che indica 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 termine dell’operazione. È possibile impedire 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 dai cmdlet

ActionResult

Tutti i cmdlet restituiscono il valore seguente.

            public class ActionResult
            {
                public bool                         Overall_Success;
                public Dictionary<string, string>   Individual_Success;
                public object                       CustomResult;
            }

Overall_Success restituisce un singolo valore booleano che mostra la corretta esecuzione del cmdlet in tutti i componenti selezionati: true significa che l’operazione è riuscita e false che non è riuscita.

Individual_Success restituisce uno o tre valori per ogni componente principale. Il risultato di un componente può essere Success (Operazione riuscita), Failure (Operazione non riuscita) o Skipped (Saltato). Skipped (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 riportano le seguenti informazioni personalizzate sui risultati 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 ogni componente selezionato. La chiave è il nome del componente e il valore è un elenco di ogni 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 dei componenti aggiunti, aggiornati, eliminati o nessuna azione intrapresa, in quell’ordine.

TotalChanged è la somma di Added, Updated e Deleted.

OverallResult è un singolo valore booleano che indica il risultato del cmdlet. Il valore true indica la riuscita delle operazioni per tutti i componenti e false indica un errore nell’elaborazione di uno o più componenti.

CloudBackupFolder è la specifica di file completa del backup della configurazione del sito cloud prima che il cmdlet esegua qualsiasi azione di modifica del cloud.

SourceBackupFolder è la specifica di file completa 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 di qualsiasi cmdlet, digitare Get-Help davanti al cmdlet.

Get-Help Import-CvadAcToSite