Provisioning of NetScaler VPX instance on OpenStack using StyleBook

Last published : Sep 21, 2026
In the OpenStack orchestration workflow, NetScaler Console now uses the os-cs-lb-mon StyleBook to deploy LBaaS configurations on NetScaler instances allotted to the OpenStack tenant. A config pack is created for each load balancer created by the OpenStack user.
Using StyleBooks for configuration in an OpenStack workflow provides the following benefits:
  • Better visualization by viewing all the configuration objects.
  • Reliability through rollback.
  • Support for various NetScaler instance types (NetScaler HA, partitions, VPX, CPX, MPX, and others.)
  • Customization by using your own StyleBooks to deploy configuration for OpenStack tenants.
As NetScaler Console admin, navigate to Applications > Configurations to view the config pack deployed on the NetScaler instance. You can perform the following tasks:
  • Scroll to view the os-cs-lb-mon config pack deployed for the load balancer.
  • Click View Definition on the os-cs-lb-mon StyleBook panel to check the configuration that is deployed on the instances.
  • Click View Object to view the list of NetScaler objects or entities deployed on the instances.

Points to note before provisioning instances using StyleBooks

From NetScaler Console 12.1 build 49.23 onwards, the architecture of an OpenStack orchestration workflow has been updated. The workflow now uses NetScaler Console StyleBooks to configure NetScaler instances. If you are upgrading to NetScaler Console 12.1 build 49.23 from either version 12.0 or from version 12.1 build 48.18, you must run the following migration script:
/mps/scripts/migration_scripts/migrate_configurations.py
  • Running the migration script creates config packs of the os-cs-lb-mon StyleBook corresponding to the existing OpenStack configurations.
  • Running this migration script is mandatory if you had OpenStack configurations deployed from these earlier builds.
  • You can deploy new configurations on the instances using the os-cs-lb-mon StyleBook only after you run the migration script from version 12.1 build 49.23.
  • All configurations attempted from OpenStack fail until the migration script is run.
Note
  • Once you run the migration script, you cannot downgrade to the previous build of NetScaler Console.
  • Ensure that you have upgraded the NetScaler drivers for OpenStack LBaaS V2 to the latest version. Use the NetScaler bundle files provided along with the latest NetScaler Console 13.0 build.
LBaaS V2 API implementations are performed through Neutron LBaaS commands. Connect to any Neutron client and run the configuration tasks. For more information on how to run configuration commands, see Configuring LBaaS V2 using Command Line.