netscaler.adc.quicprofile (2.5.1) — module

Configuration for QUIC profile resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

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 QUIC profile resource.

Inputs

    
name:
    description:
    - Name for the QUIC profile. Must begin with an ASCII alphanumeric or underscore (_)
      character, and must contain only ASCII alphanumeric, underscore, hash (#), period
      (.), space, colon (:), at (@),equals sign (=), and hyphen (-) characters. Cannot
      be changed after the profile is created.
    type: str

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
    - absent
    - 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(absent), the resource will be deleted from the NetScaler ADC node.
    - 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

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

maxackdelay:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the maximum amount of time, in milliseconds, by which the Citrix ADC will delay
      sending acknowledgments.
    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

initialmaxdata:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the initial value, in bytes, for the maximum amount of data that can be sent on
      a QUIC connection.
    type: float

maxidletimeout:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the maximum idle timeout, in seconds, for a QUIC connection. A QUIC connection will
      be silently discarded by the Citrix ADC if it remains idle for longer than the minimum
      of the idle timeout values advertised by the Citrix ADC and the remote QUIC endpoint,
      and three times the current Probe Timeout (PTO).
    type: float

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

ackdelayexponent:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, indicating
      an exponent that the remote QUIC endpoint should use, to decode the ACK Delay field
      in QUIC ACK frames sent by the Citrix ADC.
    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

maxudppayloadsize:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the size of the largest UDP datagram payload, in bytes, that the Citrix ADC is willing
      to receive on a QUIC connection.
    type: float

initialmaxstreamsuni:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the initial maximum number of unidirectional streams the remote QUIC endpoint may
      initiate.
    type: float

initialmaxstreamsbidi:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the initial maximum number of bidirectional streams the remote QUIC endpoint may
      initiate.
    type: float

newtokenvalidityperiod:
    description:
    - An integer value, specifying the validity period, in seconds, of address validation
      tokens issued through QUIC NEW_TOKEN frames sent by the Citrix ADC.
    type: float

activeconnectionidlimit:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the maximum number of QUIC connection IDs from the remote QUIC endpoint, that the
      Citrix ADC is willing to store.
    type: float

congestionctrlalgorithm:
    choices:
    - Default
    - NewReno
    - CUBIC
    - BBR
    description:
    - Specify the congestion control algorithm to be used for QUIC connections. The default
      congestion control algorithm is C(CUBIC).
    type: str

initialmaxstreamdatauni:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the initial flow control limit, in bytes, for unidirectional streams initiated by
      the remote QUIC endpoint.
    type: float

maxudpdatagramsperburst:
    description:
    - An integer value, specifying the maximum number of UDP datagrams that can be transmitted
      by the Citrix ADC in a single transmission burst on a QUIC connection.
    type: float

retrytokenvalidityperiod:
    description:
    - An integer value, specifying the validity period, in seconds, of address validation
      tokens issued through QUIC Retry packets sent by the Citrix ADC.
    type: float

activeconnectionmigration:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Specify whether the Citrix ADC should allow the remote QUIC endpoint to perform
      active QUIC connection migration.
    type: str

statelessaddressvalidation:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Specify whether the Citrix ADC should perform stateless address validation for QUIC
      clients, by sending tokens in QUIC Retry packets during QUIC connection establishment,
      and by sending tokens in QUIC NEW_TOKEN frames after QUIC connection establishment.
    type: str

initialmaxstreamdatabidilocal:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the initial flow control limit, in bytes, for bidirectional QUIC streams initiated
      by the Citrix ADC.
    type: float

initialmaxstreamdatabidiremote:
    description:
    - An integer value advertised by the Citrix ADC to the remote QUIC endpoint, specifying
      the initial flow control limit, in bytes, for bidirectional QUIC streams initiated
      by the remote QUIC endpoint.
    type: float

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