Citrix DaaS™

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.

Categoria Cmdlet Descrizione
Migrazione da on-premises a cloud




Export-CvadAcToFile Esporta file on-premises in file YAML.
Import-CvadAcToSite Importa file YAML nel cloud. Supporta operazioni di creazione, aggiornamento ed eliminazione.
Merge-CvadAcToSite Importa file YAML nel cloud. Supporta operazioni di creazione e aggiornamento.
New-CvadAcToSite Importa 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 sopra. Esempi: MachineCatalogs, Tags. Per i nomi dei componenti, utilizzare i parametri con i comandi sopra. 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 sopra. Esempi: MachineCatalogs, Tags. Per i nomi dei componenti, utilizzare i parametri con i comandi sopra. 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 per la fusione di più siti on-premises

New-CvadAcSiteMergingInfo Crea un set di informazioni su prefisso/suffisso per la fusione di siti.
Set-CvadAcSiteMergingInfo Aggiorna un set di informazioni su prefisso/suffisso per la fusione di siti esistente.
Remove-CvadAcSiteMergingInfo Rimuove un set di informazioni su prefisso/suffisso per la fusione 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 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 SwitchParameters
    Filtro per nomi di oggetti Vedere Filtro 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 Sopprime la registrazione sulla 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 non presenti in Active Directory potrebbero causare errori di importazione. $true o $false
    ZipResults Comprime 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. SwitchParameter

    Restituisce:

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
Import X X X
Merge X X  
New X    
  • Import-CvadAcToSite - Importa file YAML nel cloud. Supporta operazioni di creazione, aggiornamento ed eliminazione.

    Importa tutti i file on-premises nel cloud. Questo comando assicura 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
    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 Sopprime la registrazione sulla 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 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. La fusione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato della fusione 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 di impostazioni e filtri, i valori importati hanno la precedenza. SwitchParameter
    OnErrorAction Vedere Parametro OnErrorAction. Stringa

    Restituisce:

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

    Unisce i file on-premises al cloud, ma non elimina alcun componente nel cloud o nel sito on-premises. 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 Sopprime la registrazione sulla 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 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. La fusione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato della fusione 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 di impostazioni e filtri, i valori importati hanno la precedenza. SwitchParameter
    OnErrorAction Vedere Parametro OnErrorAction. Stringa

    Restituisce:

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

    Importa la configurazione del sito on-premises 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
    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 Sopprime la registrazione sulla console. SwitchParameter
    DisplayLog Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log. $true o $false
    OnErrorAction Vedere Parametro OnErrorAction. Stringa

    Restituisce:

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

    Sync 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 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
    SourceTargetFolder Specifica la cartella di destinazione dell’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 Sopprime la registrazione sulla 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 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. La fusione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato della fusione 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 di impostazioni e filtri, i valori importati hanno la precedenza. SwitchParameter

    Restituisce:

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
    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. Stringa
    Locale Specifica la lingua del testo leggibile dall’uomo che può essere esportato. Stringa
    Quiet Sopprime la registrazione sulla console. SwitchParameter
    DisplayLog Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log. $true o $false
    ZipResults Comprime 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. SwitchParameter

    Restituisce:

  • 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 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
    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
    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 Sopprime la registrazione sulla 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 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. La fusione si verifica solo quando un criterio importato esiste già nel DDC cloud. Il risultato della fusione 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 di impostazioni e filtri, i valori importati hanno la precedenza. SwitchParameter
    OnErrorAction Vedere Parametro OnErrorAction. Stringa

    Restituisce:

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

    Può ripristinare 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 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 sulla console. SwitchParameter
    DisplayLog Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log. $true o $false

    Restituisce:

Altri cmdlet di base

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

    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 Sopprime la registrazione sulla 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 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:

Parametri di migrazione granulare

Migra 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

Migra per nomi di componenti

I parametri IncludeByName ed ExcludeByName consentono di includere ed escludere membri di componenti nei cmdlet per 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 sovrascrive 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 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 dei componenti deve essere racchiuso tra virgolette singole quando 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é @ 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 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 macchina 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 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, se impostato su $true, istruisce l’operazione di importazione ad 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 viene 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 del 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 Modifica 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 Utilizza la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig. Stringa
    Locale Utilizza la locale specificata invece della locale derivata dal sistema su cui viene eseguito lo strumento. Stringa
    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 completa del file dell’editor e l’editor deve accettare la specifica del file di log come unico parametro. Stringa
    SecurityCsvFileSpec La specifica completa del file che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. CustomerId deve essere specificato quando si utilizza questo parametro. Stringa

    Restituisce:

  • 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
    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 Utilizza la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig. Stringa
    Locale Utilizza la locale specificata invece della locale derivata dal sistema su cui viene eseguito lo strumento. Stringa
    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 completa del file dell’editor e l’editor deve accettare la specifica del file di log come unico parametro. Stringa
    SecurityCsvFileSpec La specifica completa del file che punta al file SecurityClient.csv scaricato da Citrix Identity and Access Management. CustomerId deve essere specificato quando si utilizza questo parametro. Stringa

    Restituisce:

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 – Utilizza la cartella specificata come cartella radice invece di %HOMEPATH%\Documents\Citrix\AutoConfig.
  • Locale – utilizza la locale specificata invece della locale derivata 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 completa del file dell’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
    TargetFolder Specifica una cartella di destinazione per creare e salvare il file zip. Stringa
    Quiet Sopprime la registrazione sulla console. SwitchParameter

    Restituisce:

    • Il file zip con il nome e la posizione del file zip viene visualizzato sul 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 SwitchParameters
    SiteId Identifica il sito a cui connettersi. Stringa
    AdminAddress Questo è l’indirizzo DNS o IP del Delivery Controller on-premises utilizzato per verificare il livello di accesso degli amministratori. Questo è 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 Sopprime la registrazione sulla 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 dal file CustomerInfo.yml o dal 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 sul 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 mostrati 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 di ID sito 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:

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

    Parametri:

    • Nessuno.

    Restituisce:

    • Visualizza questa pagina web nel browser web 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. Il risultato è un report dei membri trovati. La ricerca nel file può cercare un solo componente alla volta. La ricerca 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
    Migra per componenti Vedere Migra 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 Include lo YAML specifico del membro. SwitchParameter
    FindSourceFolder La cartella in cui inizia la ricerca. Stringa
    DisplayLog Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log. SwitchParameter
    Quiet Sopprime la registrazione sulla 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, consultare Attivazione dei siti.

  • Set-CvadAcSiteActiveStateOnPrem - Imposta lo stato del sito on-premises 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-premises 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
    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 Sopprime la registrazione sulla console. SwitchParameter
    DisplayLog Visualizza il file di log al completamento del cmdlet. Impostare su $false per sopprimere la visualizzazione del log. $true o $false

    Restituisce:

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

    Restituisce:

Cmdlet per la fusione di più siti on-premises

Per maggiori informazioni sulla fusione di siti e sull’utilizzo di questi cmdlet, consultare Unire più siti in un unico sito.

  • New-CvadAcSiteMergingInfo - Crea un set di informazioni su prefisso/suffisso per la fusione 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 il set di prefissi/suffissi per un sito specifico. Può corrispondere al nome del sito effettivo ma non è obbligatorio. x Stringa
    Parametri di fusione del sito Vedere Parametri di fusione del sito SwitchParameters
    Quiet Sopprime la registrazione sulla console. SwitchParameter

    Restituisce:

    • Nessuno
  • Set-CvadAcSiteMergingInfo - Aggiorna un set di informazioni su prefisso/suffisso per la fusione di siti esistente.

    Parametri:

    Nome Descrizione Obbligatorio? Tipo
    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. x Stringa
    Parametri di fusione del sito Vedere Parametri di fusione del sito SwitchParameters
    Quiet Sopprime la registrazione sulla console. SwitchParameter

    Restituisce:

    • Nessuno
  • Remove-CvadAcSiteMergingInfo - Rimuove un set di informazioni su prefisso/suffisso per la fusione di siti esistente.

    Parametri:

    • SiteName – identifica il set di prefissi e suffissi del sito. È una stringa ed è obbligatorio.

    Restituisce:

    • Nessuno

Parametri di fusione del sito

I seguenti parametri possono essere utilizzati quando si eseguono i cmdlet di fusione del sito. 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; 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 che l’utente vede.
  • ApplicationAdminPrefix – il prefisso da applicare al nome dell’applicazione che l’amministratore vede.
  • 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 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; ApplicationFolderSuffix può essere combinato con ApplicationFolderRoot.
  • ApplicationGroupSuffix – il suffisso per i gruppi di applicazioni.
  • ApplicationUserSuffix – il suffisso da applicare al nome dell’applicazione che l’utente vede.
  • ApplicationAdminSuffix – il suffisso da applicare al nome dell’applicazione che l’amministratore vede.
  • 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 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 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, 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 ed è richiesto per accedere a tutte le API Rest. L’ID cliente si trova in Citrix Cloud.
  • ClientId – L’ID client creato sul sito web Citrix Cloud Identity and Access Management. Questo è richiesto per ottenere il token bearer necessario per l’autenticazione per tutte le API Rest.
  • Secret – La chiave segreta creata sul sito web Citrix Cloud Identity and Access Management. Questo è richiesto 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 sul 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 quando si eseguono 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 set di prefissi e suffissi di fusione 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 dai 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 booleano che mostra 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, Fallimento 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 sul risultato personalizzato 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 quel 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 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 completa del file del backup della configurazione del sito cloud prima che il cmdlet esegua qualsiasi azione di modifica del cloud.

SourceBackupFolder è la specifica completa del file 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

Cmdlet dello strumento di configurazione automatizzata per la migrazione