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:
$trueo$false - SwitchParameter: la presencia del parámetro significa
$true; la ausencia del parámetro significa$false
Nota:
SwitchParameter es el método preferido para selecciones de verdadero o falso, pero los booleanos todavía se usan en la herramienta debido a problemas de compatibilidad.
La siguiente tabla es un resumen de todos los cmdlets. Consulta cada sección individual para encontrar qué parámetros admite cada cmdlet.
|Categoría|Cmdlet|Descripción|
|—|—|—|
|[Migración de local a la nube](#on-premises-to-cloud-cmdlets)|Export-CvadAcToFile|Exporta archivos locales a archivos YAML.|
|^^|Import-CvadAcToSite|Importa archivos YAML a la nube. Admite operaciones de creación, actualización y eliminación.|
|^^|Merge-CvadAcToSite|Importa archivos YAML a la nube. Admite operaciones de creación y actualización.|
|^^|New-CvadAcToSite|Importa archivos YAML a la nube. Admite operaciones de creación y actualización.|
|^^|Sync-CvadAcToSite|Exporta e importa en un solo paso.|
|^^|*Migración granular* Para componentes, usa parámetros con los comandos anteriores. Ejemplos: MachineCatalogs, Tags. Para nombres de componentes, usa parámetros con los comandos anteriores. Ejemplos: IncludeByName, ExcludeByName.|Migra selectivamente solo componentes o nombres de componentes|
|[Cmdlets de nube a nube](#cloud-to-cloud-cmdlets)|Backup-CvadAcToFile|Realiza una copia de seguridad de toda la configuración de tu sitio en la nube.|
|^^|Restore-CvadAcToSite|Restaura archivos YAML de copia de seguridad en el sitio en la nube. Este sitio en la nube puede ser el mismo o diferente al sitio en la nube de origen.|
|^^|Remove-CvadAcFromSite|Quita miembros de componentes de la nube.|
|^^|*Migración granular* Para componentes, usa parámetros con los comandos anteriores. Ejemplos: MachineCatalogs, Tags. Para nombres de componentes, usa parámetros con los comandos anteriores. Ejemplos: IncludeByName, ExcludeByName.|Migra selectivamente solo componentes o nombres de componentes|
|[Otros cmdlets básicos](#other-basic-cmdlets)|Compare-CvadAcToSite|Compara los archivos .yml locales con la configuración de la nube.|
|[Cmdlets relacionados con los requisitos previos](#prerequisites-related-cmdlets)|New-CvadAcCustomerInfoFile|Crea un archivo de información del cliente.|
|^^|Set-CvadAcCustomerInfoFile|Actualiza un archivo de información del cliente existente.|
|[Cmdlets de asistencia y solución de problemas](#support-and-troubleshooting-cmdlets)|New-CvadAcZipInfoForSupport|Comprime todos los archivos de registro y .yml en un único archivo zip para enviar a Citrix® para asistencia.|
|^^|Get-CvadAcStatus|Úsalo para probar la conectividad y asegurarte 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.|
|^^|Test-CvadAcConnectionWithSite|Prueba la conexión con el sitio en la nube.|
|^^|Find-CvadAcConnector|Localiza los conectores existentes y determina su estado de ejecución.|
|^^|Get-CvadAcCustomerSites|Devuelve la lista de todos los sitios de clientes.|
|^^|New-CvadAcTemplateToFile|Crea un archivo de plantilla para los componentes seleccionados.|
|^^|Show-CvadAcDocument|Muestra esta documentación en el navegador predeterminado.|
|^^|Find-CvadAcInFile|Buscar en archivo busca en los archivos YAML de componentes miembros que coincidan con uno o más nombres que pueden contener comodines.|
|[Cmdlets de activación de sitios](#site-activation-cmdlets)|Set-CvadAcSiteActiveStateOnPrem|Establece el estado del sitio local como activo o inactivo.|
|^^|Set-CvadAcSiteActiveStateCloud|Establece el estado del sitio en la nube como activo o inactivo.|
|[Cmdlets de fusión de varios sitios locales](#merging-multiple-on-premises-sites-cmdlets)|New-CvadAcSiteMergingInfo|Crea un conjunto de información de prefijo/sufijo de fusión de sitios.|
|^^|Set-CvadAcSiteMergingInfo|Actualiza un conjunto de información de prefijo/sufijo de fusión de sitios existente.|
|^^|Remove-CvadAcSiteMergingInfo|Quita un conjunto de información de prefijo/sufijo de fusión de sitios existente.|
Para obtener más información sobre los parámetros y cómo usarlos, consulta 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 tu 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|Consulta \[Migrar por componentes]\(#migrate-by-components)\||SwitchParameters|
|Filtrado por nombres de objeto|Consulta \[Filtrado por nombres de objeto]\(#filtering-by-object-names)\||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 está en la misma carpeta que los archivos YAML de copia de seguridad y tiene el mismo nombre que la carpeta.\||SwitchParameter| <!--- table-end --->
Devuelve:
- Consulta [Valores de retorno de cmdlet](#cmdlet-return-values)
Hay tres formas de importar datos a la nube. La ejecución de cmdlets específicos puede dar como resultado una de las tres combinaciones de acciones en el sitio en la nube:
- Agregar, actualizar y eliminar
- Solo agregar y actualizar
- Solo agregar
| Cmdlet | Agregar | Actualizar | Eliminar | | — |— | — | — | | Importar | X | X | X | | Fusionar | X | X | | | Nuevo | X | | |
-
Import-CvadAcToSite- Importa 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 que exista en la nube. Los archivos de configuración del sitio importados se obtienen de %HOMEPATH%\Documents\Citrix\AutoConfig. Úsalo con precaución.
Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|---|---|---|---|
|Migrar por componentes|Consulta \[Migrar por componentes]\(#migrate-by-components).\||SwitchParameters|
|Filtrado por nombres de objeto|Consulta \[Filtrado por nombres de objeto]\(#filtering-by-object-names).\||Lista de cadenas|
|Parámetros de acceso a la nube|Consulta \[Parámetros de acceso a la nube]\(#cloud-accessing-parameters).\||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. Establécelo 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 quitan. Establécelo en `$false` para quitar componentes.\||`$true` o `$false`|
|`AddOnly`|Cuando se establece en `$true`, solo agrega componentes nuevos, no actualiza ni elimina componentes existentes. Establécelo en `$false` para permitir actualizaciones y eliminaciones. `Merge` se ignora cuando este parámetro es `$true`.\||`$true` o `$false`|
|`MergePolicies`|Fusiona la configuración y los filtros de la política. La fusión ocurre solo cuando una política que se importa 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. Ten en cuenta que cuando ocurren colisiones de configuración y filtros, los valores importados tienen prioridad. \||SwitchParameter|
|`OnErrorAction`|Consulta \[parámetro OnErrorAction]\(/es-es/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).\||Cadena| <!--- table-end --->
Devuelve:
-
Consulta Valores devueltos del 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|Consulta \[Migrar por componentes]\(#migrate-by-components).\||SwitchParameters|
|Filtrado por nombres de objeto|Consulta \[Filtrado por nombres de objeto]\(#filtering-by-object-names).\||List of strings|
|Parámetros de acceso a la nube|Consulta \[Parámetros de acceso a la nube]\(#cloud-accessing-parameters).\||SwitchParameters|
|`SourceFolder`|Identifica una carpeta raíz sustituta para \*%HOMEPATH%\Documents\Citrix\AutoConfig\*.\||String|
|`Locale`|Especifica el idioma del texto legible por humanos que se puede exportar.\||String|
|`Quiet`|Suprime el registro en la consola.\||SwitchParameter|
|`DisplayLog`|Muestra el archivo de registro al finalizar el cmdlet. Establécelo 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 quitan. Establécelo en `$false` para quitar componentes.\||`$true` o `$false`|
|`AddOnly`|Cuando se establece en `$true`, solo agrega componentes nuevos, no actualiza ni elimina componentes existentes. Establécelo 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. Ten en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.\||SwitchParameter|
|`OnErrorAction`|Consulta \[Parámetro OnErrorAction]\(/es-es/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).\||String| <!--- table-end --->
Devuelve:
- Consulta [Valores devueltos del cmdlet](#cmdlet-return-values)
-
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 componentes nuevos. Los componentes existentes del sitio en la nube no se actualizan ni se eliminan. Usa este comando si tus componentes existentes del sitio en la nube deben permanecer sin cambios.
Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|---|---|---|---|
|Migrar por componentes|Consulta \[Migrar por componentes]\(#migrate-by-components).\||SwitchParameters|
|Filtrado por nombres de objeto|Consulta \[Filtrado por nombres de objeto]\(#filtering-by-object-names).\||List of strings|
|Parámetros de acceso a la nube|Consulta \[Parámetros de acceso a la nube]\(#cloud-accessing-parameters).\||SwitchParameters|
|`SourceFolder`|Identifica una carpeta raíz sustituta para \*%HOMEPATH%\Documents\Citrix\AutoConfig\*.\||String|
|`Locale`|Especifica el idioma del texto legible por humanos que se puede exportar.\||String|
|`Quiet`|Suprime el registro en la consola.\||SwitchParameter|
|`DisplayLog`|Muestra el archivo de registro al finalizar el cmdlet. Establécelo en `$false` para suprimir la visualización del registro.\||`$true` o `$false`|
|`OnErrorAction`|Consulta \[Parámetro OnErrorAction]\(/es-es/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).\||String| <!--- table-end --->
Devuelve:
- Consulta [Valores devueltos del cmdlet](#cmdlet-return-values)
-
Sync-CvadAcToSite- Exporta e importa en un solo paso.Sync realiza una exportación y una importación en un solo paso. Usa el parámetro
SourceTargetFolderpara especificar la carpeta de destino de exportación/importación.Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|---|---|---|---|
|Migrar por componentes|Consulta \[Migrar por componentes]\(#migrate-by-components)\||SwitchParameters|
|Filtrado por nombres de objeto|Consulta \[Filtrado por nombres de objeto]\(#filtering-by-object-names)\||List of strings|
|Parámetros de acceso a la nube|Consulta \[Parámetros de acceso a la nube]\(#cloud-accessing-parameters)\||SwitchParameters|
|`SourceTargetFolder`|Especifica la carpeta de destino de exportación/importación.\||String|
|`Locale`|Especifica el idioma del texto legible por humanos que se puede exportar.\||String|
|`AdminAddress`|Especifica la dirección DNS o IP del controlador de entrega cuando la exportación no se ejecuta en el controlador de entrega.\||String|
|`Quiet`|Suprime el registro en la consola.\||SwitchParameter|
|`DisplayLog`|Muestra el archivo de registro al finalizar el cmdlet. Establécelo 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 quitan. Establécelo en `$false` para quitar componentes.\||`$true` o `$false`|
|`AddOnly`|Cuando se establece en `$true`, solo agrega componentes nuevos, no actualiza ni elimina componentes existentes. Establécelo 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. Ten en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.\||SwitchParameter| <!--- table-end --->
Devuelve:
- Consulta [Valores devueltos del cmdlet](#cmdlet-return-values)
Cmdlets de nube a nube
-
Backup-CvadAcToFile- Realiza una copia de seguridad de toda la configuración de tu sitio en la nube.Exporta la configuración de tu nube a archivos .yml. Esta copia de seguridad se puede usar en un proceso de copia de seguridad y restauración para recuperar componentes perdidos.
Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|---|---|---|---|
|Migrar por componentes|Consulta \[Migrar por componentes]\(#migrate-by-components)\||SwitchParameters|
|Parámetros de acceso a la nube|Consulta \[Parámetros de acceso a la nube]\(#cloud-accessing-parameters)\||SwitchParameters|
|`TargetFolder`|Especifica la carpeta de destino de exportación.\||String|
|`Locale`|Especifica el idioma del texto legible por humanos que se puede exportar.\||String|
|`Quiet`|Suprime el registro en la consola.\||SwitchParameter|
|`DisplayLog`|Muestra el archivo de registro al finalizar el cmdlet. Establécelo 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 los que se ha hecho copia de seguridad y tiene el mismo nombre que la carpeta.\||SwitchParameter| <!--- table-end --->
Devuelve:
-
Consulta 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 que se van a restaurar en el sitio en la nube. Debe ser una especificación de carpeta completa. Este cmdlet se puede usar para revertir a la configuración anterior o para hacer una copia de seguridad y restaurar el sitio en la nube. Este comando puede agregar, quitar y actualizar el sitio en la nube.Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|—|—|—|—|
|Migrar por componentes|Consulta [Migrar por componentes](#migrate-by-components).||SwitchParameters|
|Filtrado por nombres de objeto|Consulta [Filtrado por nombres de objeto](#filtering-by-object-names).||List of strings|
|Parámetros de acceso a la nube|Consulta [Parámetros de acceso a la nube](#cloud-accessing-parameters).||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.||String|
|Locale|Especifica el idioma del texto legible por humanos que se puede exportar.||String|
|Quiet|Suprime el registro en la consola.||SwitchParameter|
|DisplayLog|Muestra el archivo de registro al finalizar el cmdlet. Establece 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 quitan. Establece en $false para quitar componentes.||$true o $false|
|AddOnly|Cuando se establece en $true, solo agrega componentes nuevos, no actualiza ni quita componentes existentes. Establece en $false para permitir actualizaciones y eliminaciones. Se omite 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 en la nube. El resultado de combinar directivas es que las directivas 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. Ten en cuenta que cuando se producen colisiones de configuración y filtros, los valores importados tienen prioridad.||SwitchParameter|
|OnErrorAction|Consulta [Parámetro OnErrorAction](/es-es/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).||String|
Devuelve:
-
Consulta Valores devueltos del cmdlet
-
Remove-CvadAcFromSite– Quita miembros de componentes de la nube.Puede restablecer todo el sitio o quitar elementos miembros de un componente (por ejemplo, quitar un catálogo de máquinas de la lista de catálogos). Esto se puede usar junto con el parámetro
IncludeByNamepara quitar selectivamente miembros específicos.Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|—|—|—|—|
|Migrar por componentes|Consulta [Migrar por componentes](#migrate-by-components)||SwitchParameters|
|Filtrado por nombres de objeto|Consulta [Filtrado por nombres de objeto](#filtering-by-object-names)||List of strings|
|Parámetros de acceso a la nube|Consulta [Parámetros de acceso a la nube](#cloud-accessing-parameters)||SwitchParameters|
|Quiet|Suprime el registro en la consola.||SwitchParameter|
|DisplayLog|Muestra el archivo de registro al finalizar el cmdlet. Establece en $false para suprimir la visualización del registro.||$true o $false|
Devuelve:
- Consulta Valores devueltos del cmdlet
Otros cmdlets básicos
-
Compare-CvadAcToSite- Compara los archivos .yml locales con la configuración en la nube, lo que produce un informe de los cambios realizados por un cmdletImport,MergeoRestore.Parámetros:
|Nombre|Descripción|¿Obligatorio?|Tipo|
|—|—|—|—|
|Migrar por componentes|Consulta [Migrar por componentes](#migrate-by-components).||SwitchParameters|
|Filtrado por nombres de objeto|Consulta [Filtrado por nombres de objeto](#filtering-by-object-names).||List of strings|
|Parámetros de acceso a la nube|Consulta [Parámetros de acceso a la nube](#cloud-accessing-parameters).||SwitchParameters|
|SourceFolder|Identifica una carpeta raíz sustituta para *%HOMEPATH%\Documents\Citrix\AutoConfig*.||String|
|Locale|Especifica el idioma del texto legible por humanos que se puede exportar.||String|
|Quiet|Suprime el registro en la consola.||SwitchParameter|
|DisplayLog|Muestra el archivo de registro al finalizar el cmdlet. Establece 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 quitan. Establece en $false para quitar componentes.||$true o $false|
|AddOnly|Cuando se establece en $true, solo agrega componentes nuevos, no actualiza ni quita componentes existentes. Establece en $false para permitir actualizaciones y eliminaciones. Se omite Merge cuando este parámetro es $true.||$true o $false|
|OnErrorAction|Consulta [Parámetro OnErrorAction](/es-es/citrix-daas/migrate/auto-config-troubleshoot.html#onerroraction-parameter).||String|
Devuelve:
- Consulta Valores devueltos del cmdlet
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, te recomendamos que migres los componentes en el siguiente orden:
AllTagsAdminRolesAdminScopesHostConnectionsMachineCatalogsStoreFrontsDeliveryGroupsApplicationGroupsApplicationFoldersApplicationsGroupPoliciesUserZonePreference
Filtrado por nombres de objeto
Migrar por nombres de componente
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 compatibles. Si un miembro de componente se encuentra en ambas áreas, la exclusión anula cualquier otro parámetro y se crea una entrada en la lista de corrección de registros que identifica el componente y el nombre del miembro excluido.
IncludeByName y ExcludeByName aceptan 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 aceptar 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 por el signo @ y 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 acepta una lista de nombres de grupos de entrega. Cualquier nombre puede contener uno o más caracteres comodín. Se admiten dos tipos de caracteres comodín.
- * 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 con 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 tiene un valor predeterminado de 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 acepta una lista de nombres de máquinas donde cualquier nombre puede contener uno o más caracteres comodín. Se admiten dos tipos de caracteres comodín.
- * coincide con cualquier número de caracteres
- ? coincide con un solo carácter
Al exportar o importar y usar ByMachineName, si un filtro de nombre de máquina no produce 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 excluye de la exportación o importación.
Nota:
El uso de
ByMachineNameen cualquier cmdlet de tipo de importación hace queMergeMachinesse establezca en$true.
Combinar máquinas
MergeMachines, cuando 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 permite operaciones aditivas incrementales.
MergeMachines tiene un valor predeterminado de false, lo que significa que las máquinas se quitan si no están presentes en el catálogo de máquinas o en el archivo .yml del grupo de entrega. MergeMachines se establece en $true cuando se usa ByMachineName, pero se puede anular configurando MergeMachines en false.
Cmdlets relacionados con los requisitos previos
-
New-CvadAcCustomerInfoFile- Crea un archivo de información del cliente. Por defecto, el archivo de información del cliente se encuentra en %HOMEPATH%\Documents\Citrix\AutoConfig.Parámetros:
|Name|Descripción|¿Obligatorio?|Type| |—|—|–|–| |
CustomerId|ID del cliente.|x|String| |ClientId|ID de cliente del cliente creado en Citrix Cloud. El CustomerId y el Secret deben especificarse al usar este parámetro.|Condicionalmente|String| |Secret|Clave secreta del cliente creada en Citrix Cloud. El CustomerId y el ClientId deben especificarse al usar este parámetro.|Condicionalmente|String| |Environment|Entorno de producción, ProductionGov o ProductionJP.||Enumeration| |LogFileName|Cambia el prefijo del archivo de registro de CitrixLog a otro.||String| |AltRootUrl|Usar solo bajo la dirección de Citrix.||String| |StopOnError|Detiene la operación al primer error.||$trueo$false| |TargetFolder|Usa la carpeta especificada como carpeta raíz en lugar de *%HOMEPATH%\Documents\Citrix\AutoConfig*.||String| |Locale|Usa la configuración regional especificada en lugar de la configuración regional derivada del sistema en el que se ejecuta la herramienta.||String| |Editor|Usa 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.||String| |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.||String|Devuelve:
- Consulta Valores de retorno del cmdlet
-
Set-CvadAcCustomerInfoFile- Actualiza un archivo de información del cliente existente. Solo se cambian los parámetros especificados del cmdlet. Todos los valores de parámetros no especificados en el archivo CustomerInfo.yml permanecen sin cambios.Parámetros:
Name Descripción ¿Obligatorio? Type CustomerIdID del cliente. String ClientIdID de cliente del cliente creado en Citrix Cloud. String SecretClave secreta del cliente creada en Citrix Cloud. String EnvironmentEntorno de producción, ProductionGov o ProductionJP. Enumeration LogFileNameCambia el prefijo del archivo de registro de CitrixLog a otro. String StopOnErrorDetiene la operación al primer error. $trueo$falseTargetFolderUsa la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documents\Citrix\AutoConfig. String LocaleUsa la configuración regional especificada en lugar de la configuración regional derivada del sistema en el que se ejecuta la herramienta. String EditorUsa 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. String SecurityCsvFileSpecLa 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. String Devuelve:
- Consulta Valores de retorno del cmdlet
Parámetros relacionados con los requisitos previos
Junto con los parámetros de acceso a la nube, los siguientes parámetros se pueden usar 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– Usa la carpeta especificada como carpeta raíz en lugar de %HOMEPATH%\Documents\Citrix\AutoConfig. -
Locale– Usa la configuración regional especificada en lugar de la configuración regional derivada del sistema en el que se ejecuta la herramienta. -
Editor– Usa 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 asistencia 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 obtener asistencia. La información confidencial del cliente (CustomerInfo.yml y CvadAcSecurity.yml) no se incluye en el 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 nombra 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:
Name Descripción ¿Obligatorio? Type TargetFolderEspecifica una carpeta de destino para crear y guardar el archivo zip. String QuietSuprime 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- Úsalo para probar la conectividad y asegurarte 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:
Name Descripción ¿Obligatorio? Type Parámetros de acceso a la nube Consulta Parámetros de acceso a la nube SwitchParameters SiteIdIdentifica el sitio al que conectarse. String AdminAddressEsta es la dirección DNS o IP del Delivery Controller local utilizada para verificar el nivel de acceso de los administradores. Esto es obligatorio si la herramienta no se ejecuta en un Delivery Controller. String
Devuelve:
-
Muestra los resultados de cada elemento.
-
Test-CvadAcConnectionWithSite– Comprueba la conexión con el sitio en la nube para verificar que la conexión de comunicación funciona. Este cmdlet usa 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 Consulta Parámetros de acceso a la nube SwitchParameters QuietSuprime 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 usa 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 CustomerInfoFileSpecLa 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.String CustomerIdEl ID del cliente. Este parámetro anula el mismo valor en el archivo CustomerInfo.yml. String Devuelve:
- Los resultados se muestran en la línea de comandos.
-
Get-CvadAcCustomerSites- Devuelve la lista de todos los sitios del cliente. Este cmdlet usa 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:
- Consulta Parámetros de acceso a la nube
Devuelve:
- Muestra una lista de los ID de sitio de cliente encontrados.
-
New-CvadAcTemplateToFile– Crea un archivo de plantilla para los componentes seleccionados, lo que te permite crear manualmente un archivo de importación.Parámetros:
Nombre Descripción ¿Obligatorio? Tipo Migrar por componentes Consulta Migrar por componentes SwitchParameters TargetFolderEspecifica la carpeta de destino de exportación. String Devuelve:
- Consulta Valores devueltos del cmdlet
-
Show-CvadAcDocument- Muestra esta documentación en el navegador predeterminado.Parámetros:
-
Ninguno.
Devuelve:
-
Muestra esta página web en el navegador web predeterminado.
-
Find-CvadAcInFile- La función de búsqueda en archivo busca en los archivos YAML de los componentes miembros que coincidan con uno o varios nombres que pueden contener caracteres comodín. El resultado es un informe de los miembros encontrados. La búsqueda en archivo solo puede buscar un componente a la vez. La búsqueda en archivo busca en todos los archivos YAML de la carpeta actual y de todas las subcarpetas. UsaFindSourceFolderpara limitar el número de archivos a buscar.
Parámetros:
| Nombre | Descripción | ¿Obligatorio? | Tipo |
|---|---|---|---|
| Migrar por componentes | Consulta 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 deben incluir al establecer el estado activo del sitio como activo. Se admiten los caracteres comodín ‘*’ y ‘?’ en los nombres. | Lista de cadenas | |
Unique |
Informa solo de los miembros encontrados únicos. | SwitchParameter | |
IncludeYaml |
Incluye el YAML específico del miembro. | SwitchParameter | |
FindSourceFolder |
La carpeta en la que comienza la búsqueda. | Cadena | |
DisplayLog |
Muestra el archivo de registro al finalizar el cmdlet. Establécelo en $false para suprimir la visualización del registro. |
SwitchParameter | |
Quiet |
Suprime 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, consulta 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 | Consulta 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 deben incluir al establecer el estado activo del sitio como activo. Se admiten los caracteres comodín ‘*’ y ‘?’ en 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 como activo. Se admiten los caracteres comodín ‘*’ y ‘?’ en los nombres. | Lista de cadenas | |
Quiet |
Suprime el registro en la consola. | SwitchParameter | |
DisplayLog |
Muestra el archivo de registro al finalizar el cmdlet. Establécelo en $false para suprimir la visualización del registro. |
$true o $false |
|
Devuelve:
-
Consulta Valores devueltos del cmdlet
-
Set-CvadAcSiteActiveStateCloud- Establece el estado del sitio en la nube como activo o inactivo.
Parámetros:
| Nombre | Descripción | ¿Obligatorio? | Tipo |
|---|---|---|---|
| Parámetros de acceso a la nube | Consulta 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 deben incluir al establecer el estado activo del sitio como activo. Se admiten los caracteres comodín ‘*’ y ‘?’ en 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 como activo. Se admiten los caracteres comodín ‘*’ y ‘?’ en los nombres. | Lista de cadenas | |
Quiet |
Suprime el registro en la consola. | SwitchParameter | |
DisplayLog |
Muestra el archivo de registro al finalizar el cmdlet. Establécelo en $false para suprimir la visualización del registro. |
$true o $false |
|
Devuelve:
- Consulta Valores devueltos 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, consulta 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 conSet-CvadAcSiteMergingInfoo editando 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 | Consulta Parámetros de fusión de sitios | SwitchParameters | |
Quiet |
Suprime 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 SiteNameEl nombre que se usa 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 String Parámetros de fusión de sitios Consulta Parámetros de fusión de sitios SwitchParameters QuietSuprime el registro en la consola. SwitchParameter Devuelve:
- Ninguno
-
Remove-CvadAcSiteMergingInfo- Quita un conjunto de información de prefijos/sufijos de fusión de sitios existente.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 usar al ejecutar los cmdlets de fusión de sitios. Todos los parámetros enumerados son cadenas.
-
SiteName– el nombre que se usa para identificar el conjunto de prefijos/sufijos para un sitio específico. Puede coincidir con el nombre del sitio real, pero no es necesario.SiteNamees 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;ApplicationFolderPrefixse puede combinar conApplicationFolderRoot. -
ApplicationFolderRoot– la nueva carpeta raíz para las carpetas de aplicaciones. Esto crea una jerarquía de carpetas adicional.ApplicationFolderRootse puede combinar conApplicationFolderPrefix. -
ApplicationGroupPrefix– el prefijo para 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 las 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;ApplicationFolderSuffixse puede combinar conApplicationFolderRoot. -
ApplicationGroupSuffix– el sufijo para 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 las 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 usa para 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:
Los parámetros
CustomerId,ClientIdySecretse pueden colocar en el archivoCustomerInfo.ymlo especificarse con el cmdlet usando los siguientes parámetros. Cuando se especifican en ambos lugares, los parámetros del cmdlet tienen prioridad.
-
CustomerId– el ID de cliente que se usa en las API de REST y es obligatorio para acceder a todas las API de REST. Tu ID de cliente se encuentra en Citrix Cloud. -
ClientId– el ID de cliente creado en el sitio web de Administración de identidades y accesos de Citrix Cloud. Es obligatorio 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 Administración de identidades y accesos de Citrix Cloud. Es obligatoria 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 cambios. Todos los cambios esperados se notifican antes de que finalice la importación. Puedes usar 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.ymlantes de modificar la configuración de la nube. Esto está habilitado de forma predeterminada. -
Confirm– cuando estrue, solicita a los usuarios que confirmen que quieren realizar cambios en la configuración del sitio en la nube. El cmdletRemovemuestra un mensaje debido a su naturaleza destructiva. Establécelo enfalsesi no deseas un mensaje, como al ejecutarlo dentro de scripts automatizados.Confirmse establece entruede forma predeterminada. -
SecurityFileFolder– esta es la carpeta completa que contiene el archivoCustomerInfo.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; el acceso al recurso controlado debe obtenerse antes de ejecutar la herramienta. -
SiteName– especifica el conjunto de prefijos y sufijos de fusión de sitios que se usará 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. Puedes suprimir la visualización estableciendo el parámetro -DisplayLog en $false. Notepad.exe se usa de forma predeterminada para mostrar el archivo de registro. Puedes especificar un editor diferente en el archivo CustomerInfo.yml.
Editor: C:\Program Files\Notepad++\notepad++.exe
Valores devueltos del cmdlet
ActionResult
Todos los cmdlets devuelven el siguiente valor.