• What’s new
  • Archive of 2024 What’s New
  • Archive of 2023 What’s New
  • Older What’s New pages
• Getting started
• Creating a Skytap on Azure account
  • Adding a region to a Skytap on Azure account
  • Removing a region from a Skytap on Azure account
• User Guide
• Admin Guide
• Developer tools
  • Getting started with the Skytap dynamic inventory for Ansible
  • Using containers in Skytap
  • Using the Skytap plugin for Jenkins
  • Using PowerShell with Skytap
  • Getting started with Puppet in Skytap
  • Using the Skytap Terraform provider
    • Getting started with the Skytap Terraform provider
    • Terraform provider reference guide
  • Using the Skytap Automation Pack for IBM UrbanCode Deploy
  • Overview of the Skytap provider for Vagrant
    • Skytap provider for Vagrant installation requirements
    • Skytap provider for Vagrant quick start
    • Modifying Skytap VMs and environments created by Vagrant
    • Troubleshooting the Skytap provider for Vagrant and known issues
    • Creating a Vagrantfile
    • Supported Vagrant commands
  • Using the Skytap automation pack for Visual Studio Team Foundation Server
• REST API
  • API quick start
  • v1 reference
  • v2 reference
  • Example scripts and clients
  • Best practice - Checking for busyness
  • Exporting CSV reports from the API
  • HTTP status codes
  • API troubleshooting
  • Support and terms of use
• Skytap Course Manager
• FAQs
  • How do I find the VM user name and password?
  • I can’t sign in to my account. How do I reset my password or find my user name?
  • What connection types work between VMs in the same environment?
  • How does Skytap generate the VM DNS name?
  • Why can’t I connect to a published service running on a VM?
  • What IP addresses and port ranges does Skytap use?
  • Can I recover deleted resources?
  • Does Skytap have regular maintenance windows?
  • Does Skytap support load balancing?
  • How do I access the BIOS for a VM?
  • How do I access the System Management Services console for an AIX VM?
  • How do I take a snapshot of an environment?
  • How does Skytap measure storage?
  • Operating systems in Skytap VMs
  • Skytap licensed titles FAQ
  • Why does my Windows VM reboot after I add it to an environment?
  • Why is my operation pending?
• Troubleshooting
  • Skytap error messages
• Glossary
• Support contact information and SLA

Skytap Terraform provider reference guide

Configuration and credentials

provider "skytap" {
  username = "${var.skytap_username}"
  api_token = "${var.skytap_api_token}"
}

resource "skytap_environment" "env" {
  # ...
}

Data Sources

skytap_template

Retrieves information about a template A read-only copy of an environment that can be used to back up critical environments. It acts like a blueprint for new environments. To learn more, see Saving an environment as a template. . This data source provides the id and name of a template as configured in your Skytap account. This is useful to retrieve a template id via its name.

The name field can accept an exact string or a regular expression.

An error occurs if any of the following conditions is true:

• No template can be retrieved.
• The template doesn’t exist.
• More than one template matches the name and the most_recent flag isn’t set.

If more than one template is returned, set most_recent to true to sort the results in descending order by creation date. By default, the newest template is used.

The data source name is skytap_template and the following fields are defined:

Attributes Reference

The following attributes are exported:

Example Usage

Get the template:

data "skytap_template" "example" {
  name = "18.04"
  most_recent = true
}

skytap_project

Get information on a project A set of shared templates, environments, and assets. Users gain access to shared resources by becoming a member of a project. To learn more, see Sharing resources with projects. . This data source provides the id, name, summary, auto_add_role_name and show_project_members properties of a project as configured in your Skytap account. Use to obtain the project’s id via its name.

An error occurs if any of the following conditions is true:

• No projects can be retrieved.
• The project doesn’t exist.
• More than one project matches the name.

Example Usage

Get the project:

data "skytap_project" "example" {
  name = "example"
}

Argument Reference

The following arguments are supported:

Attributes Reference

The following attributes are exported:

Resources

skytap_environment

Provides a Skytap environment An object that comprises one or more VMs, one or more networks, configuration settings, and metadata. You can save the exact state of an environment as a read-only template. To learn more, see Skytap quick start: Building your first environment. resource. Unlike a template, an environment can be run and be modified. When an environment is created, all of its VMs are run.

When you create an environment from a template, terraform doesn’t enumerate the resources contained within that template, including VMs and networks. If you remove a resource (such as a VM Virtual Machine – A virtual computer or server hosted within a data center. A VM runs a full operating system and applications. Each VM has virtual resources, including CPU, RAM, file system storage, CD/DVD drive, and network interfaces. or network) from the environment, terraform doesn’t automatically restore that resource.

Example Usage

# Create a new environment
resource "skytap_environment" "environment" {
  template_id = "123456"
  name = "Terraform Example"
  description = "Skytap terraform provider example environment."
  tags = ["example", "terraform"]
  timeouts {
    create = "20m"
    delete = "1h"
  }
}

Argument Reference

The following arguments are supported:

Attributes Reference

The following attributes are exported:

skytap_vm

Provides a Skytap VM Virtual Machine – A virtual computer or server hosted within a data center. A VM runs a full operating system and applications. Each VM has virtual resources, including CPU, RAM, file system storage, CD/DVD drive, and network interfaces. resource. The VM resource represents an image of a single virtual machine.

Example Usage

# Create a new vm
resource "skytap_vm" "vm" {
  template_id = 123
  vm_id = 456
  environment_id = 789
  name = "my vm"
  cpus = 4
  ram = 4096
  timeouts {
    create = "60m"
    delete = "2h"
  }

  os_disk_size = 40960

  disk {
    name = "my disk"
    size = 4096
  }
  disk = {
      name = "my other disk"
      size = 4096
  }

  network_interface {
    interface_type = "vmxnet3"
    network_id = "${skytap_network.my_network.id}"
    ip = "10.0.0.1"
    hostname = "myhost"

    published_service {
      name = "ssh"
      internal_port = 22
    }
  }
}

# Will work after VM resource is created
output "ssh_ip" {
  value = "${skytap_vm.vm.service_ips.ssh}"
}
output "ssh_port" {
  value = "${skytap_vm.vm.service_ports.ssh}"
}

Argument Reference

The following arguments are supported:

To change cpus or ram settings for an existing VM, you must first shut down the VM.

Attributes Reference

The following attributes are exported:

skytap_network

Provides a Skytap network resource. Networks aren’t top-level elements of the Skytap API. They are elements properly contained within an environment. Operations on them are implicitly on the containing environment.

Example Usage

# Create a new network
resource "skytap_network" "network" {
  environment_id = "123456"
  name = "my network"
  domain = "domain.com"
  subnet = "1.2.3.4/16"
  gateway = "1.2.3.254"
  tunnelable = true
  timeouts {
    create = "20m"
    delete = "5m"
  }
}

Argument Reference

The following arguments are supported:

Attributes Reference

The following attributes are exported:

skytap_project

Provides a Skytap project A set of shared templates, environments, and assets. Users gain access to shared resources by becoming a member of a project. To learn more, see Sharing resources with projects. resource. Projects are an access permissions model used to share environments, templates, and assets with other users.

Example Usage

# Create a new project
resource "skytap_project" "project" {
  name = "Terraform Example"
  summary = "Skytap terraform provider example project."
  show_project_members = false
  auto_add_role_name = "participant"
  timeouts {
    create = "30s"
    delete = "10s"
  }
}

Argument Reference

The following arguments are supported:

Attributes Reference

The following attributes are exported:

skytap_icnr_tunnel

Provides an ICNR Tunnel. Inter-Configuration Network Routing connects networks from different environments to a single, shared server. Without ICNR, environments are on isolated networks. For more information, see Networking between environments.

Example Usage

resource "skytap_environment" "env1" {
  template_id = "123"
  name = "env1"
  description = "This is an environment example"
}

resource "skytap_environment" "env2" {
  template_id = "%s"
  name = "%s-environment-%d"
  description = "This is an environment example"
}

resource "skytap_network" "net1" {
  environment_id = "${skytap_environment.env1.id}"
  name = "net1"
  domain = "domain.com"
  subnet = "10.0.100.0/24"
  gateway = "10.0.100.254"
  tunnelable = true
}

resource "skytap_network" "net2" {
  environment_id = "${skytap_environment.env2.id}"
  name = "net2"
  domain = "domain.com"
  subnet = "10.0.200.0/24"
  gateway = "10.0.200.254"
  tunnelable = true
}

# Create an ICNR Tunnel between both networks.
resource "skytap_icnr_tunnel" "tunnel" {
  source = "${skytap_network.net1.id}"
  target = "${skytap_network.net2.id}"
  timeouts {
    create = "4m"
    delete = "40s"
  }
}

Argument Reference

The following arguments are supported:

Attributes Reference

The following attributes are exported:

skytap_label_category

Provides a Skytap label category resource. Label categories provide a taxonomy of the usa reporting, once the label category is define it can be use to label resources. There are restrictions for the use of labels for example:

An account can have a maximum of 100 active categories. An account can have a maximum combined total active and inactive (deleted) 200 categories. NOTE: Creating a label category fail when we reuse the name and change for label single value.

Example Usage

# Create a new label_category
resource "label_category" "env" {
  name = "environment"
  single_value = true
}

Argument Reference

The following arguments are supported:

Attributes Reference

The following attributes are exported: