container_exec.md

🧠 Resource Documentation: portainer_container_exec

portainer_container_exec

The portainer_container_exec resource allows you to remotely execute a command inside a running container managed by Portainer.

You can target a container in a standalone or swarm environment.

Example Usage

Run command in standalone container

resource "portainer_container_exec" "standalone" {
  endpoint_id   = 1
  service_name  = "my-nginx-container"
  command       = "nginx -v"
  user          = "root"
}

Run command in swarm service container

resource "portainer_container_exec" "swarm_exec" {
  endpoint_id   = 2
  service_name  = "my-service-name"
  command       = "ls -la /etc"
  user          = "root"
  mode          = "swarm"
}

---

Lifecycle & Behavior

This resource is stateless – it runs once when terraform apply is called.

💡 Pro Tip: You can output the result like this:

output "exec_output" {
  value = portainer_container_exec.standalone.output
}

---

Arguments Reference

Name	Type	Required	Description
endpoint_id	int	✅ yes	ID of the Portainer environment
service_name	string	✅ yes	Name of the container (for standalone) or service (for swarm)
command	string	✅ yes	Command to execute inside the container
user	string	🚫 optional	User to run the command as (default: "root:root")
wait	int	🚫 optional	Seconds to wait before executing the command (default: 0)
mode	string	🚫 optional	Deployment type: "standalone" (default) or "swarm"

---

Attributes Reference

Name	Description
id	ID of the execution instance
output	Output (stdout/stderr) from the executed command