netscaler.adc.appflowparam (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 AppFlow parameter resource.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | appflowparam
      delegate_to: localhost
      netscaler.adc.appflowparam:
        state: present
        observationpointid: '2370493962'

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

events:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable Events to be sent to the Telemetry Agent
    type: str

httpurl:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the http URL that the Citrix ADC received from the client.
    type: str

httpvia:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the httpVia header which contains the IP address of proxy server through
      which the client accessed the server.
    type: str

metrics:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable Citrix ADC Stats to be sent to the Telemetry Agent
    type: str

udppmtu:
    description:
    - MTU, in bytes, for IPFIX UDP packets.
    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

httphost:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the host identified in the HTTP request that the appliance received from
      the client.
    type: str

auditlogs:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable Auditlogs to be sent to the Telemetry Agent
    type: str

httpcookie:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the cookie that was in the HTTP request the appliance received from the
      client.
    type: str

httpdomain:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the http domain request to be exported.
    type: str

httpmethod:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the method that was specified in the HTTP request that the appliance received
      from the client.
    type: str

lsnlogging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - On enabling this option, the Citrix ADC will send the Large Scale Nat(LSN) records
      to the configured collectors.
    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

aaausername:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable AppFlow AAA Username logging.
    type: str

httpreferer:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the web page that was last visited by the client.
    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

urlcategory:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the URL category record.
    type: str

cacheinsight:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Flag to determine whether cache records need to be exported or not. If this flag
      is true and IC is enabled, cache records are exported instead of L7 HTTP records
    type: str

cqareporting:
    choices:
    - ENABLED
    - DISABLED
    description:
    - TCP CQA reporting enable/disable knob.
    type: str

emailaddress:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable AppFlow user email-id logging.
    type: str

httplocation:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the HTTP location headers returned from the HTTP responses.
    type: str

videoinsight:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable/disable the feature individually on appflow action.
    type: str

httpsetcookie:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the Set-cookie header sent from the server to the client in response to
      a HTTP request.
    type: str

httpuseragent:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the client application through which the HTTP request was received by the
      Citrix ADC.
    type: str

appnamerefresh:
    description:
    - Interval, in seconds, at which to send Appnames to the configured collectors. Appname
      refers to the name of an entity (virtual server, service, or service group) in the
      Citrix ADC.
    type: float

httpsetcookie2:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the Set-cookie header sent from the server to the client in response to
      a HTTP request.
    type: str

identifiername:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the stream identifier name to be exported.
    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

httpcontenttype:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the HTTP Content-Type header sent from the server to the client to determine
      the type of the content sent.
    type: str

templaterefresh:
    description:
    - Refresh interval, in seconds, at which to export the template data. Because data
      transmission is in UDP, the templates must be resent at regular intervals.
    type: float

httpquerywithurl:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the HTTP query segment along with the URL that the Citrix ADC received from
      the client.
    type: str

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

clienttrafficonly:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Generate AppFlow records for only the traffic from the client.
    type: str

httpauthorization:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the HTTP Authorization header information.
    type: str

httpxforwardedfor:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the httpXForwardedFor header, which contains the original IP Address of
      the client using a proxy server to access the server.
    type: str

logstreamovernsip:
    choices:
    - ENABLED
    - DISABLED
    description:
    - To use the Citrix ADC IP to send Logstream records instead of the SNIP
    type: str

analyticsauthtoken:
    description:
    - Authentication token to be set by the agent.
    type: str

connectionchaining:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable connection chaining so that the client server flows of a connection are linked.
      Also the connection chain ID is propagated across Citrix ADCs, so that in a multi-hop
      environment the flows belonging to the same logical connection are linked. This
      id is also logged as part of appflow record
    type: str

distributedtracing:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable generation of the distributed tracing templates in the Appflow records
    type: str

flowrecordinterval:
    description:
    - Interval, in seconds, at which to send flow records to the configured collectors.
    type: float

gxsessionreporting:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable this option for Gx session reporting
    type: str

observationpointid:
    description:
    - An observation point ID is identifier for the NetScaler from which appflow records
      are being exported. By default, the NetScaler IP is the observation point ID.
    type: float

timeseriesovernsip:
    choices:
    - ENABLED
    - DISABLED
    description:
    - To use the Citrix ADC IP to send Time series data such as metrics and events, instead
      of the SNIP
    type: str

observationdomainid:
    description:
    - 'An observation domain groups a set of Citrix ADCs based on deployment: cluster,
      HA etc. A unique Observation Domain ID is required to be assigned to each such group.'
    type: float

subscriberawareness:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable this option for logging end user MSISDN in L4/L7 appflow records
    type: str

usagerecordinterval:
    description:
    - On enabling this option, the NGS will send bandwidth usage record to configured
      collectors.
    type: float

identifiersessionname:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Include the stream identifier session name to be exported.
    type: str

observationdomainname:
    description:
    - Name of the Observation Domain defined by the observation domain ID.
    type: str

securityinsighttraffic:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable/disable the feature individually on appflow action.
    type: str

disttracingsamplingrate:
    description:
    - Sampling rate for Distributed Tracing
    type: float

subscriberidobfuscation:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable this option for obfuscating MSISDN in L4/L7 appflow records
    type: str

tcpattackcounterinterval:
    description:
    - Interval, in seconds, at which to send tcp attack counters to the configured collectors.
      If 0 is configured, the record is not sent.
    type: float

websaasappusagereporting:
    choices:
    - ENABLED
    - DISABLED
    description:
    - On enabling this option, NGS will send data used by Web/saas app at the end of every
      HTTP transaction to configured collectors.
    type: str

subscriberidobfuscationalgo:
    choices:
    - MD5
    - SHA256
    description:
    - Algorithm(C(MD5) or C(SHA256)) to be used for obfuscating MSISDN
    type: str

securityinsightrecordinterval:
    description:
    - Interval, in seconds, at which to send security insight flow records to the configured
      collectors.
    type: float

skipcacheredirectionhttptransaction:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Skip Cache http transaction. This HTTP transaction is specific to Cache Redirection
      module. In Case of Cache Miss there will be another HTTP transaction initiated by
      the cache server.
    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