netscaler.adc.icalatencyprofile (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 Profile for Latency monitoring resource.

Inputs

    
name:
    description:
    - Name for the ICA latencyprofile. Must begin with a letter, number, or the underscore
      character (_), and must contain only letters, numbers, and
    - the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:),
      and underscore characters. Cannot be changed after the ICA latency profile is added.
    - ''
    - '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 ica l7latencyprofile" or 'my ica l7latencyprofile').
    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
    - 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

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

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

l7latencywaittime:
    description:
    - L7 Latency Wait time. This is the time for which the Citrix ADC waits after the
      threshold is exceeded before it sends out a Notification to the Insight Center.
    type: float

l7latencymonitoring:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable/Disable L7 Latency monitoring for L7 latency notifications
    type: str

l7latencymaxnotifycount:
    description:
    - L7 Latency Max notify Count. This is the upper limit on the number of notifications
      sent to the Insight Center within an interval where the Latency is above the threshold.
    type: float

l7latencynotifyinterval:
    description:
    - L7 Latency Notify Interval. This is the interval at which the Citrix ADC sends out
      notifications to the Insight Center after the wait time has passed.
    type: float

l7latencythresholdfactor:
    description:
    - L7 Latency threshold factor. This is the factor by which the active latency should
      be greater than the minimum observed value to determine that the latency is high
      and may need to be reported
    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