Application Delivery Management

Create a StyleBook to perform non-CRUD operations

December 31, 2023

Contributed by:

StyleBooks manage Citrix ADC configurations by computing the necessary configuration objects on the Citrix ADC 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 Citrix ADC configuration objects support a few operations other than create, update or delete (CRUD operations). For example, a load balancer object (lbvserver) or a Citrix ADC feature object (nsfeature) can support the “enable” or “disable” operation. Similarly, Citrix ADC certkeys support the “link” and “unlink” operation to link or unlink a certificate to another certificate. These operations on Citrix ADC 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 considered a non-CRUD operation. This is because Nitro bindings are represented as configuration objects in their own right. These objects are created and deleted like any other Citrix ADC configuration object.

Supporting the non-CRUD operations

A new construct called “meta-properties” is added in the component at the same level as the “properties” construct. The only attribute supported in this construct currently is called “action” This attribute can take values like “enable” or “disable” that are supported by that configuration object.

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 the above example, the “my-lbvserver-comp” component is of type “ns::lbvserver.” The “ns” is the prefix that refers to the namespace netscaler.nitro.config and version 10.5 that you had specified in the import-stylebooks section. The “lbvserver” is a NITRO resource in this namespace. As an implicit action, the lbvserver is first created by the StyleBook; then the “enable” operation is performed on it.

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

Note

The value of the action attribute cannot be a StyleBook expression that is evaluated dynamically.

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.

Create a StyleBook to perform non-CRUD operations

December 31, 2023

Contributed by:

December 31, 2023

Contributed by:

Create a StyleBook to perform non-CRUD operations

Supporting the non-CRUD operations

In this article