New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
address | Network Address. | |
connect_port | Udp port used by SNMP agent to connect the Network management. | |
host_name | Unique name to identify target host entry. | |
interface_name | Name of the interface to send the trap message. | |
is_public_net |
| To enable or disable Public Net-manager for target Host. |
notify_type |
| To configure notify type as trap or inform. |
recv_port | UDP Port number used by network management to receive alarm messages. | |
security_level |
| Security level indicating whether to use authentication and encryption. |
security_model |
| Security Model. |
security_name | Security Name. | |
security_name_v3 | Security Name V3. | |
version |
| Version(s) Supported by SNMP Engine. |
vpn_name | VPN instance Name. |
- name: CloudEngine snmp target host test hosts: cloudengine connection: local gather_facts: no vars: cli: host: "{{ inventory_hostname }}" port: "{{ ansible_ssh_port }}" username: "{{ username }}" password: "{{ password }}" transport: cli tasks: - name: "Config SNMP version" ce_snmp_target_host: state: present version: v2cv3 provider: "{{ cli }}" - name: "Config SNMP target host" ce_snmp_target_host: state: present host_name: test1 address: 1.1.1.1 notify_type: trap vpn_name: js security_model: v2c security_name: wdz provider: "{{ cli }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean | always | check to see if a change was made on the device Sample: True |
end_state dict | always | k/v pairs of aaa params after module execution Sample: {'target host info': [{'securityLevel': 'authentication', 'domain': 'snmpUDPDomain', 'address': '10.135.182.158', 'notifyType': 'trap', 'nmsName': 'test2', 'vpnInstanceName': 'js', 'securityNameV3': 'wdz', 'securityModel': 'v3'}]} |
existing dict | always | k/v pairs of existing aaa server |
proposed dict | always | k/v pairs of parameters passed into module Sample: {'security_name_v3': 'wdz', 'security_model': 'v3', 'vpn_name': 'js', 'security_level': 'authentication', 'state': 'present', 'host_name': 'test2', 'address': '10.135.182.158', 'notify_type': 'trap'} |
updates list | always | command sent to the device Sample: ['snmp-agent target-host host-name test2 trap address udp-domain 10.135.182.158 vpn-instance js params securityname wdz v3 authentication'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ce_snmp_target_host_module.html