ieisystem.inmanage.edit_power_budget module – Set power budget information

Note

This module is part of the ieisystem.inmanage collection (version 3.0.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 ieisystem.inmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ieisystem.inmanage.edit_power_budget.

New in ieisystem.inmanage 1.0.0

Synopsis

  • Set power budget information on ieisystem Server.

Requirements

The below requirements are needed on the host that executes this module.

  • Python 3.7+

  • inManage

Parameters

Parameter

Comments

action

string

Type to action.

Required when range=False.

Choices:

  • "add"

  • "delete"

  • "open"

  • "close"

domain

string

Domain id.

Required when range=False.

Choices:

  • "system"

  • "cpu"

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.

except_action

integer

Except action, 0 is do nothing, 1 is send alert, 2 is shutdown system, 3 is shutdown system and send alert.

Only the M7 model supports this parameter.

Choices:

  • 0

  • 1

  • 2

  • 3

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

Policy id.

Required when range=False.

Choices:

  • 1

  • 2

  • 3

  • 4

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

Range of power budget watts.

Choices:

  • false ← (default)

  • true

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.

Notes

Note

  • Does not support check_mode.

Examples

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

  tasks:

  - name: "Get power budget range"
    ieisystem.inmanage.edit_power_budget:
      range: True
      provider: "{{ inmanage }}"

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

  - name: "Set power budget status to open"
    ieisystem.inmanage.edit_power_budget:
      action: "open"
      id: 1
      provider: "{{ inmanage }}"

  - name: "Set power budget status to close"
    ieisystem.inmanage.edit_power_budget:
      action: "close"
      id: 1
      provider: "{{ inmanage }}"

  - name: "Delete power budget"
    ieisystem.inmanage.edit_power_budget:
      action: "delete"
      id: 1
      provider: "{{ inmanage }}"

Return Values

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

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Authors

  • WangBaoshan (@ieisystem)