Documentación de productos

Cmdlets de la herramienta de configuración automatizada para copia de seguridad y restauración

May 31, 2026
Contribución de: 
C

Esta página enumera todos los cmdlets y parámetros compatibles con la herramienta para activar las API de copia de seguridad y restauración que utiliza Web Studio.

Cmdlets de almacenamiento de copia de seguridad

Get-BckRstrStorage

Este cmdlet es aplicable solo a entornos locales. Obtiene detalles del almacenamiento donde se guardan las copias de seguridad.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida en la consola.

Set-BckRstrStorage

Este cmdlet solo es aplicable a entornos locales. Establece un nuevo almacenamiento donde se guardan las copias de seguridad.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
MaximumBackups El número máximo de copias de seguridad no ancladas que se conservarán hasta que el proceso de limpieza de copias de seguridad elimine las copias de seguridad más antiguas cuando se creen nuevas copias de seguridad.
MaximumPinnedBackups El número máximo de copias de seguridad ancladas que se conservarán. Estas copias de seguridad no son eliminadas por el proceso de limpieza.
BlobStorageType El tipo de almacenamiento: FileStorage o CustomerAzureStorage.
FileStoragefolder La especificación de carpeta completa para la opción BlobStorageType FileStorage.
Info1
Para FileStorage, UserName opcional
Para CustomerAzureStorage, la URL SAS de Azure
Info2 Para FileStorage, contraseña opcional
Info3 y Info4 No utilizado

Test-BckRstrStorage

Este cmdlet solo es aplicable a entornos locales. Realiza pruebas para determinar que el almacenamiento definido es válido.

Para FileStorage, la prueba verifica que la carpeta existe y que se puede escribir en ella.

Para CustomerAzureStorage, la prueba verifica que la URL SAS tiene los permisos correctos y que la fecha actual está dentro de la fecha de inicio y fin de la URL.

Devuelve true si es válido y false si no es válido.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.

Cmdlets de copia de seguridad

Get-BckRstrBackups

Enumera las copias de seguridad almacenadas en la ubicación de almacenamiento de blobs de copia de seguridad o restauración. Para Citrix Virtual Apps and Desktops™, esta ubicación la configura el administrador a través de WebStudio. Para DaaS, este es el almacenamiento de Azure del cliente preexistente. Utilice Get-BckRstrBackupsWithDetiails para obtener información completa sobre cada copia de seguridad. Los detalles de la copia de seguridad incluyen lo siguiente:

  • Nombre de respaldo
  • Notas
  • Anclado (verdadero o falso)
  • Fecha y hora de la copia de seguridad
  • UID del historial
  • UID relacionado (UID del último registro del historial de restauración)
  • Fecha y hora relacionadas
  • Relacionado si se ejecuta en modo de comprobación
  • Duración en segundos
  • Nombre del administrador
  • Detalles que enumeran cada componente y el recuento de miembros en cada componente.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte (https://www.citrix.com/blogs/2016/07/01/introducing-remote-powershell-sdk-v2-for-citrix-cloud/) para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.

Get-BckRstrBackupsMembers

Enumera los miembros de un solo componente almacenados en una copia de seguridad seleccionada. Los nombres de los miembros se devuelven en una lista simple.

Los componentes son:

  • Etiquetas
  • AdminScopes
  • AdminRoles
  • AdminAdministrators (solo en las instalaciones)
  • HostConnections
  • Iconos
  • AdminFolders
  • Catálogos de máquinas
  • StoreFronts
  • Grupos de entrega
  • Grupos de aplicaciones
  • Carpetas de aplicaciones
  • Aplicaciones
  • Servidores App-V
  • Detección de paquetes de AppLib
  • Grupos de aislamiento de App-V
  • Directivas de grupo
  • Preferencias de zona de usuario
  • Datos del sitio
  • Zonas (solo en implementaciones locales)

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.
Component Los componentes que se incluirán en la copia de seguridad.

New-BckRstrBackup

Inicia una nueva acción de copia de seguridad en el Delivery Controller. Esta acción es asíncrona al cmdlet New-BckRstrBackup.

Parámetros:

Parámetro Descripción
CustomerId El ID de suscriptor necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
Notes Las notas sobre la copia de seguridad.
PollForCompletion El parámetro para sondear la acción que se ejecuta en el Delivery Controller hasta que la acción se complete. El sondeo registra el progreso y los resultados de la finalización en la consola, a menos que se especifique el parámetro Quite.

Cmdlets para anclar copias de seguridad

Set-BckRstrPinBackups

Ancla una copia de seguridad para que no se elimine como parte del proceso de limpieza de copias de seguridad del Delivery Controller.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida en la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.

Set-BckRstrUnpinBackups

Desancla una copia de seguridad para que esté disponible para su eliminación en el proceso de limpieza de copias de seguridad del Delivery Controller.

Parámetros:

Parámetro Descripción
CustomerId El ID de suscriptor necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.

Cmdlet para eliminar copias de seguridad

Remove-BckRstrBackup

Elimina una o varias copias de seguridad.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
IncludeByName El filtro para especificar qué miembros del componente se deben considerar para la restauración. Es una lista de valores de filtro separados por comas y puede contener los caracteres comodín * y ?.

Cmdlets de copias de seguridad programadas

Get-BckRstrSchedules

Obtiene una lista de programaciones de copias de seguridad.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.
Notes Las notas para establecer o cambiar.

New-BckRstrSchedule

Crea una nueva programación de copia de seguridad.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
Name El nombre de la programación.
Frequency El tipo de frecuencia: Diaria, Semanal o Mensual.
Day Si la frecuencia es diaria.
DaysInWeek Si la frecuencia es semanal.
DayInMonth Si la frecuencia es mensual.
WeekInMonth Si la frecuencia es mensual.
StartDate El formato es M/d/yy
StartTime La hora de inicio especificada en formato de 24 horas.
FrequencyFactor Se ejecuta cada n veces, por ejemplo, cada día (valor = 1) o cada dos días (valor = 2)
Description La descripción de la copia de seguridad programada
Enabled El parámetro para habilitar esta programación de copia de seguridad. True cuando está habilitado y false cuando está deshabilitado
TimeZoneId El ID de zona horaria de Windows

Set-BckRstrSchedule

Modifica una programación de copia de seguridad existente. Proporcione el nombre o el Uid para seleccionar la programación que desea modificar.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp y XenDesktop: SDK de PowerShell remoto v2 para Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
Name El nombre de la programación.
Uid Si se va a cambiar el nombre de la programación.
Frequency El tipo de frecuencia: Diaria, Semanal o Mensual.
Day Si la frecuencia es diaria.
DaysInWeek Si la frecuencia es semanal.
DayInMonth Si la frecuencia es mensual.
WeekInMonth Si la frecuencia es mensual.
StartDate El formato es M/d/yy
StartTime La hora de inicio especificada en formato de 24 horas.
FrequencyFactor Se ejecuta cada n veces, por ejemplo, todos los días (valor = 1) o cada dos días (valor = 2)
Description La descripción de la copia de seguridad programada
Enabled El parámetro para habilitar esta programación de copia de seguridad. True cuando está habilitado y false cuando está deshabilitado
TimeZoneId El ID de zona horaria de Windows

Set-BckRstrScheduleEnabled

Habilita una programación de copia de seguridad existente. Proporcione el nombre o Uid para seleccionar la programación que desea habilitar.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida en la consola.
Name El nombre de la programación.
Uid Si se va a cambiar el nombre de la programación.

Set-BckRstrScheduleDisabled

Deshabilita una programación de copia de seguridad existente. Proporcione el nombre o el Uid para seleccionar la programación que se va a deshabilitar.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
Name El nombre de la programación.
Uid Si se va a cambiar el nombre de la programación.

Cmdlet para limitar las copias de seguridad

Set-BckRstrOptions

Limita las copias de seguridad programadas a una por día para evitar copias de seguridad idénticas.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
OneScheduledBackupPerDay El parámetro para limitar las copias de seguridad programadas a una por día para evitar copias de seguridad idénticas.

Cmdlet de restauración

Restore-BckRstrBackups

Restaura miembros de un solo componente a partir de una copia de seguridad existente.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.
Component Los componentes que se incluirán en la copia de seguridad.
Notes Las notas sobre la copia de seguridad.
CheckMode El parámetro para identificar los miembros del componente que se restaurarían, pero que no realiza la restauración real.
RestoreType El tipo de restauración: MissingOnly o MissingUpdateExisting
IncludeByName El filtro para especificar qué miembros del componente se deben considerar para la restauración. Es una lista de valores de filtro separados por comas y puede contener los caracteres comodín * y ?.

Cmdlets de historial

Get-BckRstrHistory

Obtiene una lista de detalles del historial para todas las acciones.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene la seguridad y la información del entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.

Get-BckRstrSpecificBackupHistory

Obtiene una lista de detalles del historial para una copia de seguridad específica.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.

Set-BckRstrNotes

Establece o cambia las notas en un registro del historial.

Parámetros:

Parámetro Descripción
CustomerId El ID de cliente necesario para obtener un token de portador.
CientId El ID de cliente necesario para obtener un token de portador.
Secret El secreto necesario para obtener un token de portador.
CustomerInforFileSpec La especificación de archivo completa del archivo de información del cliente que contiene información de seguridad y de entorno.
ProfileName El parámetro para identificar un perfil de seguridad existente que se utiliza en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para saber cómo configurar perfiles de seguridad.
Environment El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem.
Quiet El parámetro para suprimir la salida a la consola.
BackupName El nombre de la copia de seguridad. La extensión .zip es opcional.
Notes Las notas que se van a establecer o cambiar.
Cmdlets de la herramienta de configuración automatizada para copia de seguridad y restauración
May 31, 2026
Contribución de: 
C
May 31, 2026
Contribución de: 
C

En este artículo

Comentarios sobre el sitio | Your privacy choices footer linkSus opciones de privacidad | Condiciones legales y de privacidad | Preferencias de cookies | Parámetros de consentimiento | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.