StyleBook configuration

Create a StyleBook to perform non-CRUD operations

January 8, 2024

Contributed by:

StyleBooks manage NetScaler configurations by computing the necessary configuration objects on the NetScaler instances. These objects are added, updated, or removed from the instance each time you create or update a ConfigPack. That is when you specify the “desired state.”

However, some NetScaler configuration objects support a few operations other than create, update, or delete (CRUD operations). For example, a load balancer object (lbvserver) or a NetScaler feature object (nsfeature) can support the “enable” or “disable” operation. Similarly, NetScaler certkeys support the “link” and “unlink” operation to link or unlink a certificate to another certificate. These operations on NetScaler objects are called as non-CRUD operations.

This section describes how to perform non-CRUD operations on configuration objects that support them using StyleBooks.

Note

The binding between configuration objects (for example, bind a certkey to a lbvserver) is not a non-CRUD operation because NITRO bindings are represented as configuration objects in their own right. These objects are created and deleted like any other NetScaler configuration object.

Supporting the non-CRUD operations

A construct called meta-properties is added in the component at the same level as the properties construct. The supported attribute supported in this construct is called action. This attribute can take values like enable, disable, link, unlink, import, export, create, archive, and apply.

components:
 -
  name: my-lbvserver-comp
  type: ns::lbvserver
  meta-properties
   action: enable
  properties:
    name: $parameters.name
    servicetype: HTTP
    ipv46: $parameters.ip
    port: 80
    lbmethod: $parameters.lb-alg
<!--NeedCopy-->

In this example, the my-lbvserver-comp component is of the type ns::lbvserver. The “ns” is the prefix that refers to the namespace netscaler.nitro.config and version ** 10.5 that you specified in the import-stylebooks section. The lbvserver is a NITRO resource in this namespace. As an implicit action, the StyleBook creates lbvserver and then completes the “enable” operation on it.

The action in the meta-properties is done on the configuration object only during the creation of the configPack. Updates to the configPack do not perform non-CRUD actions.

You can specify expressions for a meta-property. These expressions dynamically apply the valid meta-property actions for NetScaler objects.

Example:

parameters:
-
    name: meta-action-lbvserver
    type: string
    default: disable
    allowed-values:
      - enable
      - disable

components:
  -
    name: c1
    type: ns::lbvserver
    meta-properties:
      action: $parameters.meta-action-lbvserver
    properties:
      name: $parameters.lbvserver
      ipv46: $parameters.ip
      port: 80
      servicetype: HTTP
<!--NeedCopy-->

In this example, a StyleBook user can specify a valid meta property action while creating a configuration pack.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Create a StyleBook to perform non-CRUD operations

January 8, 2024

Contributed by:

January 8, 2024

Contributed by:

Create a StyleBook to perform non-CRUD operations

Supporting the non-CRUD operations

In this article