.header.md

vSphere Tags Terraform Module

This Terraform module either creates or imports a list of tags grouped in a tag category in your VMware Cloud on AWS or VMware vSphere on‑premises environment. You use these tags to label your inventory objects with metadata to make it easier to sort and search for these objects.

Tags and categories can span multiple vCenter Server instances. When you use Hybrid Linked Mode, tags and tag categories are maintained across your linked domain. So in this mode, the on‑premises and VMware Cloud on AWS software‑defined data centers (SDDCs) share tags and tag attributes. If multiple on‑premises vCenter Server instances are configured to use Enhanced Linked Mode, tags and categories are replicated across the vCenter Server instances.

Usage

Create new tags in a new tag category

module "vsphere_tags" {
  source  = "aws-ia/tags/vsphere"
  version = ">= 0.0.1"

  tag_category_name        = "example-category"
  tag_category_description = "Example tag category."
  tag_category_cardinality = "MULTIPLE"
  create_tag_category      = true
  create_tags              = true

  tags = {
    terraform = "Managed by Terraform"
    project   = "terraform-vsphere-tags"
  }
}

Create new tags in an existing tag category

module "vsphere_tags" {
  source  = "aws-ia/tags/vsphere"
  version = ">= 0.0.1"

  tag_category_name   = "example-category"
  create_tag_category = false
  create_tags         = true

  tags = {
    terraform = "Managed by Terraform"
    project   = "terraform-vsphere-tags"
  }
}

Import existing tags in an existing tag category

module "vsphere_tags" {
  source  = "aws-ia/tags/vsphere"
  version = ">= 0.0.1"

  tag_category_name   = "example-category"
  create_tag_category = false
  create_tags         = false

  tags = {
    terraform = "Managed by Terraform"
    project   = "terraform-vsphere-tags"
  }
}