Operations

The Operations is an optional section in a StyleBook. In this section, you can configure Citrix 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 the traffic transactions. 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 the various Citrix ADM insights that are listed as follows:

• Bot Insight
• Web Insight
• Security Insight
• HDX Insight
• Citrix ADC 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 ADC Gateway Insight or one of them.

Any Citrix ADM insight enabled on Citrix ADC instances through StyleBooks uses an 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. With this feature enabled, Citrix ADM captures load time and render time metrics for HTML pages, through HTML injection. Using these metrics, admins can identify L7 latency issues.

After you enable a particular Citrix ADM insight, view the Application Overview page to see the threat details associated with that insight.

Example 1:

The following example shows how to write the operations section in a StyleBook to enable both HDX Insight and Citrix ADC 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
<!--NeedCopy-->

Example 2:

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

---
name: enable-insights
namespace: com.acme.stylebooks
description: "This StyleBook enables Web,Security & Bot Insight on Load Balancing Vserver"
display-name: "SB Operations"
schema-version: "1.0"
version: "1.0"
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    prefix: ns
    version: "10.5"

parameters:



 -
    name: lbname
    type: string
    required: true
  -
    name: vip
    type: ipaddress
    required: true
  -
    name: appflowfilter
    type: string
    required: true

components:
  -
    name: my-lbvserver-comp
    type: ns::lbvserver
    properties:
      name: $parameters.lbname
      servicetype: HTTP
      ipv46: $parameters.vip
      port: 80

outputs:
  -
    name: mylb
    value: $components.my-lbvserver-comp

operations:
  analytics:
    -
      name: lbvserver-op
      properties:
        target: $outputs.mylb
        filter: $parameters.appflowfilter
        insights:
          -
            type: webinsight
          -
            type: securityinsight
          -
            type: botinsight
<!--NeedCopy-->