Content Library Item¶

Type: vsphere-content-library-item Artifact BuilderId: vsphere.content-library-item

This data source retrieves information about an existing item in a content library from vSphere and returns the name, unique identifier, library, type, and content library path for an item that matches all specified filters.

The path output is returned in the <library>/<item>/<file> form used by the iso_paths option of the vsphere-iso builder, so an ISO stored in a content library can be selected dynamically and attached at build time.

Configuration Reference¶

Filters Configuration¶

Required:

• content_library (string) - Name of the content library to search for items. This filter is required.

Optional:

• name (string) - Basic filter with glob support on the item name (e.g. linux-debian-13*-amd64 or linux-debian-13). Defaults to *.

• name_regex (string) - Extended name filter with regular expression support matched against the item name (e.g. ^linux-debian-13\.[0-9]+\.[0-9]+-amd64$). Default is empty. The match is checked by substring. Use ^ and $ to define a full string. The expression must use Go Regex Syntax.

• type (string) - Filter to return only items of the specified type. One of iso, ovf, or vm-template. Default is empty and returns items of any type.

• tag ([]Tag) - Filter to return only items that have all specified tags attached.

• latest (bool) - This filter determines how to handle multiple items that were matched with all previous filters. The item last modified time is used to find the latest. By default, multiple matching items results in an error.

Tags Filter Configuration¶

Tag identifies a vSphere tag by name and category for datasource filters. Specify one or more tag blocks; every listed tag must be attached.

    tag {
      category = "environment"
      name     = "production"
    }

Required:

• name (string) - Name of the tag that must be attached to the object.

• category (string) - Name of the tag category that contains the tag.

  Note

  Both name and category must be specified in the tag filter.

Connection Configuration¶

Optional:

• vcenter_server (string) - The fully qualified domain name or IP address of the vCenter instance.
• username (string) - The username to authenticate with the vCenter instance.
• password (string) - The password to authenticate with the vCenter instance.

• insecure_connection (bool) - Do not validate the certificate of the vCenter instance. Defaults to false.

  Note

  This option is beneficial in scenarios where the certificate is self-signed or does not meet standard validation criteria.

• datacenter (string) - The name of the datacenter object in the vSphere inventory.

  Note

  Required if more than one datacenter object exists in the vSphere inventory.

Output¶

• name (string) - Name of the found content library item.
• id (string) - Unique identifier of the found content library item.
• library (string) - Name of the content library that contains the item.

• type (string) - Type of the found content library item. One of iso, ovf, or vm-template.

• path (string) - Content library path of the found item.

  • For iso items, the path is returned in the <library>/<item>/<file> form used by the builder iso_paths option.
  • For ovf and vm-template items, the path is returned in the <library>/<item> form.

Example Usage¶

Select an ISO for the vsphere-iso Builder¶

data "vsphere-content-library-item" "iso" {
  vcenter_server  = "vc01.example.com"
  username        = "administrator@vsphere.local"
  password        = "VMware1!"
  datacenter      = "dc-01"
  content_library = "lib01"
  name            = "linux-debian-13*-amd64"
  type            = "iso"
  latest          = true
}

source "vsphere-iso" "example" {
  iso_paths = [data.vsphere-content-library-item.iso.path]
  # ...
}

Filter by Tags¶

data "vsphere-content-library-item" "iso" {
  vcenter_server  = "vc01.example.com"
  username        = "administrator@vsphere.local"
  password        = "VMware1!"
  datacenter      = "dc-01"
  content_library = "lib01"
  name            = "linux-debian-13*-amd64"
  type            = "iso"
  tag {
    category = "environment"
    name     = "production"
  }
}

locals {
  content_library_item = data.vsphere-content-library-item.iso.name
}

Select an Item by Regular Expression¶

data "vsphere-content-library-item" "iso" {
  vcenter_server  = "vc01.example.com"
  username        = "administrator@vsphere.local"
  password        = "VMware1!"
  datacenter      = "dc-01"
  content_library = "lib01"
  name_regex      = "^linux-debian-13\\.[0-9]+\\.[0-9]+-amd64$"
  type            = "iso"
  latest          = true
}

locals {
  content_library_item = data.vsphere-content-library-item.iso.name
}