This document version is no longer actively maintained.
The site that you are currently viewing is an archived snapshot.
For up-to-date documentation, see the latest version.
redfish_power (Resource)
Example Usage
This Terraform resource is used to configure Power attributes of the iDRAC Server. We can Read the existing power state or modify it using this resource.
variables.tf
/*
Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
variable "rack1" {
type = map(object({
user = string
password = string
endpoint = string
ssl_insecure = bool
}))
}
terraform.tfvars
/*
Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
rack1 = {
"my-server-1" = {
user = "admin"
password = "passw0rd"
endpoint = "https://my-server-1.myawesomecompany.org"
ssl_insecure = true
},
"my-server-2" = {
user = "admin"
password = "passw0rd"
endpoint = "https://my-server-2.myawesomecompany.org"
ssl_insecure = true
},
}
provider.tf
/*
Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
terraform {
required_providers {
redfish = {
version = "1.0.0"
source = "registry.terraform.io/dell/redfish"
}
}
}
main.tf
/*
Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
resource "redfish_power" "system_power" {
for_each = var.rack1
redfish_server {
user = each.value.user
password = each.value.password
endpoint = each.value.endpoint
ssl_insecure = each.value.ssl_insecure
}
// The valid options are defined below.
// Taken from the Redfish specification at: https://redfish.dmtf.org/schemas/DSP2046_2019.4.html
/*
| string | Description |
|------------------|-----------------------------------------------------------------------------------------|
| ForceOff | Turn off the unit immediately (non-graceful shutdown). |
| ForceOn | Turn on the unit immediately. |
| ForceRestart | Shut down immediately and non-gracefully and restart the system. |
| GracefulShutdown | Shut down gracefully and power off. |
| On | Turn on the unit. |
| PowerCycle | Power cycle the unit. |
| GracefulRestart | Shut down gracefully and restart the system . |
| PushPowerButton | Alters the power state of the system. If the system is Off, it powers On and vice-versa |
| Nmi | Turns the unit on in troubleshooting mode. |
*/
desired_power_action = "ForceRestart"
// The maximum amount of time to wait for the server to enter the correct power state before
// giving up in seconds
maximum_wait_time = 120
// The frequency with which to check the server's power state in seconds
check_interval = 10
}
output "current_power_state" {
value = redfish_power.system_power
}
After the successful execution of the above resource block, Power state would have been modified to the above desired value. It can be verified through state file.
Schema
Required
desired_power_action
(String) Desired power setting. Applicable values are ‘On’,‘ForceOn’,‘ForceOff’,‘ForceRestart’,‘GracefulRestart’,‘GracefulShutdown’,‘PowerCycle’, ‘PushPowerButton’, ‘Nmi’redfish_server
(Block List, Min: 1) List of server BMCs and their respective user credentials (see below for nested schema)
Optional
check_interval
(Number) The frequency with which to check the server’s power state in secondsmaximum_wait_time
(Number) The maximum amount of time to wait for the server to enter the correct power state beforegiving up in seconds
Read-Only
id
(String) The ID of this resource.power_state
(String) Desired power setting. Applicable values ‘On’,‘ForceOn’,‘ForceOff’,‘ForceRestart’,‘GracefulRestart’,‘GracefulShutdown’,‘PowerCycle’, ‘PushPowerButton’, ‘Nmi’.
Nested Schema for redfish_server
Required:
endpoint
(String) Server BMC IP address or hostname
Optional:
password
(String, Sensitive) User password for loginssl_insecure
(Boolean) This field indicates whether the SSL/TLS certificate must be verified or notuser
(String) User name for login