community.windows.win_snmp (2.2.0) — module

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

This module configures the Windows SNMP service.

Usage examples

Scanned by Steampunk Spotter

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

- name: Replace SNMP communities and managers
  community.windows.win_snmp:
    community_strings:
    - public
    permitted_managers:
    - 192.168.1.2
    action: set

Scanned by Steampunk Spotter

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

- name: Replace SNMP communities and clear managers
  community.windows.win_snmp:
    community_strings:
    - public
    permitted_managers: []
    action: set

Inputs

    
action:
    choices:
    - add
    - set
    - remove
    default: set
    description:
    - C(add) will add new SNMP community strings and/or SNMP managers
    - C(set) will replace SNMP community strings and/or SNMP managers. An empty list for
      either C(community_strings) or C(permitted_managers) will result in the respective
      lists being removed entirely.
    - C(remove) will remove SNMP community strings and/or SNMP managers
    type: str

community_strings:
    description:
    - The list of read-only SNMP community strings.
    elements: str
    type: list

permitted_managers:
    description:
    - The list of permitted SNMP managers.
    elements: str
    type: list

Outputs

community_strings:
  description: The list of community strings for this machine.
  returned: always
  sample:
  - public
  - snmp-ro
  type: list
permitted_managers:
  description: The list of permitted managers for this machine.
  returned: always
  sample:
  - 192.168.1.1
  - 192.168.1.2
  type: list