DEFINE RETRULE (Definir una regla de retención)

Utilice este mandato para definir una regla de retención para un servidor IBM Storage Protect .

Se pueden incluir varios tipos de datos en un conjunto de retención, en función del cliente o del producto que haya realizado una copia de seguridad de los datos. Para obtener más información, consulte Tipos de datos que se pueden incluir en conjuntos de retención.

Puede definir la regla de retención para que se ejecute una sola vez o de forma planificada.

Una regla de retención de una sola vez crea un conjunto de retención que recopila datos activos del pasado, del presente o del futuro.

También puede definir una regla de retención para que se ejecute de forma planificada, a partir de la fecha y hora actuales o una fecha y hora en el futuro.

Restricciones: Las restricciones siguientes se aplican a las reglas de retención.

No puede modificar una regla de una sola vez para que se ejecute de forma recurrente o para crear otro conjunto de retención.
Si un nodo del conjunto de retención es el destino de una operación de réplica de nodo y desea crear un conjunto de retención con los datos que se van a replicar, debe definir el conjunto de retención con los valores de parámetro STARTTIME y STARTDATE que preceden al inicio de la operación de réplica.

Clase de privilegio

Para emitir este mandato, debe tener privilegio de sistema o privilegio de políticas sin restricciones.

Sintaxis

Notas:

¹ El nombre_espacio_archivos puede corresponder a un espacio de archivos en un cliente de archivado y copia de seguridad o a una máquina virtual IBM Storage Protect for Virtual Environments . Para especificar la máquina virtual, utilice el nombre de la máquina virtual o el nombre del espacio de archivos correspondiente.
² Si especifica un nombre de espacio de archivos, sólo puede especificar un nombre de nodo completo.
³ Para crear un conjunto de retención retroactivo que recopile datos pasados mediante una regla de retención única, debe definir la regla de retención con los valores de parámetro STARTTIME y STARTDATE .
⁴ Para especificar los parámetros HOLD y HOLDREASON , también debe especificar FREQUENCY=ONETIME.

planificación clásica

planificación mejorada

Parámetros

nombre_retracción (Obligatorio)

Especifica el nombre de la regla de retención. El nombre debe ser exclusivo y la longitud máxima es de 64 caracteres.

nombre_nodo o nombre_grupo_nodo (Obligatorio)

Especifica el nombre del nodo cliente o de los grupos de nodos a los que se aplica la regla de retención. Para especificar varios nombres de nodo y nombres de grupos de nodos, sepárelos con comas y sin espacios intercalados. Puede utilizar caracteres comodín con nombres de nodo pero no con nombres de grupos de nodos. Si especifica caracteres comodín en el nombre de nodo, cuando se crea el conjunto de retención, todos los nodos se incluyen en el conjunto de retención que coincide con dicha especificación de comodín. Si especifica un nombre de espacio de archivos, solo puede especificar un único nombre de nodo. Puede especificar un grupo de nodos incluso si ninguno de los nodos que son miembros del grupo se pueden incluir en un conjunto de retención.

Restricciones:

Los nodos de cliente que están fuera de servicio cuando se crea el conjunto de retención se excluyen del conjunto de retención.
No se puede incluir una copia de seguridad de VSS de destino local en un conjunto de retención porque se almacena en los volúmenes de duplicación local del cliente. Solo se envían los objetos de metadatos al servidor para una copia de seguridad de VSS de destino local. El conjunto de retención no puede controlar la copia de seguridad.
Puede añadir un nodo a un conjunto de retención sólo si el nodo se ha registrado en el servidor con el parámetro TYPE=CLIENT especificado. Los nodos se registran en el servidor con el mandato REGISTER NODE. Para determinar el valor de TYPE de un nodo registrado, emita el mandato QUERY NODE.

nombre_espacio_archivos

Especifica el nombre de un espacio de archivos al que se aplica la regla de retención.

El nombre de espacio de archivos puede corresponder a un espacio de archivos de cliente de archivado y copia de seguridad. El nombre del espacio de archivos también puede corresponder al nombre de una máquina virtual IBM Storage Protect for Virtual Environments . En lugar de especificar un nombre de espacio de archivos, también puede especificar un nombre de la máquina virtual.

Puede especificar caracteres comodín en el nombre de espacio de archivos. Para especificar un espacio de archivos que contenga una coma en el nombre, debe especificar el ID numérico de espacio de archivos y, a continuación, especificar NAMETYPE=FSID.

Sugerencias:

Emita el comando QUERY FILESPACE para determinar qué espacios de archivos e identificadores de espacio de archivos están definidos para un nodo en el servidor.
Los espacios de archivos que están fuera de servicio cuando se crea el conjunto de retención se excluyen del conjunto de retención.

NAMEType

Especifica cómo desea que el servidor interprete el nombre de espacio de archivos que especifique. Utilice este parámetro sólo cuando especifique un nombre de espacio de archivos completo.

El valor predeterminado es SERVER. Si se especifica un nombre de asignación de espacio de archivos virtual, se debe utilizar SERVER. Puede seleccionar uno de los valores siguientes:

SERVER: El servidor utiliza la página de códigos del servidor para interpretar el nombre de espacio de archivos.
UNIcode: El servidor convierte el nombre de espacio de archivos especificado de la página de códigos del servidor a la página de códigos UTF-8. El éxito de la conversión depende de los caracteres que contiene el nombre y de la página de códigos del servidor. La conversión falla si la serie incluye caracteres que no están disponibles en la página de códigos de servidor o si el servidor no puede acceder a las rutinas de conversión de sistema.
FSID: El servidor interpreta el nombre de espacio de archivos como su identificador de espacio de archivos (FSID).

CODEType

Especifica el tipo de espacios de archivos que se van a incluir en el proceso de regla de retención. El valor predeterminado es BOTH, lo que significa que se incluyen espacios de archivos independientemente del tipo de página de códigos. Utilice este parámetro sólo cuando especifique al menos un carácter comodín para el nombre de espacio de archivos. Puede seleccionar uno de los valores siguientes:

UNIcode: Especifica sólo los espacios de archivos que están en Unicode.
NONUNIcode: Especifica sólo los espacios de archivos que no están en Unicode.
BOTH: Especifica todos los espacios de archivos independientemente del tipo de página de códigos.

STARTTime

Especifica la hora de inicio en un rango de horas en la que se procesa por primera vez la regla de retención. Si la hora de inicio está en el pasado, los archivos que estaban activos desde la hora especificada y que todavía están almacenados en el servidor de IBM Storage Protect se incluyen en el conjunto de retención, incluso si están inactivos en el momento en que se emite el mandato.

Sugerencia: Para los conjuntos de retención que se han creado en el pasado, se emite un mensaje informativo al registro de actividad que indica que el conjunto de retención puede incluir archivos tal como existían en el pasado.

Si la creación planificada de un conjunto de retención no se ejecuta según lo planificado, su creación se produce tan pronto como es posible.

La hora predeterminada es la hora actual. Este parámetro es opcional.

Puede seleccionar uno de los valores siguientes:

Valor	Descripción	Ejemplo
HH:MM:SS	Una hora concreta	23:30:08
NOW	La hora actual	NOW
NOW+HH:MM o +HH:MM	La hora actual más el número especificado de horas y minutos	NOW+02:00 o +02:00
NOW-HH:MM o -HH:MM	La hora actual menos el número especificado de horas y minutos	NOW-02:00 o -02:00

STARTDate

Especifica la fecha de inicio para el rango de fechas en la que se procesa por primera vez la regla de retención. Si la fecha de inicio está en el pasado, los archivos que estaban activos a partir de la fecha especificada y que todavía están almacenados en el servidor de IBM Storage Protect se incluyen en el conjunto de retención, incluso si están inactivos en el momento en que se emite el mandato.

Si la creación planificada de un conjunto de retención no se ejecuta según lo planificado, su creación se produce tan pronto como es posible.

Este parámetro es opcional. El valor predeterminado es la fecha actual.

Puede seleccionar uno de los valores siguientes:

Valor	Descripción	Ejemplo
MM/DD/AAAA	Una fecha específica.	15/05/2018
TODAY	La fecha actual.	TODAY
TODAY+días o +días	La fecha actual más el número de días especificados. El número máximo de días que puede especificar es 9999.	TODAY+3 o +3
EOLM (fin del mes pasado)	El último día del mes anterior.	EOLM
EOLM-días	El último día del mes anterior menos el número de días especificado.	EOLM-1 Para incluir los archivos que estaban activos un día antes del último día del mes anterior
BOTM (Principios de este mes)	El primer día del mes actual.	BOTM
BOTM +días	El primer día del mes actual, más el número de días especificados.	BOTM+9 Para incluir archivos que estaban activos el día 10 del mes actual

RETention (obligatorio)

Especifica el periodo de tiempo, en días, para el que el servidor retiene cualquier conjunto de retención creado por la regla de retención. Este parámetro es necesario.

El periodo de retención que especifique se utiliza como el valor de periodo de retención de los conjuntos de retención creados por la regla; sin embargo, puede cambiar este valor emitiendo el mandato UPDATE RETSET. Los datos contenidos en un conjunto de retención no caducan hasta que transcurre el periodo de retención de este conjunto de retención, independientemente de la clase de gestión y de las políticas de grupo de copias asociadas a estos datos. Puede seleccionar uno de los valores siguientes:

days

Especifique un valor entero en el rango de 0 a 30.000.

Después de determinar el periodo de tiempo durante el que se deben retener los datos, puede utilizar la tabla siguiente para convertir el número de años a días. Si el periodo incluye un año bisiesto, ajuste el número de días.

Tabla 1. Número de ejemplo de días a años
Número de años	Número de días a años
1 año	365
2 años	730
3 años	1095
4 años	1461
5 años	1826
6 años	2191
7 años	2556
8 años	2921
9 años	3287
10 años	3652
20 años	7304
30 años	10957
40 años	14609
50 años	18262

NOLimit

Especifica que desea conservar el conjunto de retención indefinidamente. Si especifica NOLimit, el servidor retiene los conjuntos de retención para siempre, a menos que un usuario o administrador autorizado suprima el conjunto de retención. Para obtener información sobre el mandato DELETE RETSET , consulte DELETE RETSET (Suprimir un conjunto de retención).

ACTive

Especifica si la regla de retención está habilitada para el proceso. Este parámetro es opcional. El valor predeterminado es Yes (sí).

Yes: Especifica que la regla de retención está activa. Para permitir que la regla de retención cree los conjuntos de retención, el parámetro ACTIVE debe establecerse en Sí.
No: Especifica que la regla de retención no está en un estado ACTIVE y, de este modo, esta regla de retención no crea conjuntos de retención.

DESCription

Especifica una descripción para la regla de retención. Esta descripción se copia en los conjuntos de retención creados por esta regla de retención. Este parámetro es opcional.

La longitud máxima de la descripción es de 255 caracteres. La descripción debe estar delimitada por comillas si contiene algún carácter en blanco.

STACK

Especifica si los datos para los conjuntos de retención que se crean mediante la regla de retención se pueden copiar en volúmenes de cinta compartidos, es decir, volúmenes que también contienen datos de otros conjuntos de retención. Este parámetro es opcional. El valor predeterminado es YES.

Restricción: El parámetro STACK sólo se aplica cuando se copian datos de retención en volúmenes de cinta. El parámetro se pasa por alto cuando se copian datos de retención en el almacenamiento en la nube.

Yes: Especifica que los datos del conjunto de retención pueden compartir volúmenes de cinta con datos que se copian desde otros conjuntos de retención. Los datos del conjunto de retención se pueden copiar en cualquier volumen de cinta con el estado EMPTY (vacío). Los datos también se pueden copiar en volúmenes con un estado de FILLING, pero sólo si estos volúmenes no están en uso por los conjuntos de retención que requieren un volumen aparte.
No: Especifica que los datos del conjunto de retención no comparten volúmenes de cinta con datos de otros conjuntos de retención. Los datos del conjunto de retención se pueden copiar en volúmenes de cinta con el estado ENPTY o FILLING.
Restricción: Los datos se pueden copiar en volúmenes RELLENO sólo si los volúmenes ya contienen datos para el conjunto de retención que se está copiando. Cuando la operación para copiar los datos retenidos en el volumen finaliza, aunque el volumen no esté lleno, el volumen se marca como FULL para impedir que lo utilicen otros conjuntos de retención.

MAXCOPYProcess

Especifica el número máximo de procesos paralelos que puede ejecutar la regla de almacenamiento al copiar datos retenidos (para los conjuntos de retención creados por esta regla de retención) en una agrupación de almacenamiento de retención. Este parámetro es opcional. De forma predeterminada, el número de procesos paralelos ya se ha calculado y se ha establecido en Automatic. Todos los conjuntos de retención que se crean a partir de la regla de retención heredan el valor MAXCOPYPROCESS que se ha especificado para la regla de almacenamiento. Al asegurarse de que el parámetro MAXCOPYPROCESS esté establecido en un valor adecuado, puede ayudar a optimizar el rendimiento de las operaciones de copia.

AUTOmatic: Especifica que el número máximo de procesos que se debe utilizar está preestablecido para un rendimiento óptimo.
STGRule: Especifica que el número de procesos paralelos se determina mediante el valor MAXPROCESS de la regla de almacenamiento.
número: Especifica el número máximo de procesos paralelos para copiar datos retenidos. Puede especificar un valor entre 1 y 99.

DESTination

Especifica un destino para los conjuntos de retención que se crean mediante esta regla de retención. Puede especificar el nombre de una agrupación de almacenamiento de retención. La agrupación de almacenamiento de retención puede estar en almacenamiento en cinta o en la nube. Si no especifica un destino, la regla de retención creará conjuntos de retención locales y los datos retenidos se conservan únicamente en el almacenamiento del servidor. Este parámetro es opcional.

Restricción:

Únicamente se pueden especificar agrupaciones de almacenamiento de retención como destino.

agrupación_almacenamiento_retención: Especifica el nombre de una agrupación de almacenamiento de retención a la que se copian los conjuntos de retención.

HOLD

Especifica el nombre del control de retención al que se pueden añadir uno o más conjuntos de retención. Puede colocar un conjunto de retención en un control de retención para conservar los datos relevantes de forma indefinida, por ejemplo si hay un litigio pendiente o previsto. Cualquier conjunto de retención que se añade a un control de retención no se puede suprimir, independientemente de su fecha de caducidad hasta que el conjunto de retención se libere explícitamente del conjunto.

Restricción: Para especificar los parámetros HOLD y HOLDREASON , también debe especificar FREQUENCY=ONETIME.

HOLDREASon

Especifica la razón por la que se coloca una retención en el conjunto de retención especificado. La longitud máxima es de 510 caracteres. La razón debe estar delimitada por comillas si contiene algún carácter en blanco.

SCHEDStyle

Especifica el tipo de planificación para la regla de retención. El valor predeterminado es Classic.

Puede seleccionar uno de los valores siguientes:

Classic: El parámetro para la sintaxis Classic es DAYOFWEEK. Si especifica SCHEDSTYLE=CLASSIC, no puede especificar los parámetros siguientes: MONTH, DAYOFMONTH y WEEKOFMONTH.
Enhanced: Los parámetros para la sintaxis Enhanced son MONTH, DAYOFMONTH, WEEKOFMONTH y DAYOFWEEK. Si especifica SCHEDSTYLE=ENHANCED, no puede especificar el parámetro FREQUENCY.

FREQuency

Especifica la frecuencia con la que se crean los conjuntos de retención. Puede especificar el parámetro FREQUENCY sólo con el valor SCHEDSTYLE=CLASSIC.

Restricción: Si especifica FREQUENCY=ONETIME, no puede cambiar este valor después de definir la regla de retención. Por el contrario, si especifica un valor distinto de ONETIME, no puede cambiar este valor por ONETIME después de que se defina la regla de retención.

Ejemplo: Definición de una regla de retención que inicia la creación semanal de un conjunto de retención

Defina una regla de retención en NODE1 que inicia la creación semanal de un conjunto de retención y que se denomina MY_WEEKLY_RETSET. Especifique la fecha de inicio como 10 de mayo de 2018, con la creación de conjunto de retención que se produce cada sábado a la 1.00. Los conjuntos de retención se conservan durante 150 días.

define retrule my_weekly_retset NODE1 retention=150 
description="Weekly retention set creation" 
startdate=05/10/2018 starttime=01:00:00 
schedstyle=classic frequency=weekly dayofweek=saturday

Ejemplo: Definir una regla de retención para un grupo de nodos cliente y para varios nodos utilizando un comodín

Defina una regla de retención denominada SERVER_TEST_DATA en los nodos de cliente NODE1, NODE2 y NODE3 y en el grupo de nodos cliente denominado TESTDATA. Los únicos nodos del sistema que empiezan con los caracteres "NODE" son NODE1, NODE2 y NODE3, por lo que puede utilizar un comodín para especificarlos. Especifique la fecha de inicio como la fecha actual a la 1.00. El periodo de retención es de 60 días.

define retrule server_test_data NODE*,testdata retention=60 
startdate=TODAY starttime=01:00:00 
schedstyle=classic frequency=weekly dayofweek=monday

Mandatos relacionados

Tabla 2. Mandatos relacionados con DEFINE RETRULE
Mandato	Descripción
SUPRIMIR RETRACCIÓN	Suprime una regla de retención.
NODO DE CONSULTA	Visualiza información parcial o completa sobre uno o más clientes.
RETRAER CONSULTA	Visualiza información sobre las reglas de retención.
REGISTRAR NODO	Define un nodo cliente en el servidor y establece las opciones para dicho usuario.
RENOMBRAR RETRULE	Redenomina una regla de retención.
ACTUALIZAR LA REGLA	Cambia los atributos de una regla de retención.