Cmdlets de herramientas de configuración automatizada para realizar copias de seguridad y restaurar
En esta página se enumeran todos los cmdlets y parámetros que admite la herramienta para activar las API de copia de seguridad y restauración que usa Studio
Cmdlets de almacenamiento de copias de seguridad
Get-BckRstrStorage
Este cmdlet solo se aplica al entorno local. Obtiene detalles del almacenamiento en el que 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Set-BckRstrStorage
Este cmdlet solo se aplica al entorno local. 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
MaximumBackups |
La cantidad máxima de copias de seguridad sin anclar que se conservarán hasta que el proceso de borrado de copias de seguridad quite las copias de seguridad más antiguas cuando se creen otras nuevas. |
MaximumPinnedBackups |
La cantidad máxima de copias de seguridad ancladas que deben conservarse. El proceso de limpieza no quita estas copias de seguridad. |
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 de Azure SAS |
Info2 |
Para FileStorage , contraseña opcional |
Info3 y Info4
|
No se usa |
Test-BckRstrStorage
Este cmdlet solo se aplica al entorno local. Realiza pruebas para determinar si el almacenamiento definido es válido.
Para FileStorage
, la prueba verifica que la carpeta existe y se puede escribir en ella.
Para CustomerAzureStorage
, la prueba verifica que la URL de SAS tenga los permisos correctos y que la fecha actual coincida con las fechas de inicio y finalización 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Hacer copias de seguridad de los cmdlets
Get-BckRstrBackups
Enumera las copias de seguridad almacenadas en la ubicación de almacenamiento de blobs de copia de seguridad o restauración. En el caso de Citrix Virtual Apps and Desktops, esta ubicación la configura el administrador a través de WebStudio. En el caso de DaaS, este es el almacenamiento de Azure del cliente preexistente. Use Get-BckRstrBackupsWithDetails
para obtener información completa sobre cada copia de seguridad. Los detalles de la copia de seguridad incluyen lo siguiente:
- Nombre de copia de seguridad
- Notas
- Anclaje (true o false)
- Fecha y hora de la copia de seguridad
- UID de historial
- UID relacionado (UID del registro del historial de restauración más reciente)
- 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 de cada componente.
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
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 sencilla.
Los componentes son:
- Etiquetas
- AdminScopes
- AdminRoles
- AdminAdministrators (solo entorno local)
- HostConnections
- Iconos
- AdminFolders
- MachineCatalogs
- Almacenes de StoreFront
- DeliveryGroups
- ApplicationGroups
- ApplicationFolders
- Aplicaciones
- AppVServers
- AppLibPackageDiscovery
- AppVIsolationGroups
- GroupPolicies
- UserZonePreferences
- SiteData
- Zonas (solo entorno local)
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
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 asincrónica con respecto al cmdlet New-BckRstrBackup
.
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Notas |
Las notas sobre la copia de seguridad. |
PollForCompletion |
Parámetro para sondear la acción que se está ejecutando en el Delivery Controller hasta que se complete la acción. El sondeo registra los resultados de progreso y 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 quite 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a 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 pueda quitarse en el 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
BackupName |
El nombre de la copia de seguridad. La extensión .zip es opcional. |
Quitar cmdlet de copia de seguridad
Remove-BckRstrBackup
Quita 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
IncludeByName |
El filtro para especificar qué miembros del componente se deben tener en cuenta para la restauración. Es una lista de valores de filtro separados por comas y puede tener los caracteres comodín * y ? . |
Cmdlets de copias de seguridad programadas
Get-BckRstrSchedules
Obtiene una lista de las 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
BackupName |
El nombre de la copia de seguridad. La extensión .zip es opcional. |
Notas |
Las notas que se van a configurar o cambiar. |
New-BckRstrSchedule
Crea una nueva programación 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Nombre |
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 un reloj de 24 horas. |
FrequencyFactor |
Se ejecuta cada n veces, por ejemplo, todos los días (valor = 1) o cada dos días (valor = 2) |
Descripción |
La descripción de la copia de seguridad programada |
Enabled |
Parámetro para habilitar esta programación de copias de seguridad. True cuando está habilitado y false cuando está inhabilitado |
TimeZoneId |
El identificador de zona horaria de Windows |
Set-BckRstrSchedule
Modifica una programación de copias de seguridad existente. Proporcione el nombre o el Uid para seleccionar la programación que quiere modificar.
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Nombre |
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 un reloj de 24 horas. |
FrequencyFactor |
Se ejecuta cada n veces, por ejemplo, todos los días (valor = 1) o cada dos días (valor = 2) |
Descripción |
La descripción de la copia de seguridad programada |
Enabled |
Parámetro para habilitar esta programación de copias de seguridad. True cuando está habilitado y false cuando está inhabilitado |
TimeZoneId |
El identificador de zona horaria de Windows |
Set-BckRstrScheduleEnabled
Habilita una programación de copias de seguridad existente. Proporcione el nombre o el Uid para seleccionar la programación que quiere habilitar.
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Nombre |
El nombre de la programación. |
Uid |
Si se va a cambiar el nombre de la programación. |
Set-BckRstrScheduleDisabled
Inhabilita una programación de copias de seguridad existente. Proporcione el nombre o el Uid para seleccionar la programación que quiere inhabilitar.
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Nombre |
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 que haya 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
OneScheduledBackupPerDay |
Parámetro para limitar las copias de seguridad programadas a una por día para evitar que haya copias de seguridad idénticas. |
Cmdlet para restaurar
Restore-BckRstrBackups
Restaura los 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
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. |
Notas |
Las notas sobre la copia de seguridad. |
CheckMode |
Parámetro para identificar los miembros de los componentes que se restaurarían, pero 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 tener en cuenta para la restauración. Es una lista de valores de filtro separados por comas y puede tener los caracteres comodín * y ? . |
Cmdlets de historial
Get-BckRstrHistory
Obtiene una lista con los detalles del historial de 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
Get-BckRstrSpecificBackupHistory
Obtiene una lista de detalles del historial de 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 máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
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 de un registro histórico.
Parámetros:
Parámetro | Descripción |
---|---|
CustomerId |
El ID de cliente necesario para obtener un token de portador. |
CientId |
El ID de máquina 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 sobre la seguridad y el entorno. |
ProfileName |
Parámetro para identificar un perfil de seguridad existente usado en lugar de los parámetros anteriores. Consulte XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud para obtener información sobre cómo configurar los perfiles de seguridad. |
Environment |
El tipo de entorno de producción: Production, ProductionGov, ProductionJP, OnPrem. |
Quiet |
Parámetro para suprimir la salida a la consola. |
BackupName |
El nombre de la copia de seguridad. La extensión .zip es opcional. |
Notas |
Las notas que se van a configurar o cambiar. |