Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 3.42 KB

zone.md

File metadata and controls

83 lines (60 loc) · 3.42 KB
Raw
page_title subcategory description
citrix_zone Resource - citrix
CVAD
Manages a zone.

citrix_zone (Resource)

Manages a zone.

Zone For Citrix Cloud Customers

  • For Citrix Cloud customers, Zones and Cloud Connectors are managed only by Citrix Cloud. Ensure you have a resource location created either manually or using citrix_cloud_resource_location in terraform. For more information regarding Citrix Cloud Resource Location click here.
  • Use resource_location_id instead of name to create a cloud zone resource via Terraform.
  • If the zone from the resource location specified in resource_location_id has description, please make sure that the description field matches the description of the existing zone.
  • If a zone is used for On-Premises Hypervisors, it is required to have cloud connectors deployed in it.
  • If a zone is used for MCS Domain Joined Machine Catalogs, it is required to have cloud connectors deployed in it.

Example Usage

# Example for On-Premises Zone
resource "citrix_zone" "example-onpremises-zone" {
    name                = "example-zone"
    description         = "zone example"
    metadata            = [
        {
            name    = "key1"
            value   = "value1"
        }
    ]
}

# Exmaple for Cloud Zone
resource "citrix_cloud_resource_location" "example-resource-location" {
    name = "example-resource-location"
}

resource "citrix_zone" "example-cloud-zone" {
    resource_location_id = citrix_cloud_resource_location.example-resource-location.id
}

Schema

Optional

  • description (String) Description of the zone.

-> Note For Citrix Cloud customer, ensure this matches the description of the existing zone behind the resource_location_id that needs to be used.

  • metadata (Attributes List) Metadata for the Zone.

~> Please Note Metadata once set cannot be removed. Use this field to add new metadata or update the value for an existing metadata. Subsequently, removing any metadata from config will have no effect on the existing metadata of the resource. (see below for nested schema)

  • name (String) Name of the zone.

-> Note For Citrix Cloud Customer, name is not allowed to be used for creating zone and is computed only. Use resource_location_id to create zone Instead.

  • resource_location_id (String) GUID identifier off the resource location the zone belongs to. Only applies to Citrix Cloud customers.

-> Note When using resource_location_id, ensure that the resource location is already created, or the value must be a reference to a citrix_cloud_resource_location's id property.

Read-Only

  • id (String) GUID identifier of the zone.

Nested Schema for metadata

Required:

  • name (String) Metadata name.
  • value (String) Metadata value.

Import

Import is supported using the following syntax:

# Zone can be imported by specifying the GUID
terraform import citrix_zone.example-zone 06e5981e-dbaf-48db-b134-245fca2dc672