1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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)
|
