Cmdlets de la herramienta de configuración automatizada para la migración

Esta página enumera todos los cmdlets y parámetros compatibles con la herramienta para casos de uso de migración.

Todos los cmdlets aceptan parámetros de uno de los siguientes tipos.

• Cadena
• Lista de cadenas
• Booleano: $true o $false
• SwitchParameter: la presencia del parámetro significa $true; la ausencia del parámetro significa $false

Nota:

SwitchParameter es el método preferido para las selecciones de verdadero o falso, pero los booleanos todavía se utilizan en la herramienta debido a problemas de compatibilidad.

La siguiente tabla es un resumen de todos los cmdlets. Consulte cada sección individual para saber qué parámetros admite cada cmdlet.

Para obtener más información sobre los parámetros y cómo utilizarlos, consulte Parámetros de migración granular.

Cmdlets básicos

Cmdlets de local a la nube

• Export-CvadAcToFile - Exporta archivos locales a archivos YAML.

  Exporta la configuración de su configuración local. Esta es la operación de exportación predeterminada para la configuración automatizada. No se realizan modificaciones en la configuración del sitio local. Los archivos exportados se colocan en el directorio %HOMEPATH%\Documents\Citrix\AutoConfig en una subcarpeta Export con un nombre único. La carpeta %HOMEPATH%\Documents\Citrix\AutoConfig siempre contiene la última configuración del sitio local exportada.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto		Lista de cadenas
  TargetFolder	Especifica la carpeta de destino de la exportación.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  Quiet	Suprime el registro en la consola.		SwitchParameter
  AdminAddress	Especifica la dirección DNS o IP del Delivery Controller cuando la exportación no se ejecuta en el Delivery Controller.		Cadena
  CheckUserAndMachines	Verifica si los usuarios y las máquinas están en Active Directory. Los usuarios y las máquinas que no están en Active Directory pueden provocar errores de importación.		$true o $false
  ZipResults	Comprime los archivos YAML de copia de seguridad en un único archivo zip. El archivo se encuentra en la misma carpeta que los archivos YAML de copia de seguridad y tiene el mismo nombre que la carpeta.		SwitchParameter

  Devuelve:

  • Consulte Valores devueltos del cmdlet

Hay tres formas de importar datos a la nube. La ejecución de cmdlets específicos puede dar lugar a una de las tres combinaciones de acciones en el sitio en la nube:

• Agregar, actualizar y eliminar
• Solo agregar y actualizar
• Solo agregar

• Import-CvadAcToSite - Importar archivos YAML a la nube. Admite operaciones de creación, actualización y eliminación.

  Importa todos los archivos locales a la nube. Este comando garantiza que el estado final de la nube sea idéntico al estado local. Esta opción elimina cualquier cambio existente en la nube. Los archivos de configuración del sitio importados se obtienen de %HOMEPATH%\Documents\Citrix\AutoConfig. Úselo con precaución.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes.		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto.		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube.		SwitchParameters
  SourceFolder	Identifica una carpeta raíz sustituta para %HOMEPATH%\Documents\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  Quiet	Suprimir el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establezca en $false para suprimir la visualización del registro.		$true o $false
  Merge	Cuando se establece en $true, solo añade componentes al sitio en la nube. Los componentes no se eliminan. Establezca en $false para eliminar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo añade componentes nuevos, no actualiza ni elimina componentes existentes. Establezca en $false para permitir actualizaciones y eliminaciones. Se ignora Merge cuando este parámetro es $true.		$true o $false
  MergePolicies	Fusionar la configuración y los filtros de la política. La fusión solo se produce cuando una política que se está importando ya existe en el DDC de la nube. El resultado de fusionar políticas es que las políticas del DDC de la nube contienen la configuración y los filtros que ya tenía, además de cualquier nueva configuración y filtros que se estén importando. Tenga en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.		SwitchParameter
  OnErrorAction	Consulte parámetro OnErrorAction.		String

  Devuelve:

  • Consulte valores de retorno de Cmdlet

• Merge-CvadAcToSite - Importa archivos YAML a la nube. Admite operaciones de creación y actualización.

  Combina los archivos locales con la nube, pero no elimina ningún componente en la nube ni en el sitio local. Esto conserva los cambios ya realizados en la nube. Si un componente existe en Citrix Cloud con el mismo nombre, este comando puede modificar ese componente. Esta es la operación de importación predeterminada para la configuración automatizada. Los archivos de configuración de sitio combinados se obtienen de %HOMEPATH%\Documents\Citrix\AutoConfig.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes.		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto.		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube.		SwitchParameters
  SourceFolder	Identifica una carpeta raíz sustituta para %HOMEPATH%\Documents\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  Quiet	Suprime el registro en la consola.		Parámetro de conmutación
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false
  Merge	Cuando se establece en $true, solo añade componentes al sitio en la nube. Los componentes no se eliminan. Establézcalo en $false para eliminar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo añade componentes nuevos, no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Merge se ignora cuando este parámetro es $true.		$true o $false
  MergePolicies	Fusionar la configuración y los filtros de la política. La fusión solo se produce cuando una política que se está importando ya existe en el DDC en la nube. El resultado de fusionar políticas es que las políticas del DDC en la nube contienen la configuración y los filtros que ya tenía, además de cualquier nueva configuración y filtros que se estén importando. Tenga en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.		Parámetro de conmutación
  OnErrorAction	Consulte parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores devueltos del cmdlet

• New-CvadAcToSite - Importa archivos YAML a la nube. Admite operaciones de creación y actualización.

  Importa la configuración del sitio local a la nube, pero solo agrega nuevos componentes. Los componentes existentes del sitio en la nube no se actualizan ni se eliminan. Utilice este comando si los componentes existentes de su sitio en la nube deben permanecer sin cambios.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes.		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto.		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube.		SwitchParameters
  SourceFolder	Identifica una carpeta raíz sustituta para %HOMEPATH%\Documents\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  Quiet	Suprimir el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false
  OnErrorAction	Consulte OnErrorAction parameter.		Cadena

  Devuelve:

  • Consulte Cmdlet return values

• Sync-CvadAcToSite - Exportar e importar en un solo paso.

  La sincronización realiza tanto una exportación como una importación en un solo paso. Utilice el parámetro SourceTargetFolder para especificar la carpeta de destino de exportación/importación.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrate by components		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  SourceTargetFolder	Especifica la carpeta de destino de exportación/importación.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  AdminAddress	Especifica la dirección DNS o IP del controlador de entrega cuando la exportación no se ejecuta en el controlador de entrega.		Cadena
  Quiet	Suprime el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establezca en $false para suprimir la visualización del registro.		$true o $false
  Merge	Cuando se establece en $true, solo agrega componentes al sitio en la nube. Los componentes no se eliminan. Establezca en $false para eliminar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo agrega componentes nuevos, no actualiza ni elimina los componentes existentes. Establezca en $false para permitir actualizaciones y eliminaciones. Se ignora Merge cuando este parámetro es $true.		$true o $false
  MergePolicies	Fusionar la configuración y los filtros de la directiva. La fusión solo se produce cuando una directiva que se está importando ya existe en el DDC de la nube. El resultado de fusionar directivas es que las directivas del DDC de la nube contienen la configuración y los filtros que ya tenía, además de cualquier nueva configuración y filtros que se estén importando. Tenga en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.		Parámetro de conmutación

  Devuelve:

  • Consulte Valores devueltos del cmdlet

Cmdlets de nube a nube

• Backup-CvadAcToFile - Realiza una copia de seguridad de toda la configuración de su sitio en la nube.

  Exporta la configuración de su nube a archivos .yml. Esta copia de seguridad se puede utilizar en un proceso de copia de seguridad y restauración para recuperar componentes perdidos.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes		Parámetros de conmutación
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  TargetFolder	Especifica la carpeta de destino de la exportación.		String
  Locale	Especifica el idioma del texto legible para humanos que se puede exportar.		String
  Quiet	Suprimir el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false
  ZipResults	Comprime los archivos YAML de copia de seguridad en un único archivo zip. El archivo se encuentra en la misma carpeta que los archivos YAML de copia de seguridad y tiene el mismo nombre que la carpeta.		SwitchParameter

  Devuelve:

  • Consulte Valores devueltos del cmdlet

• Restore-CvadAcToSite - Restaura los archivos YAML de copia de seguridad en el sitio en la nube. Este sitio en la nube puede ser el mismo o diferente que el sitio en la nube de origen.

  Restaura el sitio en la nube a la configuración anterior. Los archivos importados se obtienen de la carpeta especificada mediante el parámetro -RestoreFolder, que identifica la carpeta que contiene los archivos .yml para restaurar en el sitio en la nube. Debe ser una especificación de carpeta completa. Este cmdlet se puede utilizar para volver a la configuración anterior o para realizar copias de seguridad y restaurar su sitio en la nube. Este comando puede agregar, eliminar y actualizar su sitio en la nube.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes.		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto.		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube.		SwitchParameters
  RestoreFolder	Identifica la carpeta que contiene los archivos .yml que se van a restaurar en el sitio en la nube. Debe ser una especificación de carpeta completa.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  Quiet	Suprime el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false
  Merge	Cuando se establece en $true, solo añade componentes al sitio en la nube. Los componentes no se eliminan. Establézcalo en $false para eliminar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo añade componentes nuevos, no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Se ignora Merge cuando este parámetro es $true.		$true o $false
  MergePolicies	Combina la configuración y los filtros de las directivas. La combinación solo se produce cuando una directiva que se está importando ya existe en el DDC de la nube. El resultado de combinar directivas es que las directivas del DDC de la nube contienen la configuración y los filtros que ya tenía, además de cualquier nueva configuración y filtros que se estén importando. Tenga en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.		SwitchParameter
  OnErrorAction	Consulte parámetro OnErrorAction.		String

  Devuelve:

  • Consulte Valores devueltos del cmdlet

• Remove-CvadAcFromSite – Eliminar miembros del componente de la nube.

  Puede restablecer todo el sitio o eliminar elementos miembros de un componente (por ejemplo, eliminar un catálogo de máquinas de la lista de catálogos). Esto se puede usar junto con el parámetro IncludeByName para eliminar selectivamente miembros específicos.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  Quiet	Suprime el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false

  Devuelve:

  • Consulte Valores de retorno de cmdlet

Otros cmdlets básicos

• Compare-CvadAcToSite: Compara los archivos .yml locales con la configuración de la nube y genera un informe de los cambios realizados por un cmdlet Import, Merge o Restore.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes.		SwitchParameters
  Filtrado por nombres de objeto	Consulte Filtrado por nombres de objeto.		Lista de cadenas
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube.		SwitchParameters
  SourceFolder	Identifica una carpeta raíz sustituta para %HOMEPATH%\Documents\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto legible por humanos que se puede exportar.		Cadena
  Quiet	Suprime el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establezca en $false para suprimir la visualización del registro.		$true o $false
  Merge	Cuando se establece en $true, solo añade componentes al sitio en la nube. Los componentes no se eliminan. Establezca en $false para eliminar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo añade componentes nuevos, no actualiza ni elimina los componentes existentes. Establezca en $false para permitir actualizaciones y eliminaciones. Se ignora Merge cuando este parámetro es $true.		$true o $false
  OnErrorAction	Consulte parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores de retorno de los cmdlets

Parámetros de migración granular

Migrar por componentes

Los siguientes componentes se pueden especificar con los cmdlets que los admiten. La opción All se selecciona automáticamente cuando no se especifican parámetros de componente. Para evitar errores, le recomendamos que migre los componentes en el siguiente orden:

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

Filtrado por nombres de objeto

Migrar por nombres de componentes

Los parámetros IncludeByName y ExcludeByName permiten incluir y excluir miembros de componentes en cmdlets por nombre. Solo se puede elegir un componente (por ejemplo, grupos de entrega) a la vez en cualquiera de los cmdlets admitidos. Si un miembro de componente se encuentra en ambas áreas, la exclusión anula cualquier otro parámetro y se realiza una entrada en la lista de corrección de registros que identifica el componente y el nombre del miembro que se excluyó.

IncludeByName y ExcludeByName toman una lista de nombres de miembros de componentes. Cualquier nombre puede contener uno o más caracteres comodín. Se admiten dos tipos de caracteres comodín. La lista de nombres de miembros de componentes debe ir entre comillas simples cuando cualquier nombre de miembro contenga caracteres especiales.

• * Coincide con cualquier número de caracteres
• ? Coincide con un solo carácter

IncludeByName y ExcludeByName también pueden tomar un archivo que contenga una lista de miembros, donde cada miembro puede ser explícito o contener caracteres comodín. Cada línea del archivo puede contener un miembro. Los espacios iniciales y finales se eliminan del nombre del miembro. El nombre del archivo debe ir precedido del signo @ y estar entre comillas simples (un requisito de PowerShell para que el @ no se reinterprete). Se pueden enumerar varios archivos, además de mezclarse con nombres de miembros.

Un ejemplo de cómo combinar todos los grupos de entrega cuyos nombres comienzan con DgSite1 y contienen Home2 se escribiría así:

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

Por nombre de grupo de entrega

ByDeliveryGroupName filtra por el nombre del grupo de entrega para aplicaciones y grupos de aplicaciones. Este parámetro es siempre una lista de inclusión que identifica a los miembros que se deben incluir en función de su asociación con el grupo de entrega.

ByDeliveryGroupName toma una lista de nombres de grupos de entrega. Cualquier nombre puede contener uno o varios comodines. Se admiten dos tipos de comodines.

• * coincide con cualquier número de caracteres
• ? coincide con un solo carácter

El siguiente ejemplo combina todas las aplicaciones que hacen referencia a todos los nombres de grupos de entrega que comienzan por EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Excluir deshabilitados

ExcludeDisabled filtra de las operaciones de importación todas las aplicaciones y grupos de aplicaciones que están deshabilitados. ExcludeDisabled se establece de forma predeterminada en false, lo que significa que todas las aplicaciones y grupos de aplicaciones se importan independientemente de su estado habilitado.

Por nombre de máquina

ByMachineName filtra por el nombre de la máquina para catálogos de máquinas y grupos de entrega. Este parámetro es siempre una lista de inclusión que identifica a los miembros que se deben incluir en función de su asociación con el nombre de la máquina.

ByMachineName toma una lista de nombres de máquinas donde cualquier nombre puede contener uno o varios comodines. Se admiten dos tipos de comodines.

• * coincide con cualquier número de caracteres
• ? coincide con un solo carácter

Al exportar o importar y usar ByMachineName y un filtro de nombre de máquina no da como resultado ninguna máquina en el catálogo de máquinas o grupo de entrega, el catálogo de máquinas o el grupo de entrega se excluyen de la exportación o importación.

Nota:

El uso de ByMachineName en cualquier cmdlet de tipo de importación hace que MergeMachines se establezca en $true.

Fusionar máquinas

MergeMachines, cuando se establece en $true, indica a la operación de importación que añada máquinas solo al catálogo de máquinas o al grupo de entrega. Las máquinas no se eliminan, lo que permite operaciones aditivas incrementales.

MergeMachines se establece en false de forma predeterminada, lo que significa que las máquinas se eliminan si no están presentes en el archivo .yml del catálogo de máquinas o del grupo de entrega. MergeMachines se establece en $true cuando se utiliza ByMachineName, pero se puede anular estableciendo MergeMachines en false.

Cmdlets relacionados con los requisitos previos

• New-CvadAcCustomerInfoFile - Crea un archivo de información del cliente. De forma predeterminada, el archivo de información del cliente se encuentra en %HOMEPATH%\Documents\Citrix\AutoConfig.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  CustomerId	ID del cliente.	x	Cadena
  ClientId	ID de cliente del cliente creado en Citrix Cloud. CustomerId y Secret deben especificarse al usar este parámetro.	Condicionalmente	Cadena
  Secret	Clave secreta del cliente creada en Citrix Cloud. CustomerId y ClientId deben especificarse al usar este parámetro.	Condicionalmente	Cadena
  Environment	Entorno Production, ProductionGov o ProductionJP.		Enumeración
  LogFileName	Cambie el prefijo del archivo de registro de CitrixLog a otro.		Cadena
  AltRootUrl	Usar solo bajo la dirección de Citrix.		Cadena
  StopOnError	Detiene la operación al primer error.		$true o $false
  TargetFolder	Utilice la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documents\Citrix\AutoConfig.		Cadena
  Locale	Utilice la configuración regional especificada en lugar de la configuración regional derivada del sistema en el que se ejecuta la herramienta.		Cadena
  Editor	Utilice el editor especificado para mostrar el registro al finalizar cada cmdlet. Notepad.exe es el editor predeterminado. Este parámetro debe incluir la especificación de archivo completa del editor y el editor debe tomar la especificación del archivo de registro como su único parámetro.		Cadena
  SecurityCsvFileSpec	La especificación de archivo completa que apunta al archivo SecurityClient.csv descargado de Citrix Identity and Access Management. El CustomerId debe especificarse al usar este parámetro.		Cadena

  Devuelve:

  • Consulte Valores de retorno de Cmdlet

• Set-CvadAcCustomerInfoFile - Actualiza un archivo de información de cliente existente. Solo se modifican los parámetros especificados por el cmdlet. Todos los valores de parámetros no especificados en el archivo CustomerInfo.yml permanecen sin cambios.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  CustomerId	ID del cliente.		Cadena
  ClientId	ID de cliente del cliente creado en Citrix Cloud.		Cadena
  Secret	Clave secreta del cliente creada en Citrix Cloud.		Cadena
  Environment	Entorno de Producción, ProductionGov o ProductionJP.		Enumeración
  LogFileName	Cambie el prefijo del archivo de registro de CitrixLog a otro.		Cadena
  StopOnError	Detiene la operación al primer error.		$true o $false
  TargetFolder	Utilice la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documents\Citrix\AutoConfig.		Cadena
  Locale	Utilice la configuración regional especificada en lugar de la configuración regional derivada del sistema en el que se ejecuta la herramienta.		Cadena
  Editor	Utilice el editor especificado para mostrar el registro al finalizar cada cmdlet. Notepad.exe es el editor predeterminado. Este parámetro debe incluir la especificación de archivo completa del editor y el editor debe tomar la especificación del archivo de registro como su único parámetro.		Cadena
  SecurityCsvFileSpec	La especificación de archivo completa que apunta al archivo SecurityClient.csv descargado de Citrix Identity and Access Management. El CustomerId debe especificarse al utilizar este parámetro.		Cadena

  Devuelve:

  • Consulte Valores de retorno de cmdlet

Parámetros relacionados con los requisitos previos

Junto con los parámetros de acceso a la nube, los siguientes parámetros se pueden utilizar con los cmdlets relacionados con los requisitos previos:

• Environment – Entorno de producción o ProductionGov.
• LogFileName – Cambia el prefijo del archivo de registro de CitrixLog a otro.
• StopOnError – Detiene la operación al primer error.
• AlternateRootFolder – Utilice la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documents\Citrix\AutoConfig.
• Locale – utilice la configuración regional especificada en lugar de la configuración regional derivada del sistema en el que se ejecuta la herramienta.
• Editor – utilice el editor especificado para mostrar el registro al finalizar cada cmdlet. Notepad.exe es el editor predeterminado. Este parámetro debe incluir la especificación de archivo completa del editor y el editor debe tomar la especificación del archivo de registro como su único parámetro.

Cmdlets de soporte y solución de problemas

• New-CvadAcZipInfoForSupport - Comprime todos los archivos de registro y .yml en un único archivo zip para enviarlos a Citrix para soporte. La información confidencial del cliente (CustomerInfo.yml y CvadAcSecurity.yml) no se incluye en el archivo zip. El archivo Icon.yml también se excluye debido a su tamaño. El archivo zip se coloca en %HOMEPATH%\Documents\Citrix\AutoConfig y se denomina CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip, según la fecha y la marca de tiempo. Este archivo zip también puede actuar como copia de seguridad.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  TargetFolder	Especifica una carpeta de destino para crear y guardar el archivo zip.		Cadena
  Quiet	Suprimir el registro en la consola.		SwitchParameter

  Devuelve:

  • El archivo zip con el nombre y la ubicación del archivo zip se muestra en el símbolo del sistema.

• Get-CvadAcStatus - Se utiliza para probar la conectividad y para asegurarse de que se cumplen todos los requisitos previos. Devuelve información sobre la herramienta, como el número de versión y la conectividad con la nube y el estado del conector.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  SiteId	Identifica el sitio al que conectarse.		Cadena
  AdminAddress	Esta es la dirección DNS o IP del Delivery Controller local utilizada para verificar el nivel de acceso de los administradores. Esto es necesario si la herramienta no se ejecuta en un Delivery Controller.		Cadena

  Devuelve:

  • Muestra los resultados de cada elemento.

• Test-CvadAcConnectionWithSite – Prueba la conexión con el sitio en la nube para verificar que la conexión de comunicación funciona. Este cmdlet utiliza los parámetros de acceso a la nube o el archivo CustomerInfo.yml para especificar la información de conexión del cliente.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  Quiet	Suprime el registro en la consola.		SwitchParameter

  Devuelve:

  • Los resultados de la prueba se muestran en la línea de comandos.

• Find-CvadAcConnector - Localiza los conectores existentes y determina su estado de ejecución. Este cmdlet utiliza la información del archivo CustomerInfo.yml o el parámetro de ID de cliente para localizar los conectores del cliente.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  CustomerInfoFileSpec	La especificación del archivo que apunta a un archivo de información del cliente para anular la ubicación y el nombre predeterminados. Este parámetro se ignora cuando se proporciona el parámetro CustomerId.		Cadena
  CustomerId	El ID del cliente. Este parámetro anula el mismo valor en el archivo CustomerInfo.yml.		Cadena

  Devuelve:

  • Los resultados se muestran en la línea de comandos.

• Get-CvadAcCustomerSites - Devuelve la lista de todos los sitios de cliente. Este cmdlet utiliza los parámetros de acceso a la nube o el archivo CustomerInfo.yml para especificar la información de conexión del cliente.

  Parámetros:

  • Consulte Parámetros de acceso a la nube

  Devuelve:

  • Muestra una lista de los ID de sitios de cliente encontrados.

• New-CvadAcTemplateToFile – Crea un archivo de plantilla para los componentes seleccionados, lo que le permite crear manualmente un archivo de importación.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes		SwitchParameters
  TargetFolder	Especifica la carpeta de destino de la exportación.		Cadena

  Devuelve:

  • Consulte Valores devueltos del cmdlet

• Show-CvadAcDocument - Muestra esta documentación en el explorador predeterminado.

  Parámetros:

  • Ninguno.

  Devuelve:

  • Muestra esta página web en el explorador web predeterminado.

• Find-CvadAcInFile - Buscar en archivo busca archivos YAML de componentes que contengan miembros que coincidan con uno o más nombres que pueden contener comodines. El resultado es un informe de los miembros encontrados. Buscar en archivo solo puede buscar un componente a la vez. Buscar en archivo busca todos los archivos YAML en la carpeta actual y en todas las subcarpetas. Utilice FindSourceFolder para limitar el número de archivos a buscar.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migrar por componentes	Consulte Migrar por componentes. Nota: El valor -All no es válido.		SwitchParameters
  IncludeByName	Una lista que especifica los nombres de los grupos de entrega que se incluirán al establecer el estado activo del sitio en activo. Los comodines ‘*’ y ‘?’ son compatibles con los nombres.		Lista de cadenas
  Unique	Informar solo de los miembros encontrados únicos.		SwitchParameter
  IncludeYaml	Incluya el YAML específico del miembro.		SwitchParameter
  FindSourceFolder	La carpeta en la que la búsqueda comienza a buscar.		String
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establezca en $false para suprimir la visualización del registro.		SwitchParameter
  Quiet	Suprimir el registro en la consola.		SwitchParameter

  Devuelve:

  • Crea un informe que contiene los miembros encontrados para el componente especificado.

Cmdlets de activación de sitios

Para obtener más información sobre la activación de sitios y el uso de estos cmdlets, consulte Activación de sitios.

• Set-CvadAcSiteActiveStateOnPrem - Establece el estado del sitio local como activo o inactivo.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  SiteActive	Cuando está presente, establece el sitio local como activo, eliminando el modo de mantenimiento de todos los grupos de entrega. Cuando este parámetro no está presente, el modo de mantenimiento se establece en todos los grupos de entrega.		SwitchParameter
  IncludeByName	Una lista que especifica los nombres de los grupos de entrega que se incluirán al establecer el estado activo del sitio como activo. Los comodines ‘*’ y ‘?’ son compatibles con los nombres.		Lista de cadenas
  ExcludeByName	Una lista que especifica los nombres de los grupos de entrega que se deben excluir al establecer el estado activo del sitio en activo. Los comodines ‘*’ y ‘?’ son compatibles con los nombres.		Lista de cadenas
  Quiet	Suprime el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establezca en $false para suprimir la visualización del registro.		$true or $false

  Devuelve:

  • Consulte Valores de retorno del cmdlet

• Set-CvadAcSiteActiveStateCloud - Establece el estado del sitio en la nube en activo o inactivo.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Parámetros de acceso a la nube	Consulte Parámetros de acceso a la nube		SwitchParameters
  SiteActive	Cuando está presente, establece el sitio en la nube como activo, eliminando el modo de mantenimiento de todos los grupos de entrega. Cuando este parámetro no está presente, el modo de mantenimiento se establece en todos los grupos de entrega.		SwitchParameter
  IncludeByName	Una lista que especifica los nombres de los grupos de entrega que se incluirán al establecer el estado activo del sitio. Los comodines ‘*’ y ‘?’ son compatibles con los nombres.		Lista de cadenas
  ExcludeByName	Una lista que especifica los nombres de los grupos de entrega que se excluirán al establecer el estado activo del sitio. Los comodines ‘*’ y ‘?’ son compatibles con los nombres.		Lista de cadenas
  Quiet	Suprime el registro en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registro al finalizar el cmdlet. Establezca en $false para suprimir la visualización del registro.		$true or $false

  Devuelve:

  • Consulte Valores de retorno del cmdlet

Cmdlets para fusionar varios sitios locales

Para obtener más información sobre la fusión de sitios y el uso de estos cmdlets, consulte Fusionar varios sitios en un único sitio.

• New-CvadAcSiteMergingInfo - Crea un conjunto de información de prefijos/sufijos para la fusión de sitios. No es necesario conocer todos los prefijos o sufijos al principio. Se pueden actualizar con Set-CvadAcSiteMergingInfo o editando manualmente el archivo SiteMerging.yml. Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  SiteName	El nombre utilizado para identificar el conjunto de prefijos/sufijos para un sitio específico. Puede coincidir con el nombre del sitio real, pero no es necesario.	x	Cadena
  Parámetros de fusión de sitios	Consulte Parámetros de fusión de sitios		SwitchParameters
  Quiet	Suprimir el registro en la consola.		SwitchParameter

  Devuelve:

  • Ninguno

• Set-CvadAcSiteMergingInfo - Actualiza un conjunto de información de prefijos/sufijos de fusión de sitios existente.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  SiteName	El nombre utilizado para identificar el conjunto de prefijos/sufijos para un sitio específico. Puede coincidir con el nombre del sitio real, pero no es necesario.	x	Cadena
  Parámetros de fusión de sitios	Consulte Parámetros de fusión de sitios		Parámetros de modificador
  Quiet	Suprime el registro en la consola.		Parámetro de modificador

  Devuelve:

  • Ninguno

• Remove-CvadAcSiteMergingInfo - Elimina un conjunto existente de información de prefijos/sufijos de fusión de sitios.

  Parámetros:

  • SiteName – identifica el conjunto de prefijos y sufijos del sitio. Es una cadena y es obligatorio.

  Devuelve:

  • Ninguno

Parámetros de fusión de sitios

Los siguientes parámetros se pueden utilizar al ejecutar los cmdlets de fusión de sitios. Todos los parámetros enumerados son cadenas.

• SiteName – el nombre utilizado para identificar el conjunto de prefijos/sufijos para un sitio específico. Puede coincidir con el nombre del sitio real, pero no es necesario. SiteName es un parámetro obligatorio.
• AdminScopedPrefix – el prefijo que se aplicará a los ámbitos de administrador.
• ApplicationPrefix - el prefijo que se aplicará a las aplicaciones.
• ApplicationFolderPrefix – el prefijo que se aplicará a las carpetas de aplicaciones; ApplicationFolderPrefix se puede combinar con ApplicationFolderRoot.
• ApplicationFolderRoot – la nueva carpeta raíz para las carpetas de aplicaciones. Esto crea una jerarquía de carpetas adicional. ApplicationFolderRoot se puede combinar con ApplicationFolderPrefix.
• ApplicationGroupPrefix – el prefijo para los grupos de aplicaciones.
• ApplicationUserPrefix – el prefijo que se aplicará al nombre de la aplicación que ve el usuario.
• ApplicationAdminPrefix – el prefijo que se aplicará al nombre de la aplicación que ve el administrador.
• DeliveryGroupPrefix – el prefijo que se aplicará a los grupos de entrega.
• GroupPolicyPrefix – el prefijo que se aplicará a los nombres de las directivas.
• HostConnectionPrefix – el prefijo que se aplicará a las conexiones de host.
• MachineCatalogPrefix – el prefijo que se aplicará a los catálogos de máquinas.
• StoreFrontPrefix – el prefijo que se aplicará a los nombres de StoreFront™.
• TagPrefix – el prefijo que se aplicará a las etiquetas.
• AdminScopedSuffix – el sufijo que se aplicará a los ámbitos de administrador.
• ApplicationSuffix - el sufijo que se aplicará a las aplicaciones.
• ApplicationFolderSuffix – el sufijo que se aplicará a las carpetas de aplicaciones; ApplicationFolderSuffix se puede combinar con ApplicationFolderRoot.
• ApplicationGroupSuffix – el sufijo para los grupos de aplicaciones.
• ApplicationUserSuffix – el sufijo que se aplicará al nombre de la aplicación que ve el usuario.
• ApplicationAdminSuffix – el sufijo que se aplicará al nombre de la aplicación que ve el administrador.
• DeliveryGroupSuffix – el sufijo que se aplicará a los grupos de entrega.
• GroupPolicySuffix – el sufijo que se aplicará a los nombres de las directivas.
• HostConnectionSuffix – el sufijo que se aplicará a las conexiones de host.
• MachineCatalogSuffix – el sufijo que se aplicará a los catálogos de máquinas.
• StoreFrontSuffix – el sufijo que se aplicará a los nombres de StoreFront.
• TagSuffix – el sufijo que se aplicará a las etiquetas.
• SiteRootFolder – el nombre de carpeta completo que se utilizará para las exportaciones e importaciones; puede ser una carpeta local o un recurso compartido de archivos.

Parámetros genéricos

Parámetros de acceso a la nube

Todos los cmdlets que acceden a la nube admiten los siguientes parámetros adicionales.

Nota:

CustomerId, ClientId y Secret se pueden colocar en el archivo CustomerInfo.yml o especificarse con el cmdlet mediante los siguientes parámetros. Cuando se especifican en ambos lugares, los parámetros del cmdlet tienen prioridad.

• CustomerId – El ID de cliente utilizado en las API de REST y es necesario para acceder a todas las API de REST. Su ID de cliente se encuentra en Citrix Cloud.
• ClientId – El ID de cliente creado en el sitio web de Citrix Cloud Identity and Access Management. Esto es necesario para obtener el token de portador necesario para la autenticación de todas las API de REST.
• Secret – La clave secreta creada en el sitio web de Citrix Cloud Identity and Access Management. Esto es necesario para obtener el token de portador necesario para la autenticación de todas las API de REST.
• CustomerInfoFileSpec – La especificación de archivo que apunta a un archivo de información del cliente para anular la ubicación y el nombre predeterminados.

Parámetros del modo de migración

Los cmdlets que modifican la configuración del sitio en la nube (Import, Restore, Merge, New y Sync) admiten los siguientes parámetros adicionales para proporcionar mayor flexibilidad.

• CheckMode – Realiza la operación de importación, pero no realiza ningún cambio. Todos los cambios esperados se notifican antes de que finalice la importación. Puede utilizar este comando para probar la importación antes de que se produzca.
• BackupFirst – Realiza una copia de seguridad del contenido de la nube en archivos .yml antes de modificar la configuración de la nube. Esto está habilitado de forma predeterminada.
• Confirm – Cuando es verdadero, solicita a los usuarios que confirmen que desean realizar cambios en la configuración del sitio en la nube. El cmdlet Remove muestra un mensaje debido a su naturaleza destructiva. Se establece en falso si no se desea ningún mensaje, como al ejecutarse dentro de scripts automatizados. Confirm es verdadero de forma predeterminada.
• SecurityFileFolder – Esta es la carpeta completa que contiene el archivo CustomerInfo.yml, que puede apuntar a una carpeta local o a una carpeta de recursos compartidos de red que puede estar bajo control de autenticación. La herramienta no solicitará credenciales; se debe obtener acceso al recurso controlado antes de ejecutar la herramienta.
• SiteName – Especifica el prefijo y el sufijo de combinación del sitio que se utilizarán al importar.
• SiteActive – Especifica si el sitio importado está activo o inactivo. De forma predeterminada, este parámetro se establece en $false, lo que significa que el sitio importado está inactivo.

Parámetros de visualización de registros

Los cmdlets Export, Import, Sync, Restore, Backup, Compare y Remove muestran el archivo de registro cuando la operación finaliza. Puede suprimir la visualización estableciendo el parámetro -DisplayLog en $false. Notepad.exe se utiliza de forma predeterminada para mostrar el archivo de registro. Puede especificar un editor diferente en el archivo CustomerInfo.yml.

Editor: C:\Program Files\Notepad++\notepad++.exe

Valores de retorno del cmdlet

ActionResult

Todos los cmdlets devuelven el siguiente valor.

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

Overall_Success devuelve un único valor booleano que muestra el éxito general del cmdlet en todos los componentes seleccionados: verdadero significa éxito y falso significa fracaso.

Individual_Success devuelve uno o tres valores para cada componente principal. El resultado de un componente puede ser Correcto, Fallo u Omitido. Omitido indica que el componente no fue seleccionado para su ejecución por el cmdlet.

CustomResult es específico del cmdlet.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File y Remove devuelven la siguiente información de resultado personalizada a una única instancia de EvaluationResultData.

Nota:

Los cmdlets Export y Template no devuelven un resultado personalizado.

                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 muestra una lista con una entrada por cada componente seleccionado. La clave es el nombre del componente y el valor es una lista de cada miembro del componente y la acción realizada sobre ese miembro del componente. Las acciones pueden ser cualquiera de los valores ActionResultValues.

Added, Updated, Deleted y NoChange indican el número total de miembros del componente añadidos, actualizados, eliminados o sin acción, en ese orden.

TotalChanged es la suma de Added, Updated y Deleted.

OverallResult es un valor booleano único que indica el resultado del cmdlet. True indica éxito total en todos los componentes y false indica un fallo en el procesamiento de uno o más componentes.

CloudBackupFolder es la especificación de archivo completa de la copia de seguridad de la configuración del sitio en la nube antes de que el cmdlet realice cualquier acción de modificación en la nube.

SourceBackupFolder es la especificación de archivo completa de la copia de seguridad del archivo de origen realizada después de la finalización del cmdlet. De forma predeterminada, estos archivos se encuentran en %HOMEPATH%\Documents\Citrix\AutoConfig.

Ayuda de PowerShell

La ayuda de PowerShell está disponible para cada cmdlet. Todos los parámetros están documentados con cada cmdlet junto con una breve explicación del cmdlet. Para acceder a la ayuda de cualquier cmdlet, escriba Get-Help delante del cmdlet.

Get-Help Import-CvadAcToSite