netscaler.adc.feoaction module – Configuration for Front end optimization action resource.

Note

This module is part of the netscaler.adc collection (version 2.6.2).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.feoaction.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for Front end optimization action resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

cachemaxage

float

Maxage for cache extension.

clientsidemeasurements

boolean

Send AppFlow records about the web pages optimized by this action. The records provide FEO statistics, such as the number of HTTP requests that have been reduced for this page. You must enable the Appflow feature before enabling this parameter.

Choices:

  • false

  • true

boolean

Convert CSS import statements to HTML link tags.

Choices:

  • false

  • true

csscombine

boolean

Combine one or more CSS files into one file.

Choices:

  • false

  • true

cssimginline

boolean

Inline small images (less than 2KB) referred within CSS files as background-URLs

Choices:

  • false

  • true

cssinline

boolean

Inline CSS files, whose size is less than 2KB, within the main page.

Choices:

  • false

  • true

cssminify

boolean

Remove comments and whitespaces from CSSs.

Choices:

  • false

  • true

cssmovetohead

boolean

Move any CSS file present within the body tag of an HTML page to the head tag.

Choices:

  • false

  • true

dnsshards

list / elements=string

Set of domain names that replaces the parent domain.

domainsharding

string

Domain name of the server

htmlminify

boolean

Remove comments and whitespaces from an HTML page.

Choices:

  • false

  • true

imggiftopng

boolean

Convert GIF image formats to PNG formats.

Choices:

  • false

  • true

imginline

boolean

Inline images whose size is less than 2KB.

Choices:

  • false

  • true

imglazyload

boolean

Download images, only when the user scrolls the page to view them.

Choices:

  • false

  • true

imgshrinktoattrib

boolean

Shrink image dimensions as per the height and width attributes specified in the <img> tag.

Choices:

  • false

  • true

imgtojpegxr

boolean

Convert JPEG, GIF, PNG image formats to JXR format.

Choices:

  • false

  • true

imgtowebp

boolean

Convert JPEG, GIF, PNG image formats to WEBP format.

Choices:

  • false

  • true

jpgoptimize

boolean

Remove non-image data such as comments from JPEG images.

Choices:

  • false

  • true

jsinline

boolean

Convert linked JavaScript files (less than 2KB) to inline JavaScript files.

Choices:

  • false

  • true

jsminify

boolean

Remove comments and whitespaces from JavaScript.

Choices:

  • false

  • true

jsmovetoend

boolean

Move any JavaScript present in the body tag to the end of the body tag.

Choices:

  • false

  • true

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

name

string

The name of the front end optimization action.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

pageextendcache

boolean

Extend the time period during which the browser can use the cached resource.

Choices:

  • false

  • true

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

---
- name: Sample feoaction playbook
  hosts: demo_netscalers
  gather_facts: false
  tasks:
    - name: Configure feoaction
      delegate_to: localhost
      netscaler.adc.feoaction:
        state: present
        name: allact_ns
        clientsidemeasurements: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)

  • Shiva Shankar Vaddepally (@shivashankar-vaddepally)