summaryrefslogtreecommitdiffstats
path: root/ansible_collections/wti/remote/docs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
commit66cec45960ce1d9c794e9399de15c138acb18aed (patch)
tree59cd19d69e9d56b7989b080da7c20ef1a3fe2a5a /ansible_collections/wti/remote/docs
parentInitial commit. (diff)
downloadansible-upstream.tar.xz
ansible-upstream.zip
Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/wti/remote/docs')
-rw-r--r--ansible_collections/wti/remote/docs/cpm_alarm_info.rst123
-rw-r--r--ansible_collections/wti/remote/docs/cpm_config_backup.rst115
-rw-r--r--ansible_collections/wti/remote/docs/cpm_config_restore.rst125
-rw-r--r--ansible_collections/wti/remote/docs/cpm_current_info.rst165
-rw-r--r--ansible_collections/wti/remote/docs/cpm_firmware_info.rst131
-rw-r--r--ansible_collections/wti/remote/docs/cpm_firmware_update.rst145
-rw-r--r--ansible_collections/wti/remote/docs/cpm_hostname_config.rst149
-rw-r--r--ansible_collections/wti/remote/docs/cpm_hostname_info.rst131
-rw-r--r--ansible_collections/wti/remote/docs/cpm_interface_config.rst196
-rw-r--r--ansible_collections/wti/remote/docs/cpm_interface_info.rst136
-rw-r--r--ansible_collections/wti/remote/docs/cpm_iptables_config.rst144
-rw-r--r--ansible_collections/wti/remote/docs/cpm_iptables_info.rst119
-rw-r--r--ansible_collections/wti/remote/docs/cpm_plugconfig.rst161
-rw-r--r--ansible_collections/wti/remote/docs/cpm_plugcontrol.rst142
-rw-r--r--ansible_collections/wti/remote/docs/cpm_power_info.rst165
-rw-r--r--ansible_collections/wti/remote/docs/cpm_serial_port_action_info.rst136
-rw-r--r--ansible_collections/wti/remote/docs/cpm_serial_port_action_set.rst135
-rw-r--r--ansible_collections/wti/remote/docs/cpm_serial_port_config.rst188
-rw-r--r--ansible_collections/wti/remote/docs/cpm_serial_port_info.rst136
-rw-r--r--ansible_collections/wti/remote/docs/cpm_snmp_config.rst223
-rw-r--r--ansible_collections/wti/remote/docs/cpm_snmp_info.rst127
-rw-r--r--ansible_collections/wti/remote/docs/cpm_status_info.rst227
-rw-r--r--ansible_collections/wti/remote/docs/cpm_syslog_client_config.rst176
-rw-r--r--ansible_collections/wti/remote/docs/cpm_syslog_client_info.rst127
-rw-r--r--ansible_collections/wti/remote/docs/cpm_syslog_server_config.rst175
-rw-r--r--ansible_collections/wti/remote/docs/cpm_syslog_server_info.rst127
-rw-r--r--ansible_collections/wti/remote/docs/cpm_temp_info.rst131
-rw-r--r--ansible_collections/wti/remote/docs/cpm_time_config.rst168
-rw-r--r--ansible_collections/wti/remote/docs/cpm_time_info.rst131
-rw-r--r--ansible_collections/wti/remote/docs/cpm_user.rst221
30 files changed, 4575 insertions, 0 deletions
diff --git a/ansible_collections/wti/remote/docs/cpm_alarm_info.rst b/ansible_collections/wti/remote/docs/cpm_alarm_info.rst
new file mode 100644
index 00000000..abed76b7
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_alarm_info.rst
@@ -0,0 +1,123 @@
+.. _cpm_alarm_info_module:
+
+
+cpm_alarm_info -- Get alarm information from WTI OOB and PDU devices
+====================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get temperature alarm from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Alarm Information for a WTI device
+ cpm_alarm_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Alarm Information for a WTI device
+ cpm_alarm_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ alarms (success, dict, [{'name': 'OVER CURRENT (INITIAL)', 'status': '0'}, {'name': 'OVER CURRENT (CRITICAL)', 'status': '0'}, {'name': 'OVER TEMPERATURE (INITIAL)', 'status': '0'}])
+ Current alarm status of the WTI device after module execution.
+
+
+ status (always, dict, {'code': '0', 'text': 'OK'})
+ Return status after module completion
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_config_backup.rst b/ansible_collections/wti/remote/docs/cpm_config_backup.rst
new file mode 100644
index 00000000..e8b87703
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_config_backup.rst
@@ -0,0 +1,115 @@
+.. _cpm_config_backup_module:
+
+
+cpm_config_backup -- Get parameters from WTI OOB and PDU devices
+================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to get the parameters from.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to get the parameters from.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to get the parameters from.
+
+
+ cpm_path (False, str, /tmp/)
+ This is the directory path to store the WTI device configuration file.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Parameters for a WTI device
+ cpm_config_backup:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The XML configuration of the WTI device queried
+
+
+ status (success, list, [{'code': 0, 'savedfilename': '/tmp/wti-192-10-10-239-2020-02-13T16-05-57.xml', 'text': 'ok'}])
+ List of status returns from backup operation
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_config_restore.rst b/ansible_collections/wti/remote/docs/cpm_config_restore.rst
new file mode 100644
index 00000000..5ce45b46
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_config_restore.rst
@@ -0,0 +1,125 @@
+.. _cpm_config_restore_module:
+
+
+cpm_config_restore -- Send operational parameters to WTI OOB and PDU devices
+============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Send operational parameters to WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to get the parameters from.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to get the parameters from.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to get the parameters from.
+
+
+ cpm_path (False, str, /tmp/)
+ This is the directory path to the existing the WTI device configuration file.
+
+
+ cpm_filename (True, str, None)
+ This is the filename of the existing WTI device configuration file.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Parameters for a WTI device
+ cpm_config_restore:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ cpm_path: "/tmp/"
+ cpm_filename: "wti-192-10-10-239-2020-02-13T16-05-57-xml"
+ use_https: true
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output XML configuration of the WTI device queried
+
+
+ filelength (success, int, [{'filelength': 329439}])
+ Length of the file uploaded in bytes
+
+
+ status (success, list, [{'code': 0, 'text': 'ok', 'unittimestamp': '2020-02-14T00:18:57+00:00'}])
+ List of status returns from backup operation
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_current_info.rst b/ansible_collections/wti/remote/docs/cpm_current_info.rst
new file mode 100644
index 00000000..a7b77977
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_current_info.rst
@@ -0,0 +1,165 @@
+.. _cpm_current_info_module:
+
+
+cpm_current_info -- Get the Current Information of a WTI device
+===============================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get the Current Information of a WTI device
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ cpm_startdate (False, str, None)
+ Start date of the range to look for current data
+
+
+ cpm_enddate (False, str, None)
+ End date of the range to look for current data
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Current Information of a WTI device
+ cpm_current_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Current Information of a WTI device
+ cpm_current_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+ startdate: 01-12-2020"
+ enddate: 02-16-2020"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ timestamp (success, str, 2020-02-24T20:54:03+00:00)
+ Current timestamp of the WTI device after module execution.
+
+
+ powerunit (success, str, 1)
+ Identifies if the WTI device is a power type device.
+
+
+ outletmetering (success, str, 1)
+ Identifies if the WTI device has Poiwer Outlet metering.
+
+
+ ats (success, str, 1)
+ Identifies if the WTI device is an ATS type of power device.
+
+
+ plugcount (success, str, 8)
+ Current outlet plug count of the WTI device after module execution.
+
+
+ powerfactor (success, str, 100)
+ Power factor of the WTI device after module execution.
+
+
+ powereff (success, str, 100)
+ Power efficiency of the WTI device after module execution.
+
+
+ powerdatacount (success, str, 1)
+ Total powerdata samples returned after module execution.
+
+
+ powerdata (success, dict, [{'timestamp': '2020-02-24T23:29:31+00:00', 'temperature': '90', 'format': 'F', 'branch1': [{'voltage1': '118.00', 'current1': '0.00'}]}])
+ Power data of the WTI device after module execution.
+
+
+ status (always, dict, {'code': '0', 'text': 'OK'})
+ Return status after module completion
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_firmware_info.rst b/ansible_collections/wti/remote/docs/cpm_firmware_info.rst
new file mode 100644
index 00000000..0ee38b33
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_firmware_info.rst
@@ -0,0 +1,131 @@
+.. _cpm_firmware_info_module:
+
+
+cpm_firmware_info -- Get firmware information from WTI OOB and PDU devices
+==========================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get firmware information from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Firmware Information for a WTI device
+ cpm_firmware_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Firmware Information for a WTI device
+ cpm_firmware_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ firmware (success, str, 6.60)
+ Current Firmware version of the WTI device.
+
+
+ family (success, str, 1)
+ Current family type (Console = 1 or Power = 0) of the WTI device.
+
+
+ fips (success, str, 2020-02-24T20:54:03+00:00)
+ If WTI device is a no FIPS only device.
+
+
+ status (always, dict, {'code': '0', 'text': 'OK'})
+ Return status after module completion
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_firmware_update.rst b/ansible_collections/wti/remote/docs/cpm_firmware_update.rst
new file mode 100644
index 00000000..37a25013
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_firmware_update.rst
@@ -0,0 +1,145 @@
+.. _cpm_firmware_update_module:
+
+
+cpm_firmware_update -- Set Serial port parameters in WTI OOB and PDU devices
+============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set Serial port parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ cpm_path (False, str, /tmp/)
+ This is the directory path to store the WTI device configuration file.
+
+
+ cpm_file (False, str, None)
+ If a file is defined, this file will be used to update the WTI device.
+
+
+ use_force (False, bool, False)
+ If set to True, the upgrade will happen even if the device doesnt need it.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used - on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ family (False, int, 1)
+ Force the download to both either Console (1) or Power (0)
+
+
+ removefileonexit (False, int, 1)
+ After an upgrade, remove the upgrade OS image
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Upgrade the firmware of a WTI device
+ - name: Upgrade the firmware of a WTI device
+ cpm_firmware_update:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+
+ # Upgrade the firmware of a WTI device and keep the download OS image after exit
+ - name: Upgrade the firmware of a WTI device and keep the download OS image after exit
+ cpm_firmware_update:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ removefileonexit: "0"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output XML configuration of the WTI device being updated
+
+
+ filelength (success, int, [{'filelength': 329439}])
+ Length of the file uploaded in bytes
+
+
+ status (success, list, [{'code': 0}, {'text': 'ok'}, {'unittimestamp': '2020-02-14T00:18:57+00:00'}])
+ List of status returns from backup operation
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_hostname_config.rst b/ansible_collections/wti/remote/docs/cpm_hostname_config.rst
new file mode 100644
index 00000000..58cee626
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_hostname_config.rst
@@ -0,0 +1,149 @@
+.. _cpm_hostname_config_module:
+
+
+cpm_hostname_config -- Set Hostname (Site ID), Location, Asset Tag parameters in WTI OOB and PDU devices.
+=========================================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set Hostname (Site ID), Location, Asset Tag parameters parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ hostname (False, str, None)
+ This is the Hostname (Site-ID) tag to be set for the WTI OOB and PDU device.
+
+
+ location (False, str, None)
+ This is the Location tag to be set for the WTI OOB and PDU device.
+
+
+ assettag (False, str, None)
+ This is the Asset Tag to be set for the WTI OOB and PDU device.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Set Hostname, Location and Site-ID variables of a WTI device
+ - name: Set known fixed hostname variables of a WTI device
+ cpm_time_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ hostname: "myhostname"
+ location: "Irvine"
+ assettag: "irvine92395"
+
+ # Set the Hostname variable of a WTI device
+ - name: Set the Hostname of a WTI device
+ cpm_time_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ hostname: "myhostname"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ timestamp (success, str, 2021-08-17T21:33:50+00:00)
+ Current timestamp of the WTI device after module execution.
+
+
+ hostname (success, str, myhostname)
+ Current Hostname (Site-ID) of the WTI device after module execution.
+
+
+ location (success, int, Irvine)
+ Current Location of the WTI device after module execution.
+
+
+ assettag (success, int, irvine92395)
+ Current Asset Tag of the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_hostname_info.rst b/ansible_collections/wti/remote/docs/cpm_hostname_info.rst
new file mode 100644
index 00000000..15b5ff75
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_hostname_info.rst
@@ -0,0 +1,131 @@
+.. _cpm_hostname_info_module:
+
+
+cpm_hostname_info -- Get Hostname (Site ID), Location, Asset Tag parameters in WTI OOB and PDU devices
+======================================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get Hostname (Site ID), Location, Asset Tag parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Hostname parameters for a WTI device
+ cpm_hostname_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Hostname parameters for a WTI device
+ cpm_hostname_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ timestamp (success, str, 2021-08-17T21:33:50+00:00)
+ Current timestamp of the WTI device after module execution.
+
+
+ hostname (success, str, myhostname)
+ Current Hostname (Site-ID) of the WTI device after module execution.
+
+
+ location (success, int, Irvine)
+ Current Location of the WTI device after module execution.
+
+
+ assettag (success, int, irvine92395)
+ Current Asset Tag of the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_interface_config.rst b/ansible_collections/wti/remote/docs/cpm_interface_config.rst
new file mode 100644
index 00000000..68c211d8
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_interface_config.rst
@@ -0,0 +1,196 @@
+.. _cpm_interface_config_module:
+
+
+cpm_interface_config -- Set network interface parameters in WTI OOB and PDU devices
+===================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set network interface parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ interface (False, str, None)
+ This is the ethernet port name that is getting configured.
+
+
+ negotiation (False, int, None)
+ This is the speed of the interface port being configured.
+
+ 0=Auto, 1=10/half, 2=10/full, 3=100/half, 4=100/full, 5=1000/half, 6=1000/full
+
+
+ ipv4address (False, str, None)
+ IPv4 format IP address for the defined interface Port.
+
+
+ ipv4netmask (False, str, None)
+ IPv4 format Netmask for the defined interface Port.
+
+
+ ipv4gateway (False, str, None)
+ IPv4 format Gateway address for the defined interface Port.
+
+
+ ipv4dhcpenable (False, int, None)
+ Enable IPv4 DHCP request call to obtain confufuration information.
+
+
+ ipv4dhcphostname (False, str, None)
+ Define IPv4 DHCP Hostname.
+
+
+ ipv4dhcplease (False, int, None)
+ IPv4 DHCP Lease Time.
+
+
+ ipv4dhcpobdns (False, int, None)
+ IPv6 DHCP Obtain DNS addresses auto.
+
+
+ ipv4dhcpupdns (False, int, None)
+ IPv4 DHCP DNS Server Update.
+
+
+ ipv4dhcpdefgateway (False, int, None)
+ Enable or Disable this ports configuration as the default IPv4 route for the device.
+
+
+ ipv6address (False, str, None)
+ IPv6 format IP address for the defined interface Port.
+
+
+ ipv6subnetprefix (False, str, None)
+ IPv6 format Subnet Prefix for the defined interface Port.
+
+
+ ipv6gateway (False, str, None)
+ IPv6 format Gateway address for the defined interface Port.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Set Network Interface Parameters
+ - name: Set the Interface Parameters for port eth1 of a WTI device
+ cpm_interface_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ interface: "eth1"
+ ipv4address: "192.168.0.14"
+ ipv4netmask: "255.255.255.0"
+ ipv4gateway: "192.168.0.1"
+ negotiation: 0
+
+ # Set Network Interface Parameters
+ - name: Set the Interface Parameters for port eth1 to DHCP of a WTI device
+ cpm_interface_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ interface: "eth1"
+ negotiation: 0
+ ipv4dhcpenable: 1
+ ipv4dhcphostname: ""
+ ipv4dhcplease: -1
+ ipv4dhcpobdns: 0
+ ipv4dhcpupdns: 0
+ ipv4dhcpdefgateway: 0
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ totalports (success, int, 1)
+ Total interface ports requested of the WTI device.
+
+
+ interface (always, dict, {'name': 'eth1', 'type': '0', 'mac_address': '00-09-9b-02-45-db', 'is_up': '0', 'is_gig': '1', 'speed': '10', 'negotiation': '0', 'ietf-ipv4': {'address': [{'ip': '10.10.10.2', 'netmask': '255.255.255.0', 'gateway': ''}], 'dhcpclient': [{'enable': 0, 'hostname': '', 'lease': -1, 'obdns': 1, 'updns': 1}]}, 'ietf-ipv6': {'address': [{'ip': '', 'netmask': '', 'gateway': ''}]}})
+ Current k/v pairs of interface info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_interface_info.rst b/ansible_collections/wti/remote/docs/cpm_interface_info.rst
new file mode 100644
index 00000000..89853ab5
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_interface_info.rst
@@ -0,0 +1,136 @@
+.. _cpm_interface_info_module:
+
+
+cpm_interface_info -- Get network interface parameters from WTI OOB and PDU devices
+===================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get network interface parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ face (False, list, None)
+ 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.
+
+
+ interface (False, list, None)
+ 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.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - 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
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ totalports (success, int, 1)
+ Total ethernet ports requested of the WTI device.
+
+
+ interface (always, dict, {'name': 'eth1', 'type': '0', 'mac_address': '00-09-9b-02-45-db', 'is_up': '0', 'is_gig': '1', 'speed': '10', 'negotiation': '0', 'ietf-ipv4': {'address': [{'ip': '10.10.10.2', 'netmask': '255.255.255.0', 'gateway': ''}], 'dhcpclient': [{'enable': 0, 'hostname': '', 'lease': -1, 'obdns': 1, 'updns': 1}]}, 'ietf-ipv6': {'address': [{'ip': '', 'netmask': '', 'gateway': ''}]}})
+ Current k/v pairs of interface info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_iptables_config.rst b/ansible_collections/wti/remote/docs/cpm_iptables_config.rst
new file mode 100644
index 00000000..44cc50d4
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_iptables_config.rst
@@ -0,0 +1,144 @@
+.. _cpm_iptables_config_module:
+
+
+cpm_iptables_config -- Set network IPTables parameters in WTI OOB and PDU devices
+=================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set network IPTables parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ protocol (False, int, None)
+ The protocol that the iptables entry should be applied. 0 = ipv4, 1 = ipv6.
+
+
+ index (False, list, None)
+ Index in which command should be inserted. If not defined entry will start at position one.
+
+
+ command (True, list, None)
+ Actual iptables command to send to the WTI device.
+
+
+ clear (False, int, None)
+ Removes all the iptables for the protocol being defined before setting the newly defined entry.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Set Network IPTables Parameters
+ - name: Set the an IPTables Parameter for a WTI device
+ cpm_iptables_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ command: "iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 443 -j ACCEPT"
+
+ # Sets multiple Network IPTables Parameters
+ - name: Set the IPTables Parameters a WTI device
+ cpm_iptables_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ index:
+ - 1
+ - 2
+ command:
+ - "iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 443 -j ACCEPT"
+ - "iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 22 -j ACCEPT"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ iptables (always, dict, [{'eth0': {'ietf-ipv4': {'clear': 1, 'entries': [{'entry': 'iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 443 -j ACCEPT', 'index': '1'}, {'entry': 'iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 22 -j ACCEPT', 'index': '2'}]}}}])
+ Current k/v pairs of interface info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_iptables_info.rst b/ansible_collections/wti/remote/docs/cpm_iptables_info.rst
new file mode 100644
index 00000000..0e930807
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_iptables_info.rst
@@ -0,0 +1,119 @@
+.. _cpm_iptables_info_module:
+
+
+cpm_iptables_info -- Get network IPTABLES parameters from WTI OOB and PDU devices
+=================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get network IPTABLES parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the network IPTABLES Parameters for 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 IPTABLES Parameters for a WTI device.
+ cpm_interface_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ iptables (always, dict, {'iptables': [{'eth0': {'ietf-ipv4': [{'clear': 0, 'entries': [{'entry': 'test10', 'index': '1'}, {'entry': '', 'index': '2'}]}], 'ietf-ipv6': [{'clear': 0, 'entries': [{'entry': 'test30', 'index': '1'}, {'entry': 'test40', 'index': '2'}]}]}}]})
+ Current k/v pairs of IPTABLES info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_plugconfig.rst b/ansible_collections/wti/remote/docs/cpm_plugconfig.rst
new file mode 100644
index 00000000..09d1a497
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_plugconfig.rst
@@ -0,0 +1,161 @@
+.. _cpm_plugconfig_module:
+
+
+cpm_plugconfig -- Get and Set Plug Parameters on WTI OOB and PDU power devices
+==============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get and Set Plug Parameters on WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_action (True, str, None)
+ This is the Action to send the module.
+
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ plug_id (True, str, None)
+ This is the plug number that is to be manipulated
+
+ For the getplugconfig command, the plug_id 'all' will return the status of all the plugs the
+
+ user has rights to access.
+
+
+ plug_name (False, str, None)
+ The new name of the Plug.
+
+
+ plug_bootdelay (False, int, None)
+ On a reboot command, this is the time when a plug will turn on power, after it has been turned off.
+
+ 0='0.5 Secs', 1='1 Sec', 2='2 Sec', 3='5 Sec', 4='15 Sec', 5='30 Sec', 6='1 Min', 7='2 Mins', - 8='3 Mins', 9='5 Mins'.
+
+
+ plug_default (False, int, None)
+ What the Plugs default state is when the device starts. 0 - Off, 1 - On.
+
+
+ plug_bootpriority (False, int, None)
+ Prioritizes which plug gets its state changed first. The lower the number the higher the priority.
+
+ Valid value can from 1 to the maximum number of plugs of the WTI unit.
+
+
+
+
+
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Get Plug parameters for all ports
+ - name: Get the Plug parameters for ALL ports of a WTI Power device
+ cpm_plugconfig:
+ cpm_action: "getplugconfig"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restpower"
+ cpm_password: "restfulpowerpass12"
+ use_https: true
+ validate_certs: true
+ plug_id: "all"
+
+ # Get Plug parameters for port 2
+ - name: Get the Plug parameters for the given port of a WTI Power device
+ cpm_plugconfig:
+ cpm_action: "getplugconfig"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restpower"
+ cpm_password: "restfulpowerpass12"
+ use_https: true
+ validate_certs: false
+ plug_id: "2"
+
+ # Configure plug 5
+ - name: Configure parameters for Plug 5 on a given WTI Power device
+ cpm_plugconfig:
+ cpm_action: "setplugconfig"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restpower"
+ cpm_password: "restfulpowerpass12"
+ use_https: true
+ plug_id: "5"
+ plug_name: "NewPlugNameFive"
+ plug_bootdelay: "3"
+ plug_default: "0"
+ plug_bootpriority: "1"
+
+
+
+Return Values
+-------------
+
+data (always, str, )
+ The output JSON returned from the commands sent
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_plugcontrol.rst b/ansible_collections/wti/remote/docs/cpm_plugcontrol.rst
new file mode 100644
index 00000000..76d9f59f
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_plugcontrol.rst
@@ -0,0 +1,142 @@
+.. _cpm_plugcontrol_module:
+
+
+cpm_plugcontrol -- Get and Set Plug actions on WTI OOB and PDU power devices
+============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get and Set Plug actions on WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_action (True, str, None)
+ This is the Action to send the module.
+
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ plug_id (True, str, None)
+ This is the plug number or the plug name that is to be manipulated
+
+ For the plugget command, the plug_id 'all' will return the status of all the plugs the
+
+ user has rights to access.
+
+
+ plug_state (False, str, None)
+ This is what action to take on the plug.
+
+
+
+
+
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Get Plug status for all ports
+ - name: Get the Plug status for ALL ports of a WTI device
+ cpm_plugcontrol:
+ cpm_action: "getplugcontrol"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restpower"
+ cpm_password: "restfulpowerpass12"
+ use_https: true
+ validate_certs: true
+ plug_id: "all"
+
+ # Get Plug status for port 2
+ - name: Get the Plug status for the given port of a WTI device
+ cpm_plugcontrol:
+ cpm_action: "getplugcontrol"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restpower"
+ cpm_password: "restfulpowerpass12"
+ use_https: true
+ validate_certs: false
+ plug_id: "2"
+
+ # Reboot plug 5
+ - name: Reboot Plug 5 on a given WTI device
+ cpm_plugcontrol:
+ cpm_action: "setplugcontrol"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restpower"
+ cpm_password: "restfulpowerpass12"
+ use_https: true
+ plug_id: "5"
+ plug_state: "boot"
+
+
+
+Return Values
+-------------
+
+data (always, str, )
+ The output JSON returned from the commands sent
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_power_info.rst b/ansible_collections/wti/remote/docs/cpm_power_info.rst
new file mode 100644
index 00000000..455546fa
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_power_info.rst
@@ -0,0 +1,165 @@
+.. _cpm_power_info_module:
+
+
+cpm_power_info -- Get the Power Information of a WTI device
+===========================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get the Power Information of a WTI device
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ cpm_startdate (False, str, None)
+ Start date of the range to look for power data
+
+
+ cpm_enddate (False, str, None)
+ End date of the range to look for power data
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Power Information of a WTI device
+ cpm_power_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Power Information of a WTI device
+ cpm_power_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+ startdate: 01-12-2020"
+ enddate: 02-16-2020"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ timestamp (success, str, 2020-02-24T20:54:03+00:00)
+ Current timestamp of the WTI device after module execution.
+
+
+ powerunit (success, str, 1)
+ Identifies if the WTI device is a power type device.
+
+
+ outletmetering (success, str, 1)
+ Identifies if the WTI device has Poiwer Outlet metering.
+
+
+ ats (success, str, 1)
+ Identifies if the WTI device is an ATS type of power device.
+
+
+ plugcount (success, str, 8)
+ Current outlet plug count of the WTI device after module execution.
+
+
+ powerfactor (success, str, 100)
+ Power factor of the WTI device after module execution.
+
+
+ powereff (success, str, 100)
+ Power efficiency of the WTI device after module execution.
+
+
+ powerdatacount (success, str, 1)
+ Total powerdata samples returned after module execution.
+
+
+ powerdata (success, dict, [{'timestamp': '2020-02-24T21:45:18+00:00', 'branch1': [{'voltage1': '118.00', 'current1': '0.00', 'current2': '0.00', 'current3': '0.00', 'current4': '0.00', 'current5': '0.00', 'current6': '0.00', 'current7': '0.00', 'current8': '0.00'}]}])
+ Power data of the WTI device after module execution.
+
+
+ status (always, dict, {'code': '0', 'text': 'OK'})
+ Return status after module completion
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_serial_port_action_info.rst b/ansible_collections/wti/remote/docs/cpm_serial_port_action_info.rst
new file mode 100644
index 00000000..98d31dd1
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_serial_port_action_info.rst
@@ -0,0 +1,136 @@
+.. _cpm_serial_port_action_info_module:
+
+
+cpm_serial_port_action_info -- Get Serial port connection status in WTI OOB and PDU devices
+===========================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get Serial port connection status from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, False)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, False)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ port (optional, list, ['*'])
+ This is the serial port number that is getting retrieved. It can include a single port
+
+ number, multiple port numbers separated by commas, a list of port numbers, or an '*' character for all ports.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Serial Port Parameters for port 2 of a WTI device
+ cpm_serial_port_action_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: 2
+
+ - name: Get the Serial Port Parameters for ports 2 and 4 of a WTI device
+ cpm_serial_port_action_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: 2,4
+
+ - name: Get the Serial Port Parameters for all ports of a WTI device
+ cpm_serial_port_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: "*"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ ports (success, list, [{'port': 2, 'connstatus': 'Free'}, {'port': 4, 'connstatus': ' C-06'}])
+ List of connection status for each serial port
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_serial_port_action_set.rst b/ansible_collections/wti/remote/docs/cpm_serial_port_action_set.rst
new file mode 100644
index 00000000..892b2465
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_serial_port_action_set.rst
@@ -0,0 +1,135 @@
+.. _cpm_serial_port_action_set_module:
+
+
+cpm_serial_port_action_set -- Set Serial port connection/disconnection commands in WTI OOB and PDU devices
+==========================================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set Serial port connection/disconnection commands in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ port (True, int, None)
+ This is the port number that is getting the action performed on.
+
+
+ portremote (False, int, None)
+ This is the port number that is getting the action performed on.
+
+
+ action (False, int, None)
+ This is the baud rate to assign to the port.
+
+ 1=Connect, 2=Disconnect
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Set Serial Port Action (Connect)
+ - name: Connect port 2 to port 3 of a WTI device
+ cpm_serial_port_action_set:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: "2"
+ portremote: "3"
+ action: "1"
+
+ # Set Serial port Action (Disconnect)
+ - name: Disconnect port 2 and 3 of a WTI device
+ cpm_serial_port_action_set:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: "2"
+ action: "2"
+
+
+
+Return Values
+-------------
+
+data (always, str, )
+ The output JSON returned from the commands sent
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_serial_port_config.rst b/ansible_collections/wti/remote/docs/cpm_serial_port_config.rst
new file mode 100644
index 00000000..2d3ef9fe
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_serial_port_config.rst
@@ -0,0 +1,188 @@
+.. _cpm_serial_port_config_module:
+
+
+cpm_serial_port_config -- Set Serial port parameters in WTI OOB and PDU devices
+===============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set Serial port parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ port (True, int, None)
+ This is the port number that is getting the action performed on.
+
+
+ portname (False, str, None)
+ This is the Name of the Port that is displayed.
+
+
+ baud (False, int, None)
+ This is the baud rate to assign to the port.
+
+ 0=300, 1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=38400, 7=57600, 8=115200, 9=230400, 10=460800
+
+
+ handshake (False, int, None)
+ This is the handshake to assign to the port, 0=None, 1=XON/XOFF, 2=RTS/CTS, 3=Both.
+
+
+ stopbits (False, int, None)
+ This is the stop bits to assign to the port, 1=1 Stop Bit, 2=2 Stop Bit.
+
+
+ parity (False, int, None)
+ This is the parity to assign to the port, 0=7-None, 1=7-Even, 2=7-Odd, 3=8-None, 4=8-Even, 5=8-Odd.
+
+
+ mode (False, int, None)
+ This is the port mode to assign to the port, 0=Any-to-Any. 1=Passive, 2=Buffer, 3=Modem, 4=ModemPPP.
+
+
+ cmd (False, int, None)
+ This is the Admin Mode to assign to the port, 0=Deny, 1=Permit.
+
+
+ seq (False, int, None)
+ This is the type of Sequence Disconnect to assign to the port, 1=Three Characters (before and after), 2=One Character Only, 3=Off
+
+
+ tout (False, int, None)
+ This is the Port Activity Timeout to assign to the port, 0=Off, 1=5 Min, 2=15 Min, 3=30 Min, 4=90 Min, 5=1 Min.
+
+
+ echo (False, bool, None)
+ -This is the command echo parameter to assign to the port, 0=Off, 1=On
+
+
+ break_allow (False, bool, None)
+ This is if the break character is allowed to be passed through the port, 0=Off, 1=On
+
+
+ logoff (False, str, None)
+ This is the logout character to assign to the port
+
+ If preceded by a ^ character, the sequence will be a control character. Used if seq is set to 0 or 1
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Set Serial Port Parameters
+ - name: Set the Port Parameters for port 2 of a WTI device
+ cpm_serial_port_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: "2"
+ portname: "RouterLabel"
+ baud: "7"
+ handshake: "1"
+ stopbits: "1"
+ parity: "0"
+ mode: "0"
+ cmd: "0"
+ seq: "1"
+ tout: "1"
+ echo: "0"
+ break_allow: "0"
+ logoff: "^H"
+
+ # Set Serial Port Port Name and Baud Rate Parameters
+ - name: Set New port name and baud rate (115k) for port 4 of a WTI device
+ cpm_serial_port_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: "4"
+ portname: "NewPortName1"
+ baud: "8"
+
+
+
+Return Values
+-------------
+
+data (always, str, )
+ The output JSON returned from the commands sent
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_serial_port_info.rst b/ansible_collections/wti/remote/docs/cpm_serial_port_info.rst
new file mode 100644
index 00000000..d88fd390
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_serial_port_info.rst
@@ -0,0 +1,136 @@
+.. _cpm_serial_port_info_module:
+
+
+cpm_serial_port_info -- Get Serial port parameters in WTI OOB and PDU devices
+=============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get Serial port parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, False)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, False)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ port (False, list, ['*'])
+ This is the serial port number that is getting retrieved. It can include a single port
+
+ number, multiple port numbers separated by commas, a list of port numbers, or an '*' character for all ports.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Serial Port Parameters for port 2 of a WTI device
+ cpm_serial_port_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: 2
+
+ - name: Get the Serial Port Parameters for ports 2 and 4 of a WTI device
+ cpm_serial_port_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: 2,4
+
+ - name: Get the Serial Port Parameters for all ports of a WTI device
+ cpm_serial_port_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ port: "*"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ serialports (success, list, [{'baud': 4, 'break': 1, 'cmd': 1, 'connstatus': 'Free', 'echo': 1, 'handshake': 2, 'logoff': '^X', 'mode': 1, 'parity': 3, 'port': 2, 'portname': 'switch', 'seq': 2, 'stopbits': 1, 'tout': 0}, {'baud': 3, 'break': 1, 'cmd': 1, 'connstatus': 'Free', 'echo': 1, 'handshake': 2, 'logoff': '^X', 'mode': 1, 'parity': 1, 'port': 4, 'portname': 'router', 'seq': 2, 'stopbits': 1, 'tout': 1}])
+ List of data for each serial port
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_snmp_config.rst b/ansible_collections/wti/remote/docs/cpm_snmp_config.rst
new file mode 100644
index 00000000..beb8c8f4
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_snmp_config.rst
@@ -0,0 +1,223 @@
+.. _cpm_snmp_config_module:
+
+
+cpm_snmp_config -- Set network IPTables parameters in WTI OOB and PDU devices
+=============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set network IPTables parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ protocol (False, int, None)
+ The protocol that the SNMP entry should be applied. 0 = ipv4, 1 = ipv6.
+
+
+ enable (False, int, None)
+ The activates SNMP polling for the specified interface and protocol.
+
+
+ interface (True, str, None)
+ The ethernet port for the SNMP we are defining.
+
+
+ readonly (False, int, None)
+ Controls the ability to change configuration parameters with SNMP.
+
+
+ version (False, int, None)
+ Defined which version of SNMP the device will respond to 0 = V1/V2 Only, 1 = V3 Only, 2 = V1/V2/V3.
+
+
+ contact (False, str, None)
+ The name of the administrator responsible for SNMP issues.
+
+
+ location (False, str, None)
+ The location of the SNMP Server.
+
+
+ systemname (False, str, None)
+ The hostname of the WTI Device.
+
+
+ rocommunity (False, str, None)
+ Read Only Community Password, not used for SNMP V3.
+
+
+ rwcommunity (False, str, None)
+ Read/Write Community Password, not used for SNMP V3.
+
+
+ clear (False, int, None)
+ Removes all the users for the protocol being defined before setting the newly defined entries.
+
+
+ index (False, list, None)
+ Index of the user being modified (V3 only).
+
+
+ username (False, list, None)
+ Sets the User Name for SNMPv3 access (V3 only).
+
+
+ authpriv (False, list, None)
+ Configures the Authentication and Privacy features for SNMPv3 communication, 0 = Auth/NoPriv, 1 = Auth/Priv (V3 only).
+
+
+ authpass (False, list, None)
+ Sets the Authentication Password for SNMPv3 (V3 only).
+
+
+ authproto (False, list, None)
+ Which authentication protocol will be used, 0 = MD5, 1 = SHA1 (V3 only).
+
+
+ privpass (False, list, None)
+ Sets the Privacy Password for SNMPv3 (V3 only) (V3 only).
+
+
+ privproto (False, list, None)
+ Which privacy protocol will be used, 0 = DES, 1 = AES128 (V3 only).
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # 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
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ snmpaccess (always, dict, [{'eth0': {'ietf-ipv4': {'clear': 1, 'enable': 0, 'readonly': 0, 'version': 0, 'users': [{'username': 'username1', 'authpass': 'testpass', 'authpriv': '1', 'authproto': '0', 'privpass': 'privpass1', 'privproto': '0', 'index': '1'}]}}}])
+ Current k/v pairs of interface info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_snmp_info.rst b/ansible_collections/wti/remote/docs/cpm_snmp_info.rst
new file mode 100644
index 00000000..5ce92de3
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_snmp_info.rst
@@ -0,0 +1,127 @@
+.. _cpm_snmp_info_module:
+
+
+cpm_snmp_info -- Get network SNMP parameters from WTI OOB and PDU devices
+=========================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get network SNMP parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ interface (False, list, None)
+ 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 (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - 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
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ snmpaccess (always, dict, {'snmpaccess': [{'eth0': {'ietf-ipv4': [{'enable': 0, 'users': [{'index': '1', 'username': 'test10', 'authpriv': '1', 'authpass': 'testpass', 'authproto': '0', 'privpass': 'testpass', 'privproto': '1'}]}], 'ietf-ipv6': [{'enable': 0, 'users': [{'index': '1', 'username': 'test10', 'authpriv': '1', 'authpass': 'testpass', 'authproto': '0', 'privpass': 'testpass', 'privproto': '1'}]}]}}]})
+ Current k/v pairs of SNMP info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_status_info.rst b/ansible_collections/wti/remote/docs/cpm_status_info.rst
new file mode 100644
index 00000000..a65790d0
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_status_info.rst
@@ -0,0 +1,227 @@
+.. _cpm_status_info_module:
+
+
+cpm_status_info -- Get general status information from WTI OOB and PDU devices
+==============================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get temperature general status from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Status Information for a WTI device
+ cpm_status_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Status Information for a WTI device
+ cpm_status_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ vendor (success, str, wti)
+ Identifies WTI device as a WTI device.
+
+
+ product (success, str, CPM-800-1-CA)
+ Current Product Part Number of the WTI device.
+
+
+ totalports (success, str, 9)
+ Total serial ports of the WTI device.
+
+
+ totalplugs (success, str, 8)
+ Total Power Outlet plugs of the WTI device.
+
+
+ option1/2 (success, str, WPO-STRT-CPM8 / W4G-VZW-CPM8)
+ Various Identity options of the WTI.
+
+
+ softwareversion (success, str, 6.60 19 Feb 2020)
+ Expanded Firmware version of the WTI device.
+
+
+ serialnumber (success, str, 12345678901234)
+ Current Serial number of the WTI device.
+
+
+ assettag (success, str, ARTE121)
+ Current Asset Tag of the WTI device.
+
+
+ siteid (success, str, GENEVARACK)
+ Current Site-ID of the WTI device.
+
+
+ analogmodemphonenumber (success, str, 9495869959)
+ Current Analog Modem (if installed) Phone number of the WTI device.
+
+
+ modeminstalled (success, str, Yes, 4G/LTE)
+ Identifies if a modem is installed in the WTI device.
+
+
+ modemmodel (success, str, MTSMC-LVW2)
+ Identifies the modem model number (if installed) in the WTI device.
+
+
+ gig_dualphy (success, str, Yes, Yes)
+ Identifies dual ethernet port and gigabyte ethernet ports in the WTI device.
+
+
+ cpu_boardprogramdate (success, str, ARM, 4-30-2019)
+ Current Board and Program date of the WTI device.
+
+
+ ram_flash (success, str, 512 MB, 128 MB)
+ Total RAM and FLASH installed in the WTI device..
+
+
+ lineinputcount_rating (success, str, 1 , 20 Amps)
+ Identifies total power inlets and their power rating.
+
+
+ currentmonitor (success, str, Yes)
+ Identifies if the unit has current monitoring capabilites.
+
+
+ keylength (success, str, 2048)
+ Current key length of the WTI device.
+
+
+ opensslversion (success, str, 1.1.1d 10 Sep 2019)
+ Current OpenSSL version running on the WTI device.
+
+
+ opensshversion (success, str, 8.2p1)
+ Current OpenSSH running on the WTI device.
+
+
+ apacheversion (success, str, 2.4.41)
+ Current Apache Web version running on the WTI device.
+
+
+ apirelease (success, str, March 2020)
+ Current Date of the API release of the WTI device.
+
+
+ uptime (success, str, 259308.26)
+ Current uptime of the WTI device.
+
+
+ energywise (success, str, 1.2.0)
+ Current Energywise version of the WTI device.
+
+
+ restful (success, str, v1.0, v2 (Mar20))
+ Current RESTful version of the WTI device.
+
+
+ interface_list (success, str, eth0)
+ Current ethernet ports of the WTI device.
+
+
+ macaddresses (always, dict, {'mac': '00-09-9b-02-9a-26'})
+ Current mac addresses of the WTI device.
+
+
+ status (always, dict, {'code': '0', 'text': 'OK'})
+ Return status after module completion
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_syslog_client_config.rst b/ansible_collections/wti/remote/docs/cpm_syslog_client_config.rst
new file mode 100644
index 00000000..791240cd
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_syslog_client_config.rst
@@ -0,0 +1,176 @@
+.. _cpm_syslog_client_config_module:
+
+
+cpm_syslog_client_config -- Set network SYSLOG Client parameters in WTI OOB and PDU devices
+===========================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set network SYSLOG Client parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ protocol (False, int, None)
+ The protocol that the SYSLOG entry should be applied. 0 = ipv4, 1 = ipv6.
+
+
+ clear (False, int, None)
+ Removes all the IP block entries for the protocol being defined before setting the newly defined entries.
+
+
+ index (False, list, None)
+ Index of the IP block being modified.
+
+
+ address (False, list, None)
+ Sets the IP Address of the SYSLOG server to contact.
+
+
+ port (False, list, None)
+ Defines the port number used by the SYSLOG Client (1 - 65535).
+
+
+ transport (False, list, None)
+ Defines the transfer protocol type used by the SYSLOG Client. 0=UDP, 1=TCP;
+
+
+ secure (False, list, None)
+ Defines if a secure connection is used by the SYSLOG Client (TCP Transport required).
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Sets the device SYSLOG Client Parameters
+ - name: Set the an SYSLOG Client Parameter for a WTI device
+ cpm_iptables_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ protocol: 0
+ index:
+ - 1
+ address:
+ - "11.22.33.44"
+ port:
+ - 555
+ transport:
+ - 1
+ secure:
+ - 0
+
+ # Sets the device SYSLOG Client Parameters
+ - name: Set the SYSLOG Client Parameters a WTI device
+ cpm_iptables_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ protocol: 0
+ index:
+ - 1
+ - 2
+ address:
+ - "11.22.33.44"
+ - "55.66.77.88"
+ port:
+ - 555
+ - 557
+ transport:
+ - 1
+ - 0
+ secure:
+ - 0
+ - 1
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ syslogclient (always, dict, {'syslogclient': {'ietf-ipv4': {'clients': [{'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '1'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '2'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '3'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '4'}]}, 'ietf-ipv6': {'clients': [{'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '1'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '2'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '3'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '4'}]}}})
+ Current k/v pairs of interface info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_syslog_client_info.rst b/ansible_collections/wti/remote/docs/cpm_syslog_client_info.rst
new file mode 100644
index 00000000..747d83c5
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_syslog_client_info.rst
@@ -0,0 +1,127 @@
+.. _cpm_syslog_client_info_module:
+
+
+cpm_syslog_client_info -- Get network SYSLOG Client parameters from WTI OOB and PDU devices
+===========================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get network SYSLOG Client parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ interface (False, list, None)
+ 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 (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the network SYSLOG Client 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 SYSLOG Client 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
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ syslogclient (always, dict, {'syslogclient': {'ietf-ipv4': {'clients': [{'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '1'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '2'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '3'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '4'}]}, 'ietf-ipv6': {'clients': [{'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '1'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '2'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '3'}, {'address': '', 'port': '514', 'transport': '0', 'secure': '0', 'index': '4'}]}}})
+ Current k/v pairs of SYSLOG Client info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_syslog_server_config.rst b/ansible_collections/wti/remote/docs/cpm_syslog_server_config.rst
new file mode 100644
index 00000000..42732eba
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_syslog_server_config.rst
@@ -0,0 +1,175 @@
+.. _cpm_syslog_server_config_module:
+
+
+cpm_syslog_server_config -- Set network SYSLOG Server parameters in WTI OOB and PDU devices
+===========================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set network SYSLOG Server parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ interface (True, list, None)
+ The ethernet port for the SYSLOG we are defining.
+
+
+ protocol (False, int, None)
+ The protocol that the SYSLOG entry should be applied. 0 = ipv4, 1 = ipv6.
+
+
+ enable (False, int, None)
+ Activates SYSLOG listening for the specified interface and protocol.
+
+
+ port (False, int, None)
+ Defines the port number used by the SYSLOG Server (1 - 65535).
+
+
+ transport (False, int, None)
+ Defines the transfer protocol type used by the SYSLOG Server. 0=UDP, 1=TCP;
+
+
+ secure (False, int, None)
+ Defines if a secure connection is used by the SYSLOG Server (TCP Transport required).
+
+
+ clear (False, int, None)
+ Removes all the IP block entries for the protocol being defined before setting the newly defined entries.
+
+
+ index (False, list, None)
+ Index of the IP block being modified.
+
+
+ address (False, list, None)
+ Sets the IP Address to block message logging.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Sets the device SYSLOG Server Parameters
+ - name: Set the an SYSLOG Server Parameter for a WTI device
+ cpm_iptables_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ interface: "eth0"
+ protocol: 0
+ port: 514
+ transport: 0
+ secure: 0
+ clear: 1
+
+ # Sets the device SYSLOG Server Parameters
+ - name: Set the SYSLOG Server Parameters a WTI device
+ cpm_iptables_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ interface: "eth0"
+ protocol: 0
+ port: 514
+ transport: 0
+ secure: 0
+ clear: 1
+ index:
+ - 1
+ - 2
+ block:
+ - "192.168.50.4"
+ - "72.76.4.56"
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ syslogserver (always, dict, {'syslogserver': {'eth0': [{'ietf-ipv4': {'block': [{'address': '', 'index': '1'}, {'address': '', 'index': '2'}, {'address': '', 'index': '3'}, {'address': '', 'index': '4'}], 'enable': 0, 'port': '514', 'secure': '0', 'transport': '0'}, 'ietf-ipv6': {'block': [{'address': '', 'index': '1'}, {'address': '', 'index': '2'}, {'address': '', 'index': '3'}, {'address': '', 'index': '4'}], 'enable': 0, 'port': '514', 'secure': '0', 'transport': '0'}}]}})
+ Current k/v pairs of interface info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_syslog_server_info.rst b/ansible_collections/wti/remote/docs/cpm_syslog_server_info.rst
new file mode 100644
index 00000000..4a2a79c9
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_syslog_server_info.rst
@@ -0,0 +1,127 @@
+.. _cpm_syslog_server_info_module:
+
+
+cpm_syslog_server_info -- Get network SYSLOG Server parameters from WTI OOB and PDU devices
+===========================================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get network SYSLOG Server parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ interface (False, list, None)
+ 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 (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the network SYSLOG Server 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 SYSLOG Server 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
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ syslogserver (always, dict, {'syslogserver': {'eth0': [{'ietf-ipv4': {'block': [{'address': '', 'index': '1'}, {'address': '', 'index': '2'}, {'address': '', 'index': '3'}, {'address': '', 'index': '4'}], 'enable': 0, 'port': '514', 'secure': '0', 'transport': '0'}, 'ietf-ipv6': {'block': [{'address': '', 'index': '1'}, {'address': '', 'index': '2'}, {'address': '', 'index': '3'}, {'address': '', 'index': '4'}], 'enable': 0, 'port': '514', 'secure': '0', 'transport': '0'}}]}})
+ Current k/v pairs of SYSLOG Server info for the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_temp_info.rst b/ansible_collections/wti/remote/docs/cpm_temp_info.rst
new file mode 100644
index 00000000..c249cb93
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_temp_info.rst
@@ -0,0 +1,131 @@
+.. _cpm_temp_info_module:
+
+
+cpm_temp_info -- Get temperature information from WTI OOB and PDU devices
+=========================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get temperature information from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Temperature Information of a WTI device
+ cpm_temp_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Temperature Information of a WTI device
+ cpm_temp_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ temperature (success, str, 76)
+ Current Temperature of the WTI device after module execution.
+
+
+ format (success, str, F)
+ Current Temperature format (Celsius or Fahrenheit) of the WTI device after module execution.
+
+
+ timestamp (success, str, 2020-02-24T20:54:03+00:00)
+ Current timestamp of the WTI device after module execution.
+
+
+ status (always, dict, {'code': '0', 'text': 'OK'})
+ Return status after module completion
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_time_config.rst b/ansible_collections/wti/remote/docs/cpm_time_config.rst
new file mode 100644
index 00000000..1194df07
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_time_config.rst
@@ -0,0 +1,168 @@
+.. _cpm_time_config_module:
+
+
+cpm_time_config -- Set Time/Date parameters in WTI OOB and PDU devices.
+=======================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Set Time/Date and NTP parameters parameters in WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ date (False, str, None)
+ Static date in the format of two digit month, two digit day, four digit year separated by a slash symbol.
+
+
+ time (False, str, None)
+ Static time in the format of two digit hour, two digit minute, two digit second separated by a colon symbol.
+
+
+ timezone (False, int, None)
+ This is timezone that is assigned to the WTI device.
+
+
+ ntpenable (False, int, None)
+ This enables or disables the NTP client service.
+
+
+ ipv4address (False, str, None)
+ Comma separated string of up to two addresses for a primary and secondary IPv4 base NTP server.
+
+
+ ipv6address (False, str, None)
+ Comma separated string of up to two addresses for a primary and secondary IPv6 base NTP server.
+
+
+ timeout (False, int, None)
+ Set the network timeout in seconds of contacting the NTP servers, valid options can be from 1-60.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Set a static time/date and timezone of a WTI device
+ - name: Set known fixed time/date of a WTI device
+ cpm_time_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ date: "12/12/2019"
+ time: "09:23:46"
+ timezone: 5
+
+ # Enable NTP and set primary and seconday servers of a WTI device
+ - name: Set NTP primary and seconday servers of a WTI device
+ cpm_time_config:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+ timezone: 5
+ ntpenable: 1
+ ipv4address: "129.6.15.28.pool.ntp.org"
+ timeout: 15
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ date (success, str, 11/14/2019)
+ Current Date of the WTI device after module execution.
+
+
+ time (success, str, 12:12:00)
+ Current Time of the WTI device after module execution.
+
+
+ timezone (success, int, 5)
+ Current Timezone of the WTI device after module execution.
+
+
+ ntp (always, dict, {'enable': '0', 'ietf-ipv4': {'address': [{'primary': '192.168.0.169', 'secondary': '12.34.56.78'}]}, 'ietf-ipv6': {'address': [{'primary': '', 'secondary': ''}]}, 'timeout': '4'})
+ Current k/v pairs of ntp info of the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_time_info.rst b/ansible_collections/wti/remote/docs/cpm_time_info.rst
new file mode 100644
index 00000000..c3603c5e
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_time_info.rst
@@ -0,0 +1,131 @@
+.. _cpm_time_info_module:
+
+
+cpm_time_info -- Get Time/Date parameters in WTI OOB and PDU devices
+====================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get Time/Date and NTP parameters from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+ - Use ``groups/cpm`` in ``module_defaults`` to set common options used between CPM modules.)
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get the Time/Date Parameters for a WTI device
+ cpm_time_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: true
+ validate_certs: false
+
+ - name: Get the Time/Date Parameters for a WTI device
+ cpm_time_info:
+ cpm_url: "nonexist.wti.com"
+ cpm_username: "super"
+ cpm_password: "super"
+ use_https: false
+ validate_certs: false
+
+
+
+Return Values
+-------------
+
+data (always, complex, )
+ The output JSON returned from the commands sent
+
+
+ date (success, str, 11/14/2019)
+ Current Date of the WTI device after module execution.
+
+
+ time (success, str, 12:12:00)
+ Current Time of the WTI device after module execution.
+
+
+ timezone (success, int, 5)
+ Current Timezone of the WTI device after module execution.
+
+
+ ntp (always, dict, {'enable': '0', 'ietf-ipv4': {'address': [{'primary': '192.168.0.169', 'secondary': '12.34.56.78'}]}, 'ietf-ipv6': {'address': [{'primary': '', 'secondary': ''}]}, 'timeout': '4'})
+ Current k/v pairs of ntp info of the WTI device after module execution.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+
diff --git a/ansible_collections/wti/remote/docs/cpm_user.rst b/ansible_collections/wti/remote/docs/cpm_user.rst
new file mode 100644
index 00000000..8865f718
--- /dev/null
+++ b/ansible_collections/wti/remote/docs/cpm_user.rst
@@ -0,0 +1,221 @@
+.. _cpm_user_module:
+
+
+cpm_user -- Get various status and parameters from WTI OOB and PDU devices
+==========================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Get/Add/Edit Delete Users from WTI OOB and PDU devices
+
+
+
+
+
+
+Parameters
+----------
+
+ cpm_action (True, str, None)
+ This is the Action to send the module.
+
+
+ cpm_url (True, str, None)
+ This is the URL of the WTI device to send the module.
+
+
+ cpm_username (True, str, None)
+ This is the Basic Authentication Username of the WTI device to send the module.
+
+
+ cpm_password (True, str, None)
+ This is the Basic Authentication Password of the WTI device to send the module.
+
+
+ use_https (False, bool, True)
+ Designates to use an https connection or http connection.
+
+
+ validate_certs (False, bool, True)
+ If false, SSL certificates will not be validated. This should only be used
+
+ on personally controlled sites using self-signed certificates.
+
+
+ use_proxy (False, bool, False)
+ Flag to control if the lookup will observe HTTP proxy environment variables when present.
+
+
+ user_name (True, str, None)
+ This is the User Name that needs to be create/modified/deleted
+
+
+ user_pass (False, str, None)
+ This is the User Password that needs to be create/modified/deleted
+
+ If the user is being Created this parameter is required
+
+
+ user_accesslevel (False, int, None)
+ This is the access level that needs to be create/modified/deleted
+
+ 0 View, 1 User, 2 SuperUser, 3 Administrator
+
+
+ user_accessssh (False, int, None)
+ If the user has access to the WTI device via SSH
+
+ 0 No , 1 Yes
+
+
+ user_accessserial (False, int, None)
+ If the user has access to the WTI device via Serial ports
+
+ 0 No , 1 Yes
+
+
+ user_accessweb (False, int, None)
+ If the user has access to the WTI device via Web
+
+ 0 No , 1 Yes
+
+
+ user_accessapi (False, int, None)
+ If the user has access to the WTI device via RESTful APIs
+
+ 0 No , 1 Yes
+
+
+ user_accessmonitor (False, int, None)
+ If the user has ability to monitor connection sessions
+
+ 0 No , 1 Yes
+
+
+ user_accessoutbound (False, int, None)
+ If the user has ability to initiate Outbound connection
+
+ 0 No , 1 Yes
+
+
+ user_portaccess (False, str, None)
+ If AccessLevel is lower than Administrator, which ports the user has access
+
+
+ user_plugaccess (False, str, None)
+ If AccessLevel is lower than Administrator, which plugs the user has access
+
+
+ user_groupaccess (False, str, None)
+ If AccessLevel is lower than Administrator, which Groups the user has access
+
+
+ user_callbackphone (False, str, None)
+ This is the Call Back phone number used for POTS modem connections
+
+
+
+
+
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ # Get User Parameters
+ - name: Get the User Parameters for the given user of a WTI device
+ cpm_user:
+ cpm_action: "getuser"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restuser"
+ cpm_password: "restfuluserpass12"
+ use_https: true
+ validate_certs: true
+ user_name: "usernumberone"
+
+ # Create User
+ - name: Create a User on a given WTI device
+ cpm_user:
+ cpm_action: "adduser"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restuser"
+ cpm_password: "restfuluserpass12"
+ use_https: true
+ validate_certs: false
+ user_name: "usernumberone"
+ user_pass: "complicatedpassword"
+ user_accesslevel: 2
+ user_accessssh: 1
+ user_accessserial: 1
+ user_accessweb: 0
+ user_accessapi: 1
+ user_accessmonitor: 0
+ user_accessoutbound: 0
+ user_portaccess: "10011111"
+ user_plugaccess: "00000111"
+ user_groupaccess: "00000000"
+
+ # Edit User
+ - name: Edit a User on a given WTI device
+ cpm_user:
+ cpm_action: "edituser"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restuser"
+ cpm_password: "restfuluserpass12"
+ use_https: true
+ validate_certs: false
+ user_name: "usernumberone"
+ user_pass: "newpasswordcomplicatedpassword"
+
+ # Delete User
+ - name: Delete a User from a given WTI device
+ cpm_user:
+ cpm_action: "deleteuser"
+ cpm_url: "rest.wti.com"
+ cpm_username: "restuser"
+ cpm_password: "restfuluserpass12"
+ use_https: true
+ validate_certs: true
+ user_name: "usernumberone"
+
+
+
+Return Values
+-------------
+
+data (always, str, )
+ The output JSON returned from the commands sent
+
+
+
+
+
+Status
+------
+
+
+
+
+- This module is not guaranteed to have a backwards compatible interface. *[preview]*
+
+
+- This module is maintained by community.
+
+
+
+Authors
+~~~~~~~
+
+- Western Telematic Inc. (@wtinetworkgear)
+