How to Use User-Defined StyleBooks in NetScaler MAS

Feb 26, 2018

After you have built your StyleBook, you have to import it to NetScaler MAS to use it. NetScaler MAS allows you to import a single StyleBook in YAML form or multiple StyleBook YAML files as a bundle in a .zip, .tgz, or .gz form. The NetScaler MAS system validates your StyleBooks on import. The Stylebook is now ready to be used for creating configurations.

NetScaler MAS also has a built-in YAML editor that you can use to compose the StyleBook YAML contents. The YAML editor allows you to validate your YAML constructs from NetScaler MAS GUI itself. You do not need to use a separate tool for these validation checks. The content is validated against YAML standards and any deviation is highlighted. You can then correct the content and attempt to import the StyleBook into NetScaler MAS. The built-in YAML editor provides two advantages while writing your own StyleBook.

  • Color coded. The editor displays the StyleBook content parsed as per YAML guidelines, and the color coding helps you to differentiate easily between the keys and the values defined in YAML content.
  • YAML validation. The content is validated for any YAML errors as you type in and any deviation is immediately highlighted. This allows you to write text that conforms to YAML guidelines even before you import the StyleBook in NetScaler MAS. Note: Currently, the editor validates the content according to YAML guidelines. It does not validate for code correctness and typographical errors.

Use your StyleBook

  1. In NetScaler MAS, navigate to Applications > Configuration > StyleBooks, and then click Import StyleBook.

  2. Click one of the three options available for you to import the StyleBook.

    • File - select the required file or the bundle of files from your local storage.

      Note: In this example, import the “lb-vserver.yaml” StyleBook that you had created in StyleBook to Create a Load Balancing Virtual Server.

      localized image

    • Bundle - NetScaler MAS allows you to import multiple StyleBooks in YAML format. You can import more than one YAML StyleBook file that are compressed in a zip (.zip) format or tarball (.tgz, .gz) format.

      localized image

    • Raw - Compose the content of your StyleBook in the YAML editor.

    Note: While composing StyleBook, make sure you have knowledge of the following:

    • YAML

    For more information about how to write your own StyleBooks, see How to Create Your Own StyleBooks.

    localized image

    Note: You can also copy and paste the content from a StyleBook YAML file to validate the content.

  3. Click Create.

    NetScaler MAS now validates your StyleBook for all syntactic and semantic errors according to the StyleBook grammar. Your StyleBook is not imported into NetScaler MAS if there are any errors. If there are no errors the StyleBook is successfully imported and is now listed on the StyleBooks page. You can identify the StyleBook by the display name that you had defined in the header section of the StyleBook.

    localized image


    If you are importing a bundle of files, NetScaler MAS decompresses the zipped folder and validates all the StyleBooks. The bundle is not imported even if one StyleBook file fails the validation test.

    For more information on StyleBook grammar and syntax of the different constructs and attributes, see StyleBook Grammar.

  4. To create configurations from this StyleBook, click Create Configuration link. The StyleBook opens as a user interface page on which you can enter the values for all the parameters defined in this StyleBook.

  5. Specify the required values for the parameters. In the example below, you can see that application name and the load balancer IP address fields are displayed as mandatory fields and can accept user values. The LB Algorithm has only two values that you can choose from and by default, ROUNDROBIN is selected.

    localized image

  6. Under Target Instances, click and select the IP address of the NetScaler instance where you want to run the configuration. Note that you can deploy the configuration on more than one NetScaler, by specifying as many target instances as needed.

    If you want to have a look at the NetScaler (Nitro) configuration objects that would be created on your NetScaler before actually creating the configuration, click Dry Run. If your configuration is valid, the configuration objects that would be created on the basis of the values you have provided are displayed. In this example, only one object of type lbvserver is created by this example StyleBook. This lbvserver was the only component that was defined in this basic example StyleBook. You can later click Create to actually create the configuration on the selected NetScaler instances.

Once the creation completed, the new configpack is listed on the Configurations page.


You can also click the refresh icon to add recently discovered NetScaler instances in NetScaler MAS to the available list of instances in this window.

localized image

How to Use User-Defined StyleBooks in NetScaler MAS