netscaler.adc.nshttpparam (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 HTTP 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

nssrvrhdr:
    description:
    - The server header value to be inserted. If no explicit header is specified then
      NSBUILD.RELEASE is used as default server header.
    type: str

logerrresp:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Server header value to be inserted.
    type: str

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

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

conmultiplex:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Reuse server connections for requests from more than one client connections.
    type: str

insnssrvrhdr:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable or disable Citrix ADC server header insertion for Citrix ADC generated HTTP
      responses.
    type: str

maxreusepool:
    description:
    - Maximum limit on the number of connections, from the Citrix ADC to a particular
      server that are kept in the reuse pool. This setting is helpful for optimal memory
      utilization and for reducing the idle connections to the server just after the peak
      time.
    type: float

dropinvalreqs:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Drop invalid HTTP requests or responses.
    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

http2serverside:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable/Disable HTTP/2 on server side
    type: str

markhttp09inval:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Mark HTTP/0.9 requests as invalid.
    type: str

markconnreqinval:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Mark CONNECT requests as invalid.
    type: str

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

ignoreconnectcodingscheme:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Ignore Coding scheme in CONNECT request.
    type: str

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