netscaler.adc.snmpoption (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 SNMP option 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

snmpset:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Accept SNMP SET requests sent to the Citrix ADC, and allow SNMP managers to write
      values to MIB objects that are configured for write access.
    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

snmptraplogging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Log any SNMP trap events (for SNMP alarms in which logging is enabled) even if no
      trap listeners are configured. With the default setting, SNMP trap events are logged
      if at least one trap listener is configured on the appliance.
    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

severityinfointrap:
    choices:
    - ENABLED
    - DISABLED
    description:
    - By default, the severity level info of the trap is not mentioned in the trap message.
      Enable this option to send severity level of trap as one of the varbind in the trap
      message.
    type: str

partitionnameintrap:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Send partition name as a varbind in traps. By default the partition names are not
      sent as a varbind.
    type: str

snmptraplogginglevel:
    choices:
    - EMERGENCY
    - ALERT
    - CRITICAL
    - ERROR
    - WARNING
    - NOTICE
    - INFORMATIONAL
    - DEBUG
    description:
    - Audit log level of SNMP trap logs. The default value is C(INFORMATIONAL).
    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