Citrix Application Delivery Management

Parameters

This section lets you define all the parameters that you require in your StyleBook to create a configuration. It describes the input that your StyleBook takes. Although this is an optional section, most StyleBooks might need one. You can consider the parameters section to define the questions you want users to answer when they use the StyleBook to create a configuration on a Citrix ADC instance.

When you import your StyleBook into Citrix ADM and use it to create a configuration, the GUI uses this section of the StyleBook to display a form that takes input for values of the parameters you have defined.

The following section describes the attributes that you need to specify for each parameter in this section:

name

The name of the parameter you want to define. You can specify an alphanumeric name.

The name must begin with an alphabet, and can include additional alphabets, numbers, hyphen (-), or underscore (_).

Note that when writing a StyleBook, you can use this “name” attribute to refer to the parameter in other sections by using the notation $parameters.<name>.

Mandatory? Yes

label

A string that is displayed in the ADM GUI as the name of this parameter.

Mandatory? No

description

A help string that describes what the parameter is used for. The ADM GUI displays this text when the user clicks the help icon for this parameter.

Mandatory? No

type

The type of value these parameters can take. Parameters can be of any of the following built-in types:

  • string: An array of characters. If a length is not specified, the string value can take any number of characters. However, you can limit the length of a string type by using the attributes min-length and max-length.

  • number: An integer number. You can specify the minimum and maximum number that this type can take by using the attributes min-value and max-value.

  • boolean: Can be either true or false. Also, note that all the literals are considered by YAML as booleans (for example, Yes or No).

  • ipaddress: A string that represents a valid IPv4 or IPv6 address.

  • tcp-port: A number between 0 and 65535 that represents a TCP or UDP port.

  • password: Represents an opaque/secret string value. When Citrix ADM GUI displays a value for this parameter, it is shown as asterisks (*****).

  • certfile: Represents a certificate file. This allows you to upload the files directly from your local system when you are creating a StyleBook configuration using the ADM GUI. The uploaded certificate file is stored in the directory /var/mps/tenants//ns_ssl_certs in ADM.

    The certificate file will be added to the list of certificates managed by ADM.

  • keyfile: Represents a certificate key file. This allows you to upload the file directly from your local system when you are creating a StyleBook configuration using the Citrix ADM GUI. The uploaded certificate file is stored in the directory /var/mps/tenants//ns_ssl_keys in Citrix ADM.

    The certificate key file will be added to the list of certificate keys managed by Citrix ADM.

  • file: Represents a file.

  • object: This type is used when you want to group several related parameters under a parent element. You have to specify the parent parameter the type as “object”. A parameter of type “object” can have a nested “parameters” section to describe the parameters it contains.

  • another StyleBook: When you use this type of parameter, then this parameter expects its value to be in the form of the parameters defined in the StyleBook denoting its type.

A parameter can also have a type that is a list of any of the types listed above, by adding “[]” to the end of the type. For example, if the type attribute is string[], this parameter takes a list of strings as input. You can provide one, two, or several strings for this parameter when creating a configuration from this StyleBook.

Mandatory? Yes

network

If you specify type: ipaddress, you can specify the network attribute to auto-allocate IP address from an ADM IPAM network.

ADM auto-allocates an IP address from the network attribute when you create a StyleBook configuration.

Example:

      name: virtual-ip
      label: "Load Balancer IP Address"
      type: ipaddress
      network: "network-1"
      required: true

In this example, the virtual-ip field auto-allocates an IP address from network-1.The IP address is released back to the network when the configuration is deleted.

key

Specify true or false to indicate if this parameter is a key parameter for the StyleBook.

A StyleBook can have only one parameter defined as the “key” parameter.

When you create different configurations from the same StyleBook (on the same or different Citrix ADC instances), each configuration has a different/unique value for this parameter.

Default value is false.

Mandatory? No

required

Specify true or false to indicate whether a parameter is mandatory or optional. If it is set to true, the parameter is mandatory. A user must provide a value for a mandatory parameter to create a configuration unless a default value is defined.

The Citrix ADM GUI forces the user to provide a valid value for this parameter.

Default value is false.

Mandatory? No

Note

If a parameter has type: object and required: false, the subparameters of this parameter are not evaluated.

If you want subparameters’ default value to take effect, set required: true for the main-parameter as follows:

    type: object
    required: true
    gui:
      collapse_pane: true

The collapse_pane attribute displays the object and its subparameters collapsed in the UI, unless the user expands the pane.

allowed-values

Use this attribute to define a list of valid values for a parameter, when the type is set to “string.”

When creating a configuration from the Citrix ADM GUI, the user is prompted to select a parameter value from this list.

Note

If you want to display the list values as radio options, set the layout attribute.

Example 1:

 -
   name: ipaddress
   type: string
   allowed-values:
     -  SOURCEIP
     -  DEST IP
     -  NONE

Example 2:

 -
   name: TCP Port
   type: tcp-port
   allowed-values:
     -  80
     -  81
     -  8080

Example 3:

(list of tcp-ports, where each element of the list can only have values specified in allowed-values)

  -
    name: tcpports
    type: tcp-port[]
    allowed-values:
      -  80
      -  81
      -  8080
      -  8081

Mandatory? No

default

Use this attribute to assign a default value to an optional parameter. While creating a configuration, if a user does not specify a value, the default value is used.

When creating the configuration from the Citrix ADM GUI, if a user does not provide a value for a parameter that does not have a default value, then no value is set for that parameter.

Example 1:

  -
    name: timeout
    type: number
    default: 20

Example 2:

(where, the default value of the parameter is a list of values):

  -
    name: protocols
    type: string[]
    default:
      - TCP
      - UDP
      - IP

Example 3:

  -
    name: timeout
    type: number
    default: 20

Example 4:

  -
    name: tcpport
    type: tcp-port
    default: 20

Mandatory? No

pattern

Use this attribute to define a pattern (regular expression) for the valid values of this parameter, when the type of the parameter is “string.”

Example:

  -
    name: appname
    type: string
    pattern: "[a-z]+"

Mandatory? No

min-value

Use this attribute to define the minimum value for parameters of type “number” or “tcp-port.”

Example:

  -
    name: audio-port
    type: tcp-port
    min-value: 5000

The min-value of numbers can be negative, but the min-value for tcp-port should not be negative.

Mandatory? No

max-value

Use this attribute to define the maximum value for parameters of type “number” or “tcp-port.”

The maximum value should be greater than the minimum value, if defined.

Example:

  -
    name: audio-port
    type: tcp-port
    min-value: 5000
    max-value: 15000

Mandatory? No

min-length

Use this attribute to define the minimum length of values accepted for a parameter of type “string.”

Minimum length of the characters defined as values should be greater or equal to zero.

Example:

  -
    name: appname
    type: string
    min-length: 3

Mandatory? No

max-length

Use this attribute to define the maximum length of values accepted for a parameter of type “string.”

Maximum length of the values should be greater or equal to the length of the characters defined in min-length.

Example:

  -
    name: appname
    type: string
    max-length: 64

Mandatory? No

min-items

Use this attribute to define the minimum number of items in a parameter that is a list.

The minimum number of items should be greater or equal to zero.

Example:

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2

Mandatory? No

max-items

Use this attribute to define the maximum number of items in a parameter that is a list.

The maximum number of items should be greater than the minimum number of items if defined.

Example:

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2
    max-items: 250

Mandatory? No

gui

Use this attribute to customize the layout of the parameter of type “object” in the Citrix ADM GUI.

Mandatory? No

columns

This is a sub-attribute of the gui attribute. This attribute is used for parameters of objects type list. These parameters display in the GUI as a table. Each row represents one object in the list, and the columns represent the object keys. Use this to define the number of columns to display in the Citrix ADM GUI.

By default, all object keys of type string are displayed.

Mandatory? No

updatable

This is a sub-attribute of the gui attribute. Use this to specify whether the parameter can be updated after the configuration is created.

If the value is set to false, the parameter field is greyed out when you update the configuration.

Mandatory? No

collapse_pane

This is a sub-attribute of the gui attribute. Use this to specify whether the pane defining the layout of this object parameter is collapsible.

If the value is set to true, the user can expand or collapse the child parameters under this parent parameter.

Example:

gui:
 collapse_pane: true
 columns: 2
 updatable: false

Example of a complete parameters section:


parameters:
   -
      name: name
      label: Name
      description: Name of the application
      type: string
      required: true
       -
         name: ip
         label: IP Address
         description: The virtual IP address used for this application
         type: ipaddress
         required: true
      -
         name: svc-servers
         label: Servers
         type: object\[\]
         required: true
         parameters:
            -
               name: svc-ip
               label: Server IP
               description: The IP address of the server
               type: ipaddress
               required: true
                -
                  name: svc-port
                  label: Server Port
                  description: The TCP port of the server
                  type: tcp-port
                  default: 80
      -
          name: lb-alg
          label: LoadBalancing Algorithm
          type: string
          allowed-values:
            - ROUNDROBIN
            - LEASTCONNECTION
          default: ROUNDROBIN
      -
          name: enable-healthcheck
          label: Enable HealthCheck?
          type: boolean
          default: true

The following is an example that defines all the attributes of a list and the values explained in earlier sections:

  -
    name: features-list
    type: string[]
    min-length: 1
    max-length: 3
    min-items: 1
    max-items: 3
    pattern: "\[A-Z\]+"
    allowed-values:
     - SP
     - LB
     - CS
    default:
     - LB

‘layout`

This attribute is a subattribute of the gui attribute. Use this attribute to display the list values as radio buttons. Set the layout attribute to radio in the parameter section of a StyleBook definition. It applies to the parameter that has the allowed-values attribute. When you create a configuration pack, the ADM GUI displays the values in the allowed-values list as radio buttons.

Example:

-
    gui:
        layout: radio
    allowed-values:
        - One
        - Two
        - Three

The One, Two, and Three values appear as radio buttons in the ADM GUI.

‘dependent-parameters’

This attribute is a subattribute of the gui attribute. It dynamically controls the parameter’s appearance or its initial value in the StyleBook configuration form based on the value specified in another parameter.

Specify this attribute on a source parameter that controls the parameter’s behavior on the form. You can include multiple conditions that control other parameters. For example, a source parameter protocol can have a dependent-parameter certificate, which only appears if the protocol parameter value is SSL.

Each condition can have the following attributes:

  • target-parameter: Specify the target parameter to which this condition applies.

  • matching-values: Specify the list of values of the source parameter that trigger the action.

  • action: Specify one of the following actions on the targeted parameter:

    • read-only: The parameter is made read-only.

    • show: The parameter appears in the form if it is hidden.

    • hide: The parameter is removed from the form.

    • set-value: The parameter value is set to the value specified in the value attribute.

  • value: The value of the target parameter if the action is set-value.

When a user input matches the specified values on the source parameter, the target parameter’s appearance or value changes according to the specified action.

Example:

 -
    name: lb-virtual-port
    label: "Load Balanced App Virtual Port"
    description: "TCP port representing the Load Balanced application"
    type: tcp-port
    gui:
      updatable: false
      dependent-parameters:
            -
              matching-values:
                - 80
              target-parameter: $parameters.lb-service-type
              action: set-value
              allowed-values:
              - HTTP
              - TCP
              - UDP

    default: 80

In this example, the dependent parameter is specified under the lb-virtual-port parameter (source parameter).

When the source parameter value is set to 80, the lb-service-type parameter triggers the set-value action. As a result, a user is allowed to select one of the following options:

  • HTTP
  • TCP
  • UDP