netscaler.adc.vserver (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 virtual server resource.

Inputs

    
name:
    description:
    - The name of the virtual server to be removed.
    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
    - enabled
    - disabled
    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(enabled), the resource will be enabled on the NetScaler ADC node.
    - When C(disabled), the resource will be disabled 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

somethod:
    choices:
    - CONNECTION
    - DYNAMICCONNECTION
    - BANDWIDTH
    - HEALTH
    - NONE
    description:
    - The spillover factor. The system will use this value to determine if it should send
      traffic to the backupvserver when the main virtual server reaches the spillover
      threshold.
    type: str

cacheable:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Use this option to specify whether a virtual server (used for load balancing or
      content switching) routes requests to the cache redirection virtual server before
      sending it to the configured servers.
    type: str

clttimeout:
    description:
    - The timeout value in seconds for idle client connection
    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

pushvserver:
    description:
    - The lb vserver of type PUSH/SSL_PUSH to which server pushes the updates received
      on the client facing non-push lb vserver.
    type: str

redirecturl:
    description:
    - The URL where traffic is redirected if the virtual server in the system becomes
      unavailable.
    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

sothreshold:
    description:
    - The spillver threshold value.
    type: float

backupvserver:
    description:
    - The name of the backup virtual server for this virtual server.
    type: str

sopersistence:
    choices:
    - ENABLED
    - DISABLED
    description:
    - The state of the spillover persistence.
    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

sopersistencetimeout:
    description:
    - The spillover persistence entry timeout.
    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