dellemc.openmanage.redfish_powerstate (2.1.5) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==2.1.5

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module allows to manage the different power states of the specified device.

Requirements

• python >= 2.7.5

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Manage power state of the first device.
  dellemc.openmanage.redfish_powerstate:
       baseuri: "192.168.0.1"
       username: "username"
       password: "password"
       reset_type: "On"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Manage power state of a specified device.
  dellemc.openmanage.redfish_powerstate:
       baseuri: "192.168.0.1"
       username: "username"
       password: "password"
       reset_type: "ForceOff"
       resource_id: "System.Embedded.1"

Inputs

    
baseuri:
    description: IP address of the target out-of-band controller. For example- <ipaddress>:<port>
    required: true
    type: str

password:
    description: Password of the target out-of-band controller.
    required: true
    type: str

username:
    description: Username of the target out-of-band controller.
    required: true
    type: str

reset_type:
    choices:
    - ForceOff
    - ForceOn
    - ForceRestart
    - GracefulRestart
    - GracefulShutdown
    - Nmi
    - 'On'
    - PowerCycle
    - PushPowerButton
    description:
    - This option resets the device.
    - If C(ForceOff), Turns off the device immediately.
    - If C(ForceOn), Turns on the device immediately.
    - If C(ForceRestart), Turns off the device immediately, and then restarts the device.
    - If C(GracefulRestart), Performs graceful shutdown of the device, and then restarts
      the device.
    - If C(GracefulShutdown), Performs a graceful shutdown of the device, and the turns
      off the device.
    - If C(Nmi), Sends a diagnostic interrupt to the device. This is usually a non-maskable
      interrupt (NMI) on x86 device.
    - If C(On), Turns on the device.
    - If C(PowerCycle), Performs power cycle on the device.
    - If C(PushPowerButton), Simulates the pressing of a physical power button on the
      device.
    - When a power control operation is performed, which is not supported on the device,
      an error message is displayed with the list of operations that can be performed.
    required: true
    type: str

resource_id:
    description:
    - The unique identifier of the device being managed. For example- U(https://<I(baseuri)>/redfish/v1/Systems/<I(resource_id)>).
    - This option is mandatory for I(base_uri) with multiple devices.
    - To get the device details, use the API U(https://<I(baseuri)>/redfish/v1/Systems)
    required: false
    type: str