Product Documentation

Operations

Operations is an optional section in a StyleBook. In this section, you can configure Citrix Application Delivery Management (ADM) analytics to collect AppFlow records on all or some of the traffic transactions. The virtual server created on a Citrix ADC instance by using the StyleBook handles these traffic transactions. In this section, you can also configure Citrix ADM to trigger alarms when certain traffic conditions are met on a virtual server.

You can configure Citrix ADM through StyleBooks to collect traffic statistics from various Citrix ADM Insights that are listed as follows:

  • Web Insight
  • Security Insight
  • HDX Insight
  • Citrix Gateway Insight.

The virtual servers supported are load balancing, content switching, and VPN virtual servers.

Enable both Web Insight and Security Insight or one of them for analytics on a load balancing or content switching virtual server. For VPN virtual servers, however, you must enable both HDX Insight and Citrix Gateway Insight or one of them.

Any Citrix ADM Insight enabled on Citrix ADC instances through StyleBooks uses IPFIX protocol (AppFlow) to send the data from the instances to Citrix ADC.

Also, when you enable Web Insight, “Client-Side Measurements” is enabled on the load balancing and the content switching virtual servers.

Example 1:

The following example shows how to write the operations section in a StyleBook to enable both HDX Insight and Citrix Gateway Insight on a VPN virtual server:


name: simple-vpn-ops
namespace: com.example.stylebooks
schema-version: "1.0"
version: "0.1"
description: Test StyleBook to enable hdxinsight and gatewayinsight on a VPN vserver
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    version: "10.5"
    prefix: ns
components:
    -
        name: vpnvserver-comp
        type: ns::vpnvserver
        properties:
            name: str("vpn-") + str($current-target.ip)
            servicetype: SSL
            ipv46: 1.1.21.37
            port: 443
operations:
    analytics:
        -
            name: comp-ops
            properties:
                target: $components.vpnvserver-comp
                filter: "true"
                insights:
                  -
                 type: hdxinsight**
                  -
                    type: gatewayinsight
outputs:
  -
    name: myvpns
    value: $components.vpnvserver-comp

Example 2:

The following example shows how to write the operations section in a StyleBook to enable both Web Insight and Security Insight on a load balancing virtual server:


name: simple-lb-ops
namespace: com.example.stylebooks
schema-version: "1.0"
version: "0.1"
description: Test StyleBook to enable webinsight and securityinsight on LB vserver
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    version: "10.5"
    prefix: ns
components:
    -
        name: lbvserver-comp
        type: ns::lbvserver
        properties:
            name: str("lb-") + str($current-target.ip)
            servicetype: HTTP
            ipv46: 1.1.21.37
            port: 80
operations:
    analytics:
        -
            name: comp-ops
            properties:
                target: $components.lbvserver-comp
                filter: "true"
                 insights:
                 -
                  type: webinsight
                   -
                  type: securityinsight
outputs:
  -
    name: mylbs
    value: $components.lbvserver-comp

Operations

In this article