inspur.sm.edit_power_budget – Set power budget information.

Note

This plugin is part of the inspur.sm collection (version 1.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install inspur.sm.

To use it in a playbook, specify: inspur.sm.edit_power_budget.

New in version 0.1.0: of inspur.sm

Synopsis

Set power budget information on Inspur server.

Parameters

Parameter		Choices/Defaults	Comments
action string		Choices: add delete open close	Type to action. Required when range=False.
end1 integer			Pause period of add, end time,must be greater than start time,from 0 to 24.
end2 integer			Pause period of add, end time,must be greater than start time,from 0 to 24.
end3 integer			Pause period of add, end time,must be greater than start time,from 0 to 24.
end4 integer			Pause period of add, end time,must be greater than start time,from 0 to 24.
end5 integer			Pause period of add, end time,must be greater than start time,from 0 to 24.
host string			Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
id integer		Choices: 1 2 3 4	Policy id. Required when range=False.
password string			Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
provider dictionary			A dict object containing connection details.
	host string		Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
	password string		Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
	username string		Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
range boolean		Choices: no ← yes	Range of power budget watts.
start1 integer			Pause period of add, start time, from 0 to 24.
start2 integer			Pause period of add, start time, from 0 to 24.
start3 integer			Pause period of add, start time, from 0 to 24.
start4 integer			Pause period of add, start time, from 0 to 24.
start5 integer			Period of add, start time, from 0 to 24.
username string			Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
watts integer			Power budget watts of add. Required when action=add.
week1 list / elements=string			Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri.
week2 list / elements=string			Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri.
week3 list / elements=string			Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri.
week4 list / elements=string			Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri.
week5 list / elements=string			Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri.

Examples

- name: Power budget test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Get power budget range"
    inspur.sm.edit_power_budget:
      range: True
      provider: "{{ ism }}"

  - name: "add power budget"
    inspur.sm.edit_power_budget:
      action: "add"
      id: 1
      watts: 1500
      start1: 2
      end1: 5
      week1:
        - Mon
        - Wed
        - Fri
      provider: "{{ ism }}"

  - name: "Set power budget status to open"
    inspur.sm.edit_power_budget:
      action: "open"
      id: 1
      provider: "{{ ism }}"

  - name: "Set power budget status to close"
    inspur.sm.edit_power_budget:
      action: "close"
      id: 1
      provider: "{{ ism }}"

  - name: "Delete power budget"
    inspur.sm.edit_power_budget:
      action: "delete"
      id: 1
      provider: "{{ ism }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
changed boolean	always	Check to see if a change was made on the device.
message string	always	Messages returned after module execution.
state string	always	Status after module execution.

Authors

WangBaoshan (@ISIB-group)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/inspur/sm/edit_power_budget_module.html

Docs

Docs4dev

Title here