wti.remote.cpm_interface_info – Get network interface 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_interface_info.

New in version 2.10: of wti.remote

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Get network interface 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 list / elements=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 interface Parameters for a WTI device for all interfaces
  cpm_interface_info:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false

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

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
	interface dictionary	always	Current k/v pairs of interface info for the WTI device after module execution. Sample: {'ietf-ipv4': {'address': [{'gateway': , 'ip': '10.10.10.2', 'netmask': '255.255.255.0'}], 'dhcpclient': [{'enable': 0, 'hostname': , 'lease': -1, 'obdns': 1, 'updns': 1}]}, 'ietf-ipv6': {'address': [{'gateway': , 'ip': , 'netmask': }]}, 'is_gig': '1', 'is_up': '0', 'mac_address': '00-09-9b-02-45-db', 'name': 'eth1', 'negotiation': '0', 'speed': '10', 'type': '0'}
	totalports integer	success	Total ethernet ports requested of the WTI device. Sample: 1

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_interface_info_module.html