Cmdlets de la herramienta de configuración automatizada para copias de seguridad y restauración
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 usa Studio.
Cmdlets de almacenamiento de copias de seguridad
Get-BckRstrStorage
Este cmdlet solo se aplica a entornos locales. Obtiene los 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 del entorno.|
|ProfileName|El parámetro para identificar un perfil de seguridad existente que se usa en lugar de los parámetros anteriores. Consulta [XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud](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.|
Set-BckRstrStorage
Este cmdlet solo se aplica 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 del entorno.|
|ProfileName|El parámetro para identificar un perfil de seguridad existente que se usa en lugar de los parámetros anteriores. Consulta [XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud](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.|
|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 se eliminan mediante el proceso de limpieza.|
|BlobStorageType|El tipo de almacenamiento: FileStorage o CustomerAzureStorage.|
|FileStoragefolder|La especificación de carpeta completa para la opción FileStorage de BlobStorageType.|
|Info1|Para FileStorage, UserName opcional.|
|^^|^^ Para CustomerAzureStorage, la URL SAS de Azure.|
|Info2|Para FileStorage, contraseña opcional.|
|Info3 y Info4|No se usan.|
Test-BckRstrStorage
Este cmdlet solo se aplica a entornos locales. Comprueba 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 lo es.
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 del entorno.|
|ProfileName|El parámetro para identificar un perfil de seguridad existente que se usa en lugar de los parámetros anteriores. Consulta [XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud](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.|
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 preexistente del cliente. Usa Get-BckRstrBackupsWithDetiails para obtener información completa sobre cada copia de seguridad. Los detalles de la copia de seguridad incluyen lo siguiente:
- Nombre de la copia de seguridad
- Notas
- Anclada (true o false)
- 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á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 usado en lugar de los parámetros anteriores. Consulta 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-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:
- Tags
- AdminScopes
- AdminRoles
- AdminAdministrators (solo en local)
- HostConnections
- Icons
- AdminFolders
- MachineCatalogs
- StoreFronts
- DeliveryGroups
- ApplicationGroups
- ApplicationFolders
- Applications
- AppVServers
- AppLibPackageDiscovery
- AppVIsolationGroups
- GroupPolicies
- UserZonePreferences
- SiteData
- Zones (solo en local)
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 usado en lugar de los parámetros anteriores. Consulta 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 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 usado en lugar de los parámetros anteriores. Consulta 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 usado en lugar de los parámetros anteriores. Consulta 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-BckRstrUnpinBackups
Desancla una copia de seguridad para que esté disponible para ser eliminada 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 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 usado en lugar de los parámetros anteriores. Consulta 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 quitar copias de seguridad
Remove-BckRstrBackup
Quita una o más 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 completamente cualificada 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 usado en lugar de los parámetros anteriores. Consulta [XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud](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.|
|IncludeByName|El filtro para especificar qué miembros del componente 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 completamente cualificada 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 usado en lugar de los parámetros anteriores. Consulta [XenApp & XenDesktop: Remote PowerShell SDK v2 for Citrix Cloud](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.|
|BackupName|El nombre de la copia de seguridad. La extensión .zip es opcional.|
|Notes|Las notas para establecer o modificar.|
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 completamente cualificada 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 usado en lugar de los parámetros anteriores. Consulta 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: Daily, Weekly o Monthly. |
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 |
Ejecutar cada n veces, como 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á habilitada y false cuando está deshabilitada. |
TimeZoneId |
El ID de zona horaria de Windows. |
Set-BckRstrSchedule
Modifica una programación de copia de seguridad existente. Proporciona el nombre o el Uid para seleccionar la programación a 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 completamente cualificada 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 usado en lugar de los parámetros anteriores. Consulta 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. |
Frequency |
El tipo de frecuencia: Daily, Weekly o Monthly. |
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 |
Ejecutar cada n veces, como 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á habilitada y false cuando está deshabilitada. |
TimeZoneId |
El ID de zona horaria de Windows. |
Set-BckRstrScheduleEnabled
Habilita una programación de copia de seguridad existente. Proporciona el nombre o el Uid para seleccionar la programación a 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 completamente cualificada 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 usado en lugar de los parámetros anteriores. Consulta 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. |
Set-BckRstrScheduleDisabled
Deshabilita una programación de copia de seguridad existente. Proporciona el nombre o el Uid para seleccionar la programación 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 completamente cualificada 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 usado en lugar de los parámetros anteriores. Consulta 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 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. Consulta 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. |
OneScheduledBackupPerDay |
El parámetro para limitar las copias de seguridad programadas a una por día para evitar copias idénticas. |
Cmdlet para restaurar
Restore-BckRstrBackups
Restaura miembros de un único 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. Consulta 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. |
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 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 los 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 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. Consulta 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. |
Get-BckRstrSpecificBackupHistory
Obtiene una lista de los 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. Consulta 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-BckRstrNotes
Establece o modifica las notas en un registro de 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 entorno. |
ProfileName |
El parámetro para identificar un perfil de seguridad existente utilizado en lugar de los parámetros anteriores. Consulta 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. |
Notes |
Las notas que se van a establecer o modificar. |