On this page
ipmi_power - Power management for machine
New in version 2.2.
Synopsis
- Use this module for power management
 
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
 - pyghmi
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| name  
        required
         | 
      
        
        Hostname or ip address of the BMC.
         | 
     |
| password  
        required
         | 
      
        
        Password to connect to the BMC.
         | 
     |
| port | Default: 
        623
         | 
      
        
        Remote RMCP port.
         | 
     
| state  
        required
         | 
      
       
  | 
      
        
        Whether to ensure that the machine in desired state.
         | 
     
| timeout | Default: 
        300
         | 
      
        
        Maximum number of seconds before interrupt request.
         | 
     
| user  
        required
         | 
      
        
        Username to use to connect to the BMC.
         | 
     
Examples
# Ensure machine is powered on.
- ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: on
  Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| powerstate  
        string
         | 
      success | 
        
        The current power state of the machine.
         Sample:
        
       
        True
         | 
     
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Bulat Gaifullin (gaifullinbf@gmail.com)
 
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/2.6/modules/ipmi_power_module.html