wti.remote.cpm_snmp_config – Set network IPTables parameters in WTI OOB and PDU devices

Note

This plugin is part of the wti.remote collection (version 1.0.1).

To install it use: ansible-galaxy collection install wti.remote.

To use it in a playbook, specify: wti.remote.cpm_snmp_config.

New in version 2.10: of wti.remote

Synopsis

• Set network IPTables parameters in WTI OOB and PDU devices

Parameters

Parameter	Choices/Defaults	Comments
authpass list / elements=string		Sets the Authentication Password for SNMPv3 (V3 only).
authpriv list / elements=string		Configures the Authentication and Privacy features for SNMPv3 communication, 0 = Auth/NoPriv, 1 = Auth/Priv (V3 only).
authproto list / elements=string		Which authentication protocol will be used, 0 = MD5, 1 = SHA1 (V3 only).
clear integer	Choices: 0 1	Removes all the users for the protocol being defined before setting the newly defined entries.
contact string		The name of the administrator responsible for SNMP issues.
cpm_password string / required		This is the Password of the WTI device to send the module.
cpm_url string / required		This is the URL of the WTI device to send the module.
cpm_username string / required		This is the Username of the WTI device to send the module.
enable integer	Choices: 0 1	The activates SNMP polling for the specified interface and protocol.
index list / elements=string		Index of the user being modified (V3 only).
interface string	Choices: eth0 eth1 ppp0	The ethernet port for the SNMP we are defining.
location string		The location of the SNMP Server.
privpass list / elements=string		Sets the Privacy Password for SNMPv3 (V3 only) (V3 only).
privproto list / elements=string		Which privacy protocol will be used, 0 = DES, 1 = AES128 (V3 only).
protocol integer	Choices: 0 1	The protocol that the SNMP entry should be applied. 0 = ipv4, 1 = ipv6.
readonly integer	Choices: 0 1	Controls the ability to change configuration parameters with SNMP.
rocommunity string		Read Only Community Password, not used for SNMP V3.
rwcommunity string		Read/Write Community Password, not used for SNMP V3.
systemname string		The hostname of the WTI Device.
use_https boolean	Choices: no yes ←	Designates to use an https connection or http connection.
use_proxy boolean	Choices: no ← yes	Flag to control if the lookup will observe HTTP proxy environment variables when present.
username list / elements=string		Sets the User Name for SNMPv3 access (V3 only).
validate_certs boolean	Choices: no yes ←	If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
version integer	Choices: 0 1 2	Defined which version of SNMP the device will respond to 0 = V1/V2 Only, 1 = V3 Only, 2 = V1/V2/V3.

Notes

Note

• Use groups/cpm in module_defaults to set common options used between CPM modules.

Examples

# Sets the device SNMP Parameters
- name: Set the an SNMP Parameter for a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    interface: "eth0"
    use_https: true
    validate_certs: false
    protocol: 0
    clear: 1
    enable: 1
    readonly: 0
    version: 0
    rocommunity: "ropassword"
    rwcommunity: "rwpassword"

# Sets the device SNMP Parameters
- name: Set the SNMP Parameters a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    version: 1
    index:
      - 1
      - 2
    username:
      - "username1"
      - "username2"
    authpriv:
      - 1
      - 1
    authpass:
      - "authpass1"
      - "uthpass2"
    authproto:
      - 1
      - 1
    privpass:
      - "authpass1"
      - "uthpass2"
    privproto:
      - 1
      - 1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
data complex		always	The output JSON returned from the commands sent
	snmpaccess dictionary	always	Current k/v pairs of interface info for the WTI device after module execution. Sample: [{'eth0': {'ietf-ipv4': {'clear': 1, 'enable': 0, 'readonly': 0, 'users': [{'authpass': 'testpass', 'authpriv': '1', 'authproto': '0', 'index': '1', 'privpass': 'privpass1', 'privproto': '0', 'username': 'username1'}], 'version': 0}}}]

Authors

• Western Telematic Inc. (@wtinetworkgear)