wti.remote.cpm_snmp_info – Get network SNMP parameters from WTI OOB and PDU devices

From Get docs
Ansible/docs/2.10/collections/wti/remote/cpm snmp info module


wti.remote.cpm_snmp_info – Get network SNMP parameters from 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_info.


New in version 2.10: of wti.remote


Synopsis

  • Get network SNMP parameters from WTI OOB and PDU devices

Parameters

Parameter Choices/Defaults Comments

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.

interface

string

  • eth0
  • eth1
  • ppp0

This is the ethernet port name that is getting retrieved. It can include a single ethernet

port name, multiple ethernet port names separated by commas or not defined for all ports.

use_https

boolean

  • no
  • yes

Designates to use an https connection or http connection.

use_proxy

boolean

  • no

  • yes

Flag to control if the lookup will observe HTTP proxy environment variables when present.

validate_certs

boolean

  • no
  • yes

If false, SSL certificates will not be validated. This should only be used

on personally controlled sites using self-signed certificates.



Notes

Note

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


Examples

- name: Get the network SNMP Parameters for all interfaces of a WTI device.
  cpm_interface_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false


- name: Get the network SNMP Parameters for eth0 of a WTI device.
  cpm_interface_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: false
    validate_certs: false
    interface: "eth0"

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 SNMP info for the WTI device after module execution.


Sample:

{'snmpaccess': [{'eth0': {'ietf-ipv4': [{'enable': 0, 'users': [{'authpass': 'testpass', 'authpriv': '1', 'authproto': '0', 'index': '1', 'privpass': 'testpass', 'privproto': '1', 'username': 'test10'}]}], 'ietf-ipv6': [{'enable': 0, 'users': [{'authpass': 'testpass', 'authpriv': '1', 'authproto': '0', 'index': '1', 'privpass': 'testpass', 'privproto': '1', 'username': 'test10'}]}]}}]}




Authors

  • Western Telematic Inc. (@wtinetworkgear)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/wti/remote/cpm_snmp_info_module.html