ieisystem.inmanage.edit_power_budget (1.1.1) — module

Set power budget information

| "added in version" 1.0.0 of ieisystem.inmanage"

Authors: WangBaoshan (@ieisystem)

Install collection

Install with ansible-galaxy collection install ieisystem.inmanage:==1.1.1


Add to requirements.yml

  collections:
    - name: ieisystem.inmanage
      version: 1.1.1

Description

Set power budget information on ieisystem Server.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Power budget test
  hosts: inmanage
  connection: local
  gather_facts: no
  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 }}"

Inputs

    
id:
    choices:
    - 1
    - 2
    - 3
    - 4
    description:
    - Policy id.
    - Required when I(range=False).
    type: int

end1:
    description:
    - Pause period of add, end time, must be greater than start time, from 0 to 24.
    type: int

end2:
    description:
    - Pause period of add, end time, must be greater than start time, from 0 to 24.
    type: int

end3:
    description:
    - Pause period of add, end time, must be greater than start time, from 0 to 24.
    type: int

end4:
    description:
    - Pause period of add, end time, must be greater than start time, from 0 to 24.
    type: int

end5:
    description:
    - Pause period of add, end time, must be greater than start time, from 0 to 24.
    type: int

host:
    description:
    - 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.
    type: str

range:
    choices:
    - 'True'
    - 'False'
    default: false
    description:
    - Range of power budget watts.
    type: bool

watts:
    description:
    - Power budget watts of add.
    - Required when I(action=add).
    type: int

week1:
    description:
    - 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.
    elements: str
    type: list

week2:
    description:
    - 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.
    elements: str
    type: list

week3:
    description:
    - 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.
    elements: str
    type: list

week4:
    description:
    - 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.
    elements: str
    type: list

week5:
    description:
    - 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.
    elements: str
    type: list

action:
    choices:
    - add
    - delete
    - open
    - close
    description:
    - Type to action.
    - Required when I(range=False).
    type: str

domain:
    choices:
    - system
    - cpu
    description:
    - Domain id.
    - Required when I(range=False).
    type: str

start1:
    description:
    - Pause period of add, start time, from 0 to 24.
    type: int

start2:
    description:
    - Pause period of add, start time, from 0 to 24.
    type: int

start3:
    description:
    - Pause period of add, start time, from 0 to 24.
    type: int

start4:
    description:
    - Pause period of add, start time, from 0 to 24.
    type: int

start5:
    description:
    - Period of add, start time, from 0 to 24.
    type: int

password:
    description:
    - 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 C(ANSIBLE_NET_PASSWORD)
      will be used instead.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      host:
        description:
        - 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.
        type: str
      password:
        description:
        - 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
          C(ANSIBLE_NET_PASSWORD) will be used instead.
        type: str
      username:
        description:
        - 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 C(ANSIBLE_NET_USERNAME) will be used instead.
        type: str
    type: dict

username:
    description:
    - 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 C(ANSIBLE_NET_USERNAME)
      will be used instead.
    type: str

except_action:
    choices:
    - 0
    - 1
    - 2
    - 3
    description:
    - 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.
    type: int

Outputs

changed:
  description: Check to see if a change was made on the device.
  returned: always
  type: bool
message:
  description: Messages returned after module execution.
  returned: always
  type: str
state:
  description: Status after module execution.
  returned: always
  type: str