Cmdlets de la herramienta de Configuración automatizada

En esta página se enumeran todos los cmdlets y parámetros que ofrece la herramienta.

Todos los cmdlets toman parámetros que tienen uno de estos 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 true o false, pero los booleanos se siguen utilizando en la herramienta por problemas antiguos.

Esta tabla es un resumen de todos los cmdlets. Consulte cada sección para averiguar qué parámetros admite cada cmdlet.

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

Cmdlets básicos

Cmdlets de configuraciones locales a la nube

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

  Exporta la configuración desde su instalación local. Esta es la operación predeterminada de exportación de 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 con el nombre exclusivo Export. La carpeta %HOMEPATH%\Documentos\Citrix\AutoConfig siempre contiene la configuración del sitio local exportada más reciente.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  AdminAddress	Especifica la dirección IP o DNS del Delivery Controller cuando la exportación no se ejecuta en el Delivery Controller.		Cadena
  CheckUserAndMachines	Comprueba si los usuarios y las máquinas están presentes en Active Directory. Los usuarios y las máquinas que no están en Active Directory pueden dar lugar a errores de importación.		$true o $false
  ZipResults	Comprime las copias de seguridad de los archivos YAML en un único archivo ZIP. El archivo se encuentra en la misma carpeta que las copias de seguridad de los archivos YAML y tiene el mismo nombre que la carpeta.		SwitchParameter

  Devuelve:

  • Consulte Valores devueltos de cmdlet

Existen 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 del sitio de la nube:

• Add, Update y Delete
• Add y Update solamente
• Add solamente

• Import-CvadAcToSite: Importa archivos YAML a la nube. Permite operaciones de creación, actualización y eliminación.

  Importa todos los archivos locales en la nube. Este comando garantiza que el estado final de la nube sea idéntico al estado local. Esta opción elimina los cambios que existan en la nube. Los archivos de configuración de sitios importados proceden de %HOMEPATH%\Documents\Citrix\AutoConfig. Úsela con cuidado.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 alternativa para %HOMEPATH%\Documentos\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros 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 agrega componentes al sitio de la nube. Los componentes no se quitan. Establézcalo en $false para quitar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo agrega componentes nuevos y no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Merge se ignora cuando este parámetro tiene el valor $true.		$true o $false
  MergePolicies	Fusiona parámetros de directivas y filtros. La fusión se produce solamente cuando una directiva que se está importando ya existe en el DDC de la nube. El resultado de la fusión de directivas es que las directivas de DDC de la nube contienen los parámetros y los filtros que ya tenía, así como los parámetros y filtros nuevos que se importen. Tenga en cuenta que, cuando se producen colisiones entre parámetros y filtros, los valores importados son prioritarios.		SwitchParameter
  OnErrorAction	Consulte Parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

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

  Fusiona los archivos locales en la nube, pero no elimina ningún componente de la nube ni del sitio local. Esto preserva los cambios ya realizados en la nube. Si existe un componente en Citrix Cloud con el mismo nombre, este comando puede modificarlo. Esta es la operación predeterminada de importación de la Configuración automatizada. Los archivos de configuración de sitios combinados proceden de %HOMEPATH%\Documents\Citrix\AutoConfig.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 alternativa para %HOMEPATH%\Documentos\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros 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 agrega componentes al sitio de la nube. Los componentes no se quitan. Establézcalo en $false para quitar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo agrega componentes nuevos y no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Merge se ignora cuando este parámetro tiene el valor $true.		$true o $false
  MergePolicies	Fusiona parámetros de directivas y filtros. La fusión se produce solamente cuando una directiva que se está importando ya existe en el DDC de la nube. El resultado de la fusión de directivas es que las directivas de DDC de la nube contienen los parámetros y los filtros que ya tenía, así como los parámetros y filtros nuevos que se importen. Tenga en cuenta que, cuando se producen colisiones entre parámetros y filtros, los valores importados son prioritarios.		SwitchParameter
  OnErrorAction	Consulte Parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

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

  Importa la configuración de un sitio local en 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 del sitio en la nube deben permanecer sin cambios.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 alternativa para %HOMEPATH%\Documentos\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false
  OnErrorAction	Consulte Parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

• Sync-CvadAcToSite: Exporta e importa archivos en un solo paso.

  Sync 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
  Migración por componentes	Consulte Migración 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
  SourceTargetFolder	Especifica la carpeta de destino de exportación/importación.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  AdminAddress	Especifica la dirección IP o el DNS del Delivery Controller cuando la exportación no se ejecuta en el Delivery Controller.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros 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 agrega componentes al sitio de la nube. Los componentes no se quitan. Establézcalo en $false para quitar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo agrega componentes nuevos y no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Merge se ignora cuando este parámetro tiene el valor $true.		$true o $false
  MergePolicies	Fusiona parámetros de directivas y filtros. La fusión se produce solamente cuando una directiva que se está importando ya existe en el DDC de la nube. El resultado de la fusión de directivas es que las directivas de DDC de la nube contienen los parámetros y los filtros que ya tenía, así como los parámetros y filtros nuevos que se importen. Tenga en cuenta que, cuando se producen colisiones entre parámetros y filtros, los valores importados son prioritarios.		SwitchParameter

  Devuelve:

  • Consulte Valores devueltos de cmdlet

Cmdlets de nube a nube

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

  Exporta la configuración de la nube en archivos YML. Esta copia de seguridad se puede utilizar en un proceso de copia de seguridad y restauración para restaurar componentes perdidos.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración por componentes		SwitchParameters
  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.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false
  ZipResults	Comprime las copias de seguridad de los archivos YAML en un único archivo ZIP. El archivo se encuentra en la misma carpeta que las copias de seguridad de los archivos YAML y tiene el mismo nombre que la carpeta.		SwitchParameter

  Devuelve:

  • Consulte Valores devueltos de cmdlet

• Restore-CvadAcToSite: Restaura copias de seguridad de archivos YAML en el sitio de la nube. Este sitio de la nube puede ser el mismo o uno distinto del sitio de 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 que restaurar en el sitio de la nube. Debe ser una especificación de carpeta completa. Este cmdlet se puede utilizar para volver a la configuración anterior o para hacer copias de seguridad y restaurar su sitio en la nube. Este comando puede agregar, eliminar y actualizar su sitio de la nube.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 va a restaurar en el sitio en la nube. Debe ser una especificación de carpeta completa.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros 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 agrega componentes al sitio de la nube. Los componentes no se quitan. Establézcalo en $false para quitar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo agrega componentes nuevos y no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Merge se ignora cuando este parámetro tiene el valor $true.		$true o $false
  MergePolicies	Fusiona parámetros de directivas y filtros. La fusión se produce solamente cuando una directiva que se está importando ya existe en el DDC de la nube. El resultado de la fusión de directivas es que las directivas de DDC de la nube contienen los parámetros y los filtros que ya tenía, así como los parámetros y filtros nuevos que se importen. Tenga en cuenta que, cuando se producen colisiones entre parámetros y filtros, los valores importados son prioritarios.		SwitchParameter
  OnErrorAction	Consulte Parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

• Remove-CvadAcFromSite: Quita miembros de componentes de la nube.

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

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true o $false

  Devuelve:

  • Consulte Valores devueltos de cmdlet

Otros cmdlets básicos

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

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 alternativa para %HOMEPATH%\Documentos\Citrix\AutoConfig.		Cadena
  Locale	Especifica el idioma del texto en formato legible para las personas que se puede exportar.		Cadena
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros 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 agrega componentes al sitio de la nube. Los componentes no se quitan. Establézcalo en $false para quitar componentes.		$true o $false
  AddOnly	Cuando se establece en $true, solo agrega componentes nuevos y no actualiza ni elimina componentes existentes. Establézcalo en $false para permitir actualizaciones y eliminaciones. Merge se ignora cuando este parámetro tiene el valor $true.		$true o $false
  OnErrorAction	Consulte Parámetro OnErrorAction.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

Parámetros de migración granular

Migración por componentes

Los siguientes componentes se pueden especificar con cmdlets que los admitan. La opción All se selecciona automáticamente cuando no se especifica ningún parámetro de componente. Para evitar errores, le recomendamos migrar los componentes en este orden:

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

Filtrado por nombres de objeto

Migración por nombres de componentes

Los parámetros IncludeByName y ExcludeByName permiten incluir y excluir por nombre miembros de componentes en cmdlets. Solo se puede elegir un componente (por ejemplo, grupos de entrega) en un momento dado en cualquiera de los cmdlets compatibles. Si un miembro de un componente se halla en las dos zonas, la exclusión supedita cualquier otro parámetro, y se crea una entrada en la lista Fixups del registro que identifica el componente y el nombre del miembro excluidos.

IncludeByName y ExcludeByName toman una lista de nombres de miembros de componentes. Los nombres pueden contener comodines. Se admiten dos tipos de comodines. La lista de nombres de miembros de componentes debe estar entre comillas simples si alguno de esos nombres contiene caracteres especiales.

• * coincide con cualquier cantidad 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 comodines. Cada línea del archivo puede contener un miembro. Los espacios del principio y del final se recortan del nombre del miembro. El nombre del archivo debe ir precedido por el signo @ y estar rodeado por comillas simples (un requisito de PowerShell para que no se reinterprete @). Se pueden enumerar varios archivos, además de mezclarse con nombres de miembros.

Un ejemplo de fusión de todos los grupos de entrega cuyos nombres comiencen por DgSite1 y contengan 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 incluirán en función de su asociación de grupos de entrega.

ByDeliveryGroupName toma una lista de nombres de grupos de entrega. Los nombres pueden contener comodines. Se admiten dos tipos de comodines.

• * coincide con cualquier cantidad de caracteres
• ? coincide con un solo carácter

En el ejemplo siguiente se combinan todas las aplicaciones que hacen referencia a todos los nombres de grupos de entrega que empiezan por EastDg.

Merge-CvadAcToSite –Applications –ByDeliveryGroupName EastDg*

Excluir inhabilitado

ExcludeDisabled filtra de las operaciones de importación todas las aplicaciones y grupos de aplicaciones que están inhabilitados. ExcludeDisabled tiene como valor predeterminado false, lo que significa que se importan todas las aplicaciones y grupos de aplicaciones independientemente de su estado habilitado.

Por nombre de máquina

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

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

• * coincide con cualquier cantidad de caracteres
• ? coincide con un solo carácter

Si al exportar o importar y utilizar 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 grupo de entrega se excluyen de la exportación o importación.

Nota:

Al usar ByMachineName en cualquier cmdlet de tipo “importación”, MergeMachines se establece en $true.

Fusionar máquinas

Cuando MergeMachines se establece en $true, indica a la operación de importación que agregue máquinas solo al catálogo de máquinas o al grupo de entrega. Las máquinas no se quitan, lo que posibilita las operaciones aditivas incrementales.

El valor predeterminado de MergeMachines es “false”, lo que significa que las máquinas se quitan si no están presentes en el archivo YML del catálogo de máquinas o el grupo de entrega. Cuando se usa ByMachineName, MergeMachines se establece en $true, pero se puede anular estableciendo MergeMachines en “false”.

Cmdlets relacionados con requisitos previos

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

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  CustomerId	ID del cliente.	x	Cadena
  ClientId	ID de la máquina cliente creado en Citrix Cloud. Deben especificarse los campos CustomerId y Secret al utilizar este parámetro.	Con condiciones	Cadena
  Secret	Clave secreta del cliente creada en Citrix Cloud. Deben especificarse los campos CustomerId y ClientId al utilizar este parámetro.	Con condiciones	Cadena
  Environment	Entorno Production, ProductionGov o ProductionJP.		Enumeración
  LogFileName	Cambie el prefijo del archivo de registros de CitrixLog a otra cosa.		Cadena
  AltRootUrl	Utilícelo solo si se lo indica Citrix.		Cadena
  StopOnError	Detiene la operación tras el primer error.		$true o $false
  TargetFolder	Utilice la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documentos\Citrix\AutoConfig.		Cadena
  Locale	Utilice la configuración regional especificada, en lugar de la configuración regional 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 para el editor, y el editor debe tomar la especificación del archivo de registro como único parámetro.		Cadena
  SecurityCsvFileSpec	La especificación de archivo completo que apunta al archivo SecurityClient.csv descargado de la Administración de acceso e identidad de Citrix. Debe especificarse el campo CustomerId al utilizar este parámetro.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

• Set-CvadAcCustomerInfoFile: Actualice un archivo de información del cliente existente. Solo se cambian los parámetros especificados por el cmdlet. Todos los valores de parámetros sin especificar en el archivo CustomerInfo.yml permanecen igual.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  CustomerId	ID del cliente.		Cadena
  ClientId	ID de la máquina cliente creado en Citrix Cloud.		Cadena
  Secret	Clave secreta del cliente creada en Citrix Cloud.		Cadena
  Environment	Entorno Production, ProductionGov o ProductionJP.		Enumeración
  LogFileName	Cambie el prefijo del archivo de registros de CitrixLog a otra cosa.		Cadena
  StopOnError	Detiene la operación tras el primer error.		$true o $false
  TargetFolder	Utilice la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documentos\Citrix\AutoConfig.		Cadena
  Locale	Utilice la configuración regional especificada, en lugar de la configuración regional 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 para el editor, y el editor debe tomar la especificación del archivo de registro como único parámetro.		Cadena
  SecurityCsvFileSpec	La especificación de archivo completo que apunta al archivo SecurityClient.csv descargado de la Administración de acceso e identidad de Citrix. Debe especificarse el campo CustomerId al utilizar este parámetro.		Cadena

  Devuelve:

  • Consulte Valores devueltos de cmdlet

Parámetros relacionados con requisitos previos

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

• Environment: Entorno Production o ProductionGov.
• LogFileName: Cambie el prefijo del archivo de registro de CitrixLog a otra cosa.
• StopOnError: Detiene la operación tras el primer error.
• AlternateRootFolder: Utilice la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documentos\Citrix\AutoConfig.
• Locale: Utilice la configuración regional especificada, en lugar de la configuración regional 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 para el editor, y el editor debe tomar la especificación del archivo de registro como único parámetro.

Asistencia y solución de problemas con cmdlets

• New-CvadAcZipInfoForSupport: Comprime todos los archivos de registro e YML en un único archivo ZIP para enviarlos a Citrix para asistencia técnica. 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%\Documentos\Citrix\AutoConfig y se denomina CvadAcSupport_yyyy_mm_dd_hh_mm_ss.zip, según la fecha y la marca de hora. Este archivo ZIP también puede servir de 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	Suprime los registros en la consola.		SwitchParameter

  Devuelve:

  • El archivo ZIP, con su nombre y ubicación, se muestra en el símbolo del sistema.

• Get-CvadAcStatus: Se utiliza para probar la conectividad y garantizar 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 IP o DNS del Delivery Controller local utilizado para verificar el nivel de acceso de los administradores. Es necesario si la herramienta no se está ejecutando 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 comprobar que la conexión de comunicación funciona. Este cmdlet emplea los parámetros de acceso a la nube o el archivo CustomerInfo.yml de información del cliente 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 los registros en la consola.		SwitchParameter

  Devuelve:

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

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

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  CustomerInfoFileSpec	La especificación de archivo que apunta a un archivo de información del cliente para supeditar 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 supedita el mismo valor del archivo CustomerInfo.yml.		Cadena

  Devuelve:

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

• Get-CvadAcCustomerSites: Devuelve la lista de todos los sitios del cliente. Este cmdlet emplea los parámetros de acceso a la nube o el archivo CustomerInfo.yml de información del cliente 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 identificadores de sitios del 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
  Migración por componentes	Consulte Migración por componentes		SwitchParameters
  TargetFolder	Especifica la carpeta de destino de la exportación.		Cadena

  Devuelve:

  • Consulte Valores devueltos de 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: En las búsquedas de archivos, busca archivos YAML de componentes en busca de miembros que coincidan con uno o varios nombres que pueden contener caracteres comodín. El resultado es un informe de los miembros encontrados. En las búsquedas de archivos, solo se puede buscar un componente a la vez. En las búsquedas de archivos, se busca en todos los archivos YAML de la carpeta actual y todas sus subcarpetas. Se utiliza FindSourceFolder para limitar la cantidad de archivos en los que buscar.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  Migración por componentes	Consulte Migración 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 del sitio como activo. Se admiten los comodines “*” y “?” en los nombres.		Lista de cadenas
  Unique	Notifica solamente miembros encontrados y únicos.		SwitchParameter
  IncludeYaml	Incluye el YAML específico del miembro.		SwitchParameter
  FindSourceFolder	La carpetas en que comienza la búsqueda.		Cadena
  DisplayLog	Muestra el archivo de registros al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		SwitchParameter
  Quiet	Suprime los registros en la consola.		SwitchParameter

  Devuelve:

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

Cmdlets de activación del sitio

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

• Set-CvadAcSiteActiveStateOnPrem: Establece el estado del sitio local 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 local en activo y quita el modo de mantenimiento de todos los grupos de entrega. Cuando este parámetro no está presente, se establece el modo de mantenimiento 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 del sitio como activo. Se admiten los comodines “*” y “?” en 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 del sitio como activo. Se admiten los comodines “*” y “?” en los nombres.		Lista de cadenas
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true or $false

  Devuelve:

  • Consulte Valores devueltos de 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 de la nube en activo y quita el modo de mantenimiento de todos los grupos de entrega. Cuando este parámetro no está presente, se establece el modo de mantenimiento 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 del sitio como activo. Se admiten los comodines “*” y “?” en 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 del sitio como activo. Se admiten los comodines “*” y “?” en los nombres.		Lista de cadenas
  Quiet	Suprime los registros en la consola.		SwitchParameter
  DisplayLog	Muestra el archivo de registros al finalizar el cmdlet. Establézcalo en $false para suprimir la visualización del registro.		$true or $false

  Devuelve:

  • Consulte Valores devueltos de cmdlet

Cmdlets sobre la fusión de varios sitios locales

Para obtener más información acerca de la combinación de sitios y el uso de estos cmdlets, consulte Fusionar varios sitios en uno.

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

  Nombre	Descripción	¿Obligatorio?	Tipo
  SiteName	El nombre utilizado para identificar el conjunto de prefijos/sufijos de 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	Suprime los registros en la consola.		SwitchParameter

  Devuelve:

  • Ninguno

• Set-CvadAcSiteMergingInfo: Actualiza un sitio fusionando el conjunto de información de prefijo/sufijo.

  Parámetros:

  Nombre	Descripción	¿Obligatorio?	Tipo
  SiteName	El nombre utilizado para identificar el conjunto de prefijos/sufijos de 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	Suprime los registros en la consola.		SwitchParameter

  Devuelve:

  • Ninguno

• Remove-CvadAcSiteMergingInfo: Quita un sitio fusionando el conjunto de información de prefijo/sufijo.

  Parámetros:

  • SiteName: Identifica el conjunto de prefijos y sufijos del sitio. Se trata de una cadena y es obligatoria.

  Devuelve:

  • Ninguno

Parámetros de fusión de sitios

Estos parámetros se pueden utilizar al ejecutar los cmdlets de fusión de sitios. Todos los parámetros que se indican son cadenas.

• SiteName: El nombre utilizado para identificar el conjunto de prefijos/sufijos de 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 aplica a los ámbitos de administrador.
• ApplicationPrefix: El prefijo que se aplica a las aplicaciones.
• ApplicationFolderPrefix: El prefijo que se aplica a las carpetas de aplicaciones; ApplicationFolderPrefix puede combinarse con ApplicationFolderRoot.
• ApplicationFolderRoot: La nueva carpeta raíz de las carpetas de aplicaciones. Crea una jerarquía de carpetas adicional. ApplicationFolderRoot puede combinarse con ApplicationFolderPrefix.
• ApplicationGroupPrefix: El prefijo de los grupos de aplicaciones.
• ApplicationUserPrefix: El prefijo que se aplica al nombre de la aplicación que ve el usuario.
• ApplicationAdminPrefix: El prefijo que se aplica al nombre de la aplicación que ve el administrador.
• DeliveryGroupPrefix: El prefijo que se aplica a los grupos de entrega.
• GroupPolicyPrefix: El prefijo que se aplica a los nombres de directivas.
• HostConnectionPrefix: El prefijo que se aplica a las conexiones de host.
• MachineCatalogPrefix: El prefijo que se aplica a los catálogos de máquinas.
• StoreFrontPrefix: El prefijo que se aplica a los nombres de StoreFront.
• TagPrefix: El prefijo que se aplica a las etiquetas.
• AdminScopedSuffix: El sufijo que se aplica a los ámbitos de administrador.
• ApplicationSuffix: El sufijo que se aplica a las aplicaciones.
• ApplicationFolderSuffix: El sufijo que se aplica a las carpetas de aplicaciones; ApplicationFolderSuffix puede combinarse con ApplicationFolderRoot.
• ApplicationGroupSuffix: El sufijo de los grupos de aplicaciones.
• ApplicationUserSuffix: El sufijo que se aplica al nombre de la aplicación que ve el usuario.
• ApplicationAdminSuffix: El sufijo que se aplica al nombre de la aplicación que ve el administrador.
• DeliveryGroupSuffix: El sufijo que se aplica a los grupos de entrega.
• GroupPolicySuffix: El sufijo que se aplica a los nombres de directivas.
• HostConnectionSuffix: El sufijo que se aplica a las conexiones de host.
• MachineCatalogSuffix: El sufijo que se aplica a los catálogos de máquinas.
• StoreFrontSuffix: El sufijo que se aplica a los nombres de StoreFront.
• TagSuffix: El sufijo que se aplica 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.

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 parámetros siguientes. Cuando se especifican en ambos lugares, los parámetros del cmdlet tienen prioridad.

• CustomerId: El ID del cliente utilizado en las API de REST. Es necesario para acceder a todas las API de REST. Su ID de cliente se encuentra en Citrix Cloud.
• ClientId: El parámetro clientID creado en el sitio web de administración de acceso e identidad de Citrix Cloud. Es necesario para obtener el token de portador requerido para la autenticación de todas las API de REST.
• Secret: La clave secreta creada en el sitio web de administración de acceso e identidad de Citrix Cloud. Es necesario para obtener el token de portador requerido 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 supeditar la ubicación y el nombre predeterminados.

Parámetros de los modos de migración

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

• CheckMode: Lleva a cabo la operación de importación pero no realiza cambios. Todos los cambios esperados se notifican antes de que se complete la importación. Puede utilizar este comando para probar la importación antes de que esta se produzca.
• BackupFirst: Hace una copia de seguridad del contenido de la nube en archivos YML antes modificar la configuración de la nube. Esto está habilitado de forma predeterminada.
• Confirm: Si el valor es true, solicita a los usuarios que confirmen si quieren efectuar cambios en la configuración del sitio en la nube. El cmdlet Remove muestra un mensaje debido a su naturaleza destructiva. Establézcalo en false si no quiere ningún mensaje, como en la ejecución en scripts automatizados. El valor predeterminado de Confirm es true.
• SecurityFileFolder: Esta es la carpeta completa que contiene el archivo CustomerInfo.yml, que es posible que apunte a una carpeta local o a una carpeta compartida de red que pueda 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 conjunto de prefijos y sufijos de fusión de sitios que va a utilizarse al importar.
• SiteActive: Especifica si el sitio importado está activo o inactivo. De forma predeterminada, este parámetro se establece en $false, lo que indica que el sitio importado está inactivo.

Parámetros de visualización del registro

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

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

Valores devueltos de 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 estado global del proceso del cmdlet en todos los componentes seleccionados: “true” significa que el proceso se completó correctamente y “false” significa que no se completó correctamente.

Individual_Success devuelve uno o tres valores para cada componente principal. El resultado de un componente puede ser Success (Correcto), Failure (Error) o Skipped (Omitido). Skipped indica que el cmdlet no seleccionó dicho componente para su ejecución.

CustomResult es específico de cada cmdlet.

CustomResult

Import, Merge, Restore, Sync, Compare, Compare File y Remove devuelven la siguiente información de resultados personalizados a una sola 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 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 en el miembro correspondiente del componente. Las acciones pueden ser cualquiera de los valores de ActionResultValues.

Added, Updated, Deleted y NoChange indican la cantidad total de componentes que los miembros agregaron, actualizaron, eliminaron o para los que no se realizó ninguna acción, en ese orden.

TotalChanged es la suma de Added, Updated y Deleted.

OverallResult es un único valor booleano que indica el resultado del cmdlet. “True” indica que el proceso se completó correctamente en todos los componentes, y “false” indica un error en el procesamiento de uno o más componentes.

CloudBackupFolder es la especificación de archivo válido de la copia de seguridad de la configuración del sitio en la nube antes de que el cmdlet lleve a cabo acciones de modificación de la nube.

SourceBackupFolder es la especificación de archivo válido de la copia de seguridad del archivo de origen realizada después de que el cmdlet haya finalizado. De forma predeterminada, estos archivos se hallan en %HOMEPATH%\Documentos\Citrix\AutoConfig.

Ayuda de PowerShell

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

Get-Help Import-CvadAcToSite