netscaler.adc.forwardingsession (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 session forward resource.

Inputs

    
td:
    description:
    - Integer value that uniquely identifies the traffic domain in which you want to configure
      the entity. If you do not specify an ID, the entity becomes part of the default
      traffic domain, which has an ID of 0.
    type: float

name:
    description:
    - Name for the forwarding session rule. Can begin with a letter, number, or the underscore
      character (_), and can consist of letters, numbers, and the hyphen (-), period (.)
      pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
      Cannot be changed after the rule is created.
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my rule" or 'my rule').
    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
    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.
    type: str

aclname:
    description:
    - Name of any configured ACL whose action is ALLOW. The rule of the ACL is used as
      a forwarding session rule.
    type: str

netmask:
    description:
    - Subnet mask associated with the network.
    type: str

network:
    description:
    - An IPv4 network address or IPv6 prefix of a network from which the forwarded traffic
      originates or to which it is destined.
    type: str

acl6name:
    description:
    - Name of any configured ACL6 whose action is ALLOW. The rule of the ACL6 is used
      as a forwarding session rule.
    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

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

connfailover:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Synchronize connection information with the secondary appliance in a high availability
      (HA) pair. That is, synchronize all connection-related information for the forwarding
      session.
    type: str

processlocal:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enabling this option on forwarding session will not steer the packet to flow processor.
      Instead, packet will be routed.
    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

sourceroutecache:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Cache the source ip address and mac address of the DA servers.
    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