Rules syntax

Data Migrator Administration Guide for Hitachi NAS Platform

Part Number

Data migration rules compare a series of INCLUDE and EXCLUDE statements, each qualified by expressions stating the criteria for data migration. The following guidelines govern rule building:

  • At least one INCLUDE or EXCLUDE. Each rule must contain at least one INCLUDE or EXCLUDE statement. Rules consisting only of EXCLUDE statements imply that everything on primary storage should be migrated except what has been specifically excluded.
    Note: If a rule contains only INCLUDE statements, all items not specified by the INCLUDE statements are excluded.
  • Wildcards. The asterisk (*) can be used as a wildcard character to qualify PATH and FILENAME values.
    • When used in a PATH value, “*” is only treated as a wildcard if it appears at the end of a value; for example, <PATH /tmp*>.
    • In a FILENAME value, a single “*” can appear either at the beginning or the end of the value.
    • Multiple instances of the wildcard character are not supported and additional instances in a value definition will be treated as literal characters.
  • Bracketed keyword/value pairs. Expressions identifying migration criteria should be enclosed in brackets. All criteria contain a keyword, defining the condition for data migration, followed by a single value of a list of values; for example, <FILENAME *.doc>.
  • Evaluation of statement sequence. When using multiple INCLUDE or EXCLUDE statements, they are evaluated using top-down ordering.
  • Grouping criteria within statements. Parentheses are used to group the criteria in INCLUDE and EXCLUDE statements; for example, INCLUDE (<PATH /Temp/*>).
  • Number of INCLUDE or EXCLUDE statements per line. When using multiple INCLUDE or EXCLUDE statements in a rule, each INCLUDE or EXCLUDE statement must be placed on its own line (multiple INCLUDE and/or EXCLUDE statements may not be put on the same line).
  • Separating multiple listed values. When defining multiple values in a FILENAME list, use a comma to separate values; for example, INCLUDE (<FILENAME *.mp3,*.wav,*.wmv>).
  • Characters requiring escaping. the following characters need to be escaped with a backslash (\) when used as a part of PATH or FILENAME values: \ (backslash), > (greater than), and , (comma); for example, INCLUDE (<FILENAME *a\,b> OR <PATH /tmp/\>ab>).
    Note: Backslashes used when specifying a domain and user name should not be escaped (double backslashes are not required when specifying domain_name\user_name).
  • Forward slash (/) reserved as a path separator. The forward slash (/) is used as a path separator; as such, it must not be used in a FILENAME list.
  • Evaluation of absent PATH. If a PATH element is not specified in a statement, the statement will apply to the entire file system or virtual volume defined in the data migration path.
  • Quotation mark usage. Quotation marks (“) are not allowed around a FILENAME or PATH list.