netscaler.adc.lsnparameter (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 LSN 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

memlimit:
    description:
    - Amount of Citrix ADC memory to reserve for the LSN feature, in multiples of 2MB.
    - ''
    - 'Note: If you later reduce the value of this parameter, the amount of active memory
      is not reduced. Changing the configured memory limit can only increase the amount
      of active memory.'
    - This command is deprecated, use 'set extendedmemoryparam -memlimit' instead.
    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

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

sessionsync:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Synchronize all LSN sessions with the secondary node in a high availability (HA)
      deployment (global synchronization). After a failover, established TCP connections
      and UDP packet flows are kept active and resumed on the secondary node (new primary).
    - ''
    - The global session synchronization parameter and session synchronization parameters
      (group level) of all LSN groups are enabled by default.
    - ''
    - For a group, when both the global level and the group level LSN session synchronization
      parameters are enabled, the primary node synchronizes information of all LSN sessions
      related to this LSN group with the secondary node.
    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

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

subscrsessionremoval:
    choices:
    - ENABLED
    - DISABLED
    description:
    - LSN global setting for controlling subscriber aware session removal, when this is
      enabled, when ever the subscriber info is deleted from subscriber database, sessions
      corresponding to that subscriber will be removed. if this setting is disabled, subscriber
      sessions will be timed out as per the idle time out settings.
    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