netscaler.adc.nstimeout (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 timeout 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

client:
    description:
    - Client idle timeout (in seconds). If zero, the service-type default value is taken
      when service is created.
    type: float

server:
    description:
    - Server idle timeout (in seconds).  If zero, the service-type default value is taken
      when service is created.
    type: float

zombie:
    description:
    - Interval, in seconds, at which the Citrix ADC zombie cleanup process must run. This
      process cleans up inactive TCP connections.
    type: float

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

anyclient:
    description:
    - Global idle timeout, in seconds, for non-TCP client connections. This value is over
      ridden by the client timeout that is configured on individual entities.
    type: float

anyserver:
    description:
    - Global idle timeout, in seconds, for non TCP server connections. This value is over
      ridden by the server timeout that is configured on individual entities.
    type: float

halfclose:
    description:
    - Idle timeout, in seconds, for connections that are in TCP half-closed state.
    type: float

tcpclient:
    description:
    - Global idle timeout, in seconds, for non-HTTP client connections of TCP service
      type. This value is over ridden by the client timeout that is configured on individual
      entities.
    type: float

tcpserver:
    description:
    - Global idle timeout, in seconds, for non-HTTP server connections of TCP service
      type. This value is over ridden by the server timeout that is configured on entities.
    type: float

httpclient:
    description:
    - Global idle timeout, in seconds, for client connections of HTTP service type. This
      value is over ridden by the client timeout that is configured on individual entities.
    type: float

httpserver:
    description:
    - Global idle timeout, in seconds, for server connections of HTTP service type. This
      value is over ridden by the server timeout that is configured on individual entities.
    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

anytcpclient:
    description:
    - Global idle timeout, in seconds, for TCP client connections. This value takes precedence
      over  entity level timeout settings (vserver/service). This is applicable only to
      transport protocol TCP.
    type: float

anytcpserver:
    description:
    - Global idle timeout, in seconds, for TCP server connections. This value takes precedence
      over entity level timeout settings ( vserver/service). This is applicable only to
      transport protocol TCP.
    type: float

nontcpzombie:
    description:
    - Interval at which the zombie clean-up process for non-TCP connections should run.
      Inactive IP NAT connections will be cleaned up.
    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

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

reducedfintimeout:
    description:
    - Alternative idle timeout, in seconds, for closed TCP NATPCB connections.
    type: float

reducedrsttimeout:
    description:
    - Timer interval, in seconds, for abruptly terminated TCP NATPCB connections.
    type: float

newconnidletimeout:
    description:
    - Timer interval, in seconds, for new TCP NATPCB connections on which no data was
      received.
    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