Configuring a Pattern Set

To configure a pattern set, you must specify the strings that are to serve as patterns. You can manually assign a unique index value to each of these patterns, or you can allow the index values to be assigned automatically.

Note: Pattern sets are case sensitive (unless you specify the expression to ignore case). Therefore, the string pattern “product1,” for example, is not the same as the string pattern “Product1.”

Points to remember about index values:

  • You cannot bind the same index value to more than one pattern.
  • An automatically assigned index value is one number larger than the highest index value of the existing patterns within the pattern set. For example, if the highest index value of existing patterns in a pattern set is 104, the next automatically assigned index value is 105.
  • If you do not specify an index for the first pattern, index value 1 is automatically assigned to that pattern.
  • Index values are not regenerated automatically if one or more patterns are deleted or modified. For example, if the set contains five patterns, with indexes from 1 through 5, and if the pattern with an index of 3 is deleted, the other index values in the pattern set are not automatically regenerated to produce values from 1 through 4.
  • The maximum index value that can be assigned to a pattern is 4294967290. If that value is already assigned to a pattern in the set, you must manually assign index values to any newly added patterns. An unused index value that is lower than a currently used value cannot be assigned automatically.

Configure a pattern set by using the command line interface

At the command prompt, do the following:

  1. Create a pattern set.

    add policy patset <name>


add policy patset samplepatset

  1. Bind patterns to the pattern set.

    bind policy patset <name> <string> [-index <positive_integer>][-charset ( ASCII | UTF_8 )] [-comment <string>]


bind policy patset samplepatset product1 -index 1 -comment short description about the pattern bound to the pattern set

Note: Repeat this step for all the patterns you want to bind to the pattern set.

  1. Verify the configuration.

show policy patset <name>

Configure a pattern set by using the configuration utility

  1. Navigate to AppExpert > Pattern Sets.
  2. In the details pane, click Add to open the Create Pattern Set dialog box.
  3. Specify a name for the pattern set in the Name text box.
  4. Under Specify Pattern, type the first pattern and, optionally, specify values for the following parameters:
    • Treat back slash as escape character—Select this check box to specify that any backslash characters that you might include in the pattern are to be treated as escape characters.
    • Index—A user assigned index value, from 1 through 4294967290.
  5. Verify that you have entered the correct characters, and then click Add.
  6. Repeat steps 4 and 5 to add more patterns, and then click Create.

Configure file-based pattern sets

The Citrix ADC appliance supports file-based pattern sets.

Configure file-based pattern sets by using the CLI

At the command prompt, type the following commands:

  • Import a new pattern set file into the Citrix ADC appliance.

     import policy patsetfile <src> <name> -delimiter <char> -charset <ASCII | UTF_8>


     import policy patsetfile local:test.csv clientids_list –delimiter ,

    You can import a file from a local device, HTTP server, or FTP server. To add the file from your local device, the file must be available in /var/tmp location.

  • Add a pattern set file to the packet engine.

     add policy patsetfile <patset filename>


     add policy patsetfile clientids_list
  • Update an existing pattern set file on the Citrix ADC appliance.

     update policy patsetfile <patset filename>


     update policy patsetfile clientids_list
  • Bind patterns to the pattern set.

     add policy patset <patset name> -patsetfile <patset filename>


     add policy patset clientid_patset -patsetfile clientids_list
  • Verify the configuration.

     show policy patsetfile clientids_list
     Name: clientids_list
     Patset Name: clientid_patset
     Number of Imported Patterns: 8
     Number of Bound Patterns: 8
     (All the patterns bound successfully)

Configure file-based pattern sets by using the GUI

  1. Navigate to AppExpert-> Pattern Set Files.

  2. In the Imported pane, click Import.

  3. In the Configure Policy Patset File page, select the file you want to import, and click OK.

  4. Select the imported file, and click Add.

  5. In the Create Policy Patset File page, enter the details, and click Create to add a policy pattern set.

Configuring a Pattern Set