netscaler.adc.cmpparameter (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for CMP parameter resource.

Inputs

    
nsip:
    description:
    - 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.
    required: true
    type: str

state:
    choices:
    - present
    - unset
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(present), the resource will be added/updated configured according to the
      module's parameters.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

cmplevel:
    choices:
    - optimal
    - bestspeed
    - bestcompression
    description:
    - 'Specify a compression level. Available settings function as follows:'
    - ' * Optimal - Corresponds to a gzip GZIP level of 5-7.'
    - ' * Best speed - Corresponds to a gzip level of 1.'
    - ' * Best compression - Corresponds to a gzip level of 9.'
    type: str

cmponpush:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Citrix ADC does not wait for the quantum to be filled before starting to compress
      data. Upon receipt of a packet with a PUSH flag, the appliance immediately begins
      compression of the accumulated packets.
    type: str

servercmp:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Allow the server to send compressed data to the Citrix ADC. With the default setting,
      the Citrix ADC appliance handles all compression.
    type: str

heurexpiry:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Heuristic basefile expiry.
    type: str

minressize:
    description:
    - Smallest response size, in bytes, to be compressed.
    type: float

nitro_pass:
    description:
    - The password with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

policytype:
    choices:
    - ADVANCED
    description:
    - Type of the policy. The only possible value is C(ADVANCED)
    type: str

quantumsize:
    description:
    - Minimum quantum of data to be filled before compression begins.
    type: float

save_config:
    default: false
    description:
    - If C(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.
    type: bool

cmpbypasspct:
    description:
    - 'Citrix ADC CPU threshold after which compression is not performed. Range: 0 - 100'
    type: float

addvaryheader:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Control insertion of the Vary header in HTTP responses compressed by Citrix ADC.
      Intermediate caches store different versions of the response for different values
      of the headers present in the Vary response header.
    type: str

externalcache:
    choices:
    - 'YES'
    - 'NO'
    description:
    - 'Enable insertion of  Cache-Control: private response directive to indicate response
      message is intended for a single user and must not be cached by a shared or proxy
      cache.'
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

heurexpirythres:
    description:
    - Threshold compression ratio for heuristic basefile expiry, multiplied by 100. For
      example, to set the threshold ratio to 1.25, specify 125.
    type: float

varyheadervalue:
    description:
    - The value of the HTTP Vary header for compressed responses. If this argument is
      not specified, a default value of "Accept-Encoding" will be used.
    type: str

heurexpiryhistwt:
    description:
    - For heuristic basefile expiry, weightage to be given to historical delta compression
      ratio, specified as percentage.  For example, to give 25% weightage to historical
      ratio (and therefore 75% weightage to the ratio for current delta compression transaction),
      specify 25.
    type: float

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

Outputs

changed:
  description: Indicates if any change is made by the module
  returned: always
  sample: true
  type: bool
diff:
  description: Dictionary of before and after changes
  returned: always
  sample:
    after:
      key2: pqr
    before:
      key1: xyz
    prepared: changes done
  type: dict
diff_list:
  description: 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'
  type: list
failed:
  description: Indicates if the module failed or not
  returned: always
  sample: false
  type: bool
loglines:
  description: list of logged messages by the module
  returned: always
  sample:
  - message 1
  - message 2
  type: list