netscaler.adc.nsvariable (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 variable resource.

Inputs

    
init:
    description:
    - 'Initialization value for this variable, to which a singleton variable or map entry
      will be set if it is referenced before an assignment action has assigned it a value.
      If the singleton variable or map entry already has been assigned a value, setting
      this parameter will have no effect on that variable value. Default: 0 for ulong,
      NULL for text'
    type: str

name:
    description:
    - 'Variable name.  This follows the same syntax rules as other expression entity names:'
    - '   It must begin with an alpha character (A-Z or a-z) or an underscore (_).'
    - '   The rest of the characters must be alpha, numeric (0-9) or underscores.'
    - '   It cannot be re or xp (reserved for regular and XPath expressions).'
    - '   It cannot be an expression reserved word (e.g. SYS or HTTP).'
    - '   It cannot be used for an existing expression object (HTTP callout, patset, dataset,
      stringmap, or named expression).'
    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

type:
    description:
    - 'Specification of the variable type; one of the following:'
    - '   ulong - singleton variable with an unsigned 64-bit value.'
    - '   text(value-max-size) - singleton variable with a text string value.'
    - '   map(text(key-max-size),ulong,max-entries) - map of text string keys to unsigned
      64-bit values.'
    - '   map(text(key-max-size),text(value-max-size),max-entries) - map of text string
      keys to text string values.'
    - where
    - '   value-max-size is a positive integer that is the maximum number of bytes in
      a text string value.'
    - '   key-max-size is a positive integer that is the maximum number of bytes in a
      text string key.'
    - '   max-entries is a positive integer that is the maximum number of entries in a
      map variable.'
    - '      For a global singleton text variable, value-max-size <= 64000.'
    - '      For a global map with ulong values, key-max-size <= 64000.'
    - '      For a global map with text values,  key-max-size + value-max-size <= 64000.'
    - '   max-entries is a positive integer that is the maximum number of entries in a
      map variable. This has a theoretical maximum of 2^64-1, but in actual use will be
      much smaller, considering the memory available for use by the map.'
    - 'Example:'
    - '   map(text(10),text(20),100) specifies a map of text string keys (max size 10
      bytes) to text string values (max size 20 bytes), with 100 max entries.'
    type: str

scope:
    choices:
    - global
    - transaction
    description:
    - 'Scope of the variable:'
    - '   C(global) - (default) one set of values visible across all Packet Engines on
      a standalone Citrix ADC, an HA pair, or all nodes of a cluster'
    - '   C(transaction) - one value for each request-response C(transaction) (singleton
      variables only; no expiration)'
    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

iffull:
    choices:
    - undef
    - lru
    description:
    - 'Action to perform if an assignment to a map exceeds its configured max-entries:'
    - '   C(lru) - (default) reuse the least recently used entry in the map.'
    - '   C(undef) - force the assignment to return an undefined (Undef) result to the
      policy executing the assignment.'
    type: str

comment:
    description:
    - Comments associated with this variable.
    type: str

expires:
    description:
    - Value expiration in seconds. If the value is not referenced within the expiration
      period it will be deleted. 0 (the default) means no expiration.
    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

ifnovalue:
    choices:
    - undef
    - init
    description:
    - Action to perform if on a variable reference in an expression if the variable is
      single-valued and uninitialized
    - 'or if the variable is a map and there is no value for the specified key:'
    - '   C(init) - (default) initialize the single-value variable, or create a map entry
      for the key and the initial value,'
    - using the -C(init) value or its default.
    - '   C(undef) - force the expression evaluation to return an undefined (Undef) result
      to the policy executing the expression.'
    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

ifvaluetoobig:
    choices:
    - undef
    - truncate
    description:
    - Action to perform if an value is assigned to a text variable that exceeds its configured
      max-size,
    - 'or if a key is used that exceeds its configured max-size:'
    - '   C(truncate) - (default) C(truncate) the text string to the first max-size bytes
      and proceed.'
    - '   C(undef) - force the assignment or expression evaluation to return an undefined
      (Undef) result to the policy executing the assignment or expression.'
    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

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