netscaler.adc.snmpuser (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 user 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 | snmpuser
      delegate_to: localhost
      netscaler.adc.snmpuser:
        state: present
        name: v3
        group: v3_grp

Inputs

    
name:
    description:
    - Name for the SNMPv3 user. Can consist of 1 to 31 characters that include uppercase
      and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space
      ( ), at sign (@), equals (=), colon (:), and underscore (_) characters.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose it in double or single quotation
      marks (for example, "my user" or 'my user').
    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

group:
    description:
    - Name of the configured SNMPv3 group to which to bind this SNMPv3 user. The access
      rights (bound SNMPv3 views) and security level set for this group are assigned to
      this user.
    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

authtype:
    choices:
    - MD5
    - SHA
    description:
    - Authentication algorithm used by the Citrix ADC and the SNMPv3 user for authenticating
      the communication between them. You must specify the same authentication algorithm
      when you configure the SNMPv3 user in the SNMP manager.
    type: str

privtype:
    choices:
    - DES
    - AES
    description:
    - Encryption algorithm used by the Citrix ADC and the SNMPv3 user for encrypting the
      communication between them. You must specify the same encryption algorithm when
      you configure the SNMPv3 user in the SNMP manager.
    type: str

authpasswd:
    description:
    - Plain-text pass phrase to be used by the authentication algorithm specified by the
      authType (Authentication Type) parameter. Can consist of 1 to 31 characters that
      include uppercase and lowercase letters, numbers, and the hyphen (-), period (.)
      pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the pass phrase includes one or more spaces, enclose it in double or single quotation
      marks (for example, "my phrase" or 'my phrase').
    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

privpasswd:
    description:
    - Encryption key to be used by the encryption algorithm specified by the privType
      (Encryption Type) parameter. Can consist of 1 to 31 characters that include uppercase
      and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space
      ( ), at sign (@), equals (=), colon (:), and underscore (_) characters.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the key includes one or more spaces, enclose it in double or single quotation
      marks (for example, "my key" or 'my key').
    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

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