Terraform Options

This page documents the resources and data sources available in the NetActuate Terraform provider.

Resources

netactuate_server

Manages a NetActuate virtual server instance.

Argument	Type	Description	Required
hostname	string	Server hostname	Yes
plan	string	Plan identifier (e.g., VR2x2x40). See API Virtual Server Plans.	Yes
location	string	Location identifier (e.g., IAD3). See API Locations.	Yes
image	string	OS image identifier (e.g., 5787). See API OS Images.	Yes
ssh_keys	list(string)	List of SSH key IDs to inject	No
ssh_key_id	number	Existing SSH key ID (alternative to ssh_keys)	No
cloud_config	string	Cloud-init configuration passed to the VM at build time. Must be valid cloud-init YAML.	No
user_data	string	Initialization script content (base64-encoded internally by the provider)	No
user_data_base64	string	Pre-encoded base64 user data (use instead of user_data if already encoded)	No
package_billing	string	Billing type: usage or package	No
package_billing_contract_id	string	Contract ID (required when package_billing is usage)	No
tags	map(string)	Tags for the instance	No

Exported Attributes

Attribute	Type	Description
id	string	Server ID
ip_address	string	Primary IPv4 address
ipv6_address	string	Primary IPv6 address
status	string	Current server status
created_at	string	Creation timestamp

Example

resource "netactuate_server" "web" {
  hostname = "web-01"
  plan     = "VR2x2x40"
  location = "IAD3"
  image    = "5787"
  ssh_keys = [netactuate_ssh_key.deploy.id]

  tags = {
    environment = "production"
    role        = "web"
  }
}

netactuate_ssh_key

Manages an SSH public key in your NetActuate account.

Argument	Type	Description	Required
name	string	Key name	Yes
public_key	string	SSH public key content	Yes

Example

resource "netactuate_ssh_key" "deploy" {
  name       = "deploy-key"
  public_key = file("~/.ssh/id_ed25519.pub")
}

netactuate_bgp_sessions

Manages BGP session assignment for a server. This resource assigns a server to a BGP group at the API level.

Argument	Type	Description	Required
mbpkgid	number	Server package ID (from netactuate_server.id)	Yes
group_id	number	BGP group ID (pre-configured by NetActuate)	Yes
ipv6	boolean	Enable IPv6 BGP sessions (default: true)	No
redundant	boolean	Enable redundant sessions (default: false)	No

Note: The BGP sessions resource handles API-level BGP group assignment only. BGP daemon configuration (BIRD2 or FRR) is managed separately by Ansible. See netactuate-ansible-bgp-bird2.

Example

resource "netactuate_bgp_sessions" "worker" {
  mbpkgid  = tonumber(netactuate_server.node.id)
  group_id = tonumber(var.bgp_group_id)
  ipv6     = true
  redundant = true
}

Data Sources

netactuate_locations

Retrieves available deployment locations.

data "netactuate_locations" "all" {}

output "locations" {
  value = data.netactuate_locations.all.locations
}

netactuate_images

Retrieves available OS images.

data "netactuate_images" "all" {}

netactuate_sizes

Retrieves available server plans.

data "netactuate_sizes" "all" {}

Need Help?

If you need assistance with Terraform resource configuration, visit our support page.