ansible / ansible.builtin / v2.8.17 / module / cpm_plugconfig Get and Set Plug Parameters on WTI OOB and PDU power devices | "added in version" 2.8 of ansible.builtin" Authors: Western Telematic Inc. (@wtinetworkgear) preview | supported by communityansible.builtin.cpm_plugconfig (v2.8.17) — module
pip
Install with pip install ansible==2.8.17
Get and Set Plug Parameters on WTI OOB and PDU devices
# 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"
cpm_url: description: - This is the URL of the WTI device to send the module. required: true plug_id: description: - 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. required: true plug_name: description: - The new name of the Plug. required: false use_https: default: true description: - Designates to use an https connection or http connection. required: false type: bool use_proxy: default: false description: Flag to control if the lookup will observe HTTP proxy environment variables when present. required: false type: bool cpm_action: choices: - getplugconfig - setplugconfig description: - This is the Action to send the module. required: true cpm_password: description: - This is the Password of the WTI device to send the module. cpm_username: description: - This is the Username of the WTI device to send the module. plug_default: choices: - 0 - 1 description: - What the Plugs default state is when the device starts. 0 - Off, 1 - On. required: false plug_bootdelay: choices: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 description: - 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'. required: false validate_certs: default: true description: - If false, SSL certificates will not be validated. This should only be used - on personally controlled sites using self-signed certificates. required: false type: bool plug_bootpriority: description: - 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. required: false
data: description: The output JSON returned from the commands sent returned: always type: str