Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,18 +241,19 @@ QuickCreate service allows customers to create and manage Amazon WorkSpaces Core

### What resource is supported for different connection types?

| Connection Type | Hypervisor | Resource Pool | MCS Power Managed | MCS Provisioning | PVS | Manual/Remote PC |
|-----------------------------------------|--------------------|--------------------|--------------------|--------------------|--------------------|----------------------|
| AzureRM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| AWS EC2 |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| GCP |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| vSphere |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| XenServer |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Nutanix |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| SCVMM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Red Hat OpenShift (**Techpreview**) |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| HPE Moonshot (**Techpreview**) |:heavy_check_mark: | N/A | :heavy_check_mark: | N/A | N/A | :heavy_check_mark: |
| Remote PC Wake On LAN (**Techpreview**) |:heavy_check_mark: | N/A | N/A | N/A | N/A | :heavy_check_mark: |
| Connection Type | Hypervisor | Resource Pool | MCS Power Managed | MCS Provisioning | PVS | Manual/Remote PC |
|--------------------------------------------|--------------------|--------------------|--------------------------|--------------------------|--------------------|----------------------------|
| AzureRM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| AWS EC2 |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Amazon WorkSpaces Core (**Techpreview**) |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| GCP |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| vSphere |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| XenServer |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Nutanix |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| SCVMM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Red Hat OpenShift (**Techpreview**) |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| HPE Moonshot (**Techpreview**) |:heavy_check_mark: | N/A | :heavy_check_mark: | N/A | N/A | :heavy_check_mark: |
| Remote PC Wake On LAN (**Techpreview**) |:heavy_check_mark: | N/A | N/A | N/A | N/A | :heavy_check_mark: |

### What URLs should be whitelisted in order to use the Citrix Terraform provider?
- URLs of the Citrix admin consoles: please visit [this documentation](https://docs.citrix.com/en-us/citrix-cloud/overview/requirements/internet-connectivity-requirements.html) for more information.
Expand Down
32 changes: 32 additions & 0 deletions docs/data-sources/autoscale_plugin_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "citrix_autoscale_plugin_template Data Source - citrix"
subcategory: "CVAD"
description: |-
Read data of an existing autoscale plugin template.
---

# citrix_autoscale_plugin_template (Data Source)

Read data of an existing autoscale plugin template.

## Example Usage

```terraform
data citrix_autoscale_plugin_template example_template {
name = "<template-name>"
type = "Holiday"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the autoscale plugin template.
- `type` (String) Type of the autoscale plugin template. Only template type `Holiday` is supported.

### Read-Only

- `dates` (Set of String) Date range for the autoscale holiday plugin template.
25 changes: 13 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,18 +85,19 @@ A service principal is an API client which is not associated with an email. It c

### What resource is supported for different connection types?

| Connection Type | Hypervisor | Resource Pool | MCS Power Managed | MCS Provisioning | PVS | Manual/Remote PC |
|-----------------------------------------|--------------------|--------------------|--------------------|--------------------|--------------------|----------------------|
| AzureRM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| AWS EC2 |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| GCP |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| vSphere |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| XenServer |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Nutanix |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| SCVMM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Red Hat OpenShift (**Techpreview**) |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| HPE Moonshot (**Techpreview**) |:heavy_check_mark: | N/A | :heavy_check_mark: | N/A | N/A | :heavy_check_mark: |
| Remote PC Wake On LAN (**Techpreview**) |:heavy_check_mark: | N/A | N/A | N/A | N/A | :heavy_check_mark: |
| Connection Type | Hypervisor | Resource Pool | MCS Power Managed | MCS Provisioning | PVS | Manual/Remote PC |
|--------------------------------------------|--------------------|--------------------|--------------------------|--------------------------|--------------------|----------------------------|
| AzureRM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| AWS EC2 |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Amazon WorkSpaces Core (**Techpreview**) |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| GCP |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| vSphere |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| XenServer |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Nutanix |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| SCVMM |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| Red Hat OpenShift (**Techpreview**) |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | N/A | :heavy_check_mark: |
| HPE Moonshot (**Techpreview**) |:heavy_check_mark: | N/A | :heavy_check_mark: | N/A | N/A | :heavy_check_mark: |
| Remote PC Wake On LAN (**Techpreview**) |:heavy_check_mark: | N/A | N/A | N/A | N/A | :heavy_check_mark: |

### What URLs should be whitelisted in order to use the Citrix Terraform provider?
- URLs of the Citrix admin consoles: please visit [this documentation](https://docs.citrix.com/en-us/citrix-cloud/overview/requirements/internet-connectivity-requirements.html) for more information.
Expand Down
70 changes: 70 additions & 0 deletions docs/resources/amazon_workspaces_core_hypervisor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "citrix_amazon_workspaces_core_hypervisor Resource - citrix"
subcategory: "CVAD"
description: |-
Manages an Amazon WorkSpaces Core hypervisor. Note that this feature is in Tech Preview.
---

# citrix_amazon_workspaces_core_hypervisor (Resource)

Manages an Amazon WorkSpaces Core hypervisor. Note that this feature is in Tech Preview.

## Example Usage

```terraform
# Amazon WorkSpaces Core Hypervisor
resource "citrix_amazon_workspaces_core_hypervisor" "example-amazon-workspaces-core-hypervisor-using-api-key" {
name = "example-amazon-workspaces-core-hypervisor"
zone = "<Zone Id>"
api_key = var.aws_account_access_key # AWS account Access Key from variable
secret_key = var.aws_account_secret_key # AWS account Secret Key from variable
region = "us-east-1"
}

resource "citrix_amazon_workspaces_core_hypervisor" "example-amazon-workspaces-core-hypervisor-using-role-based-auth" {
name = "example-amazon-workspaces-core-hypervisor"
zone = "<Zone Id>"
use_iam_role = true
region = "us-east-1"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the hypervisor.
- `region` (String) AWS region to connect to.
- `zone` (String) Id of the zone the hypervisor is associated with.

### Optional

- `api_key` (String) The API key used to authenticate with the AWS APIs.
- `metadata` (Attributes List) Metadata for the Hypervisor. (see [below for nested schema](#nestedatt--metadata))
- `scopes` (Set of String) The IDs of the scopes for the hypervisor to be a part of.
- `secret_key` (String, Sensitive) The secret key used to authenticate with the AWS APIs.
- `use_iam_role` (Boolean) When set to `true`, the provider will use the IAM role configured on the Citrix Cloud Connector or Delivery Controller instead of the `api_key` and `secret_key` for authentication. Omit this attribute if you want to use `api_key` and `secret_key` for authentication. Default value is `false`.

### Read-Only

- `id` (String) GUID identifier of the hypervisor.
- `tenants` (Set of String) A set of identifiers of tenants to associate with the hypervisor connection.

<a id="nestedatt--metadata"></a>
### Nested Schema for `metadata`

Required:

- `name` (String) Metadata name.
- `value` (String) Metadata value.

## Import

Import is supported using the following syntax:

```shell
# Amazon WorkSpaces Core Hypervisor can be imported by specifying the GUID
terraform import citrix_amazon_workspaces_core_hypervisor.example-amazon-workspaces-core-hypervisor b2339edf-7b00-436e-9c3a-54c987c3526e
```
65 changes: 65 additions & 0 deletions docs/resources/amazon_workspaces_core_hypervisor_resource_pool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "citrix_amazon_workspaces_core_hypervisor_resource_pool Resource - citrix"
subcategory: "CVAD"
description: |-
Manages an Amazon WorkSpaces Core hypervisor resource pool.
---

# citrix_amazon_workspaces_core_hypervisor_resource_pool (Resource)

Manages an Amazon WorkSpaces Core hypervisor resource pool.

## Example Usage

```terraform
resource "citrix_amazon_workspaces_core_hypervisor_resource_pool" "example-amazon-workspaces-core-hypervisor-resource-pool" {
name = "example-amazon-workspaces-core-hypervisor-resource-pool"
hypervisor = citrix_amazon_workspaces_core_hypervisor.example-amazon-workspaces-core-hypervisor.id
subnets = [
"10.0.1.0/24",
]
vpc = "<VPC name>"
availability_zone = "us-east-2a"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `availability_zone` (String) The name of the availability zone resource to use for provisioning operations in this resource pool.
- `hypervisor` (String) Id of the hypervisor for which the resource pool needs to be created.
- `name` (String) Name of the resource pool. Name should be unique across all hypervisors.
- `subnets` (List of String) Subnets to allocate VDAs within the virtual private cloud.
- `vpc` (String) Name of the virtual private cloud.

### Optional

- `metadata` (Attributes List) Metadata for the Hypervisor Resource Pool. (see [below for nested schema](#nestedatt--metadata))
- `vm_tagging` (Boolean) Indicates whether VMs created by provisioning operations should be tagged. Default is `true`.

### Read-Only

- `id` (String) GUID identifier of the resource pool.

<a id="nestedatt--metadata"></a>
### Nested Schema for `metadata`

Required:

- `name` (String) Metadata name.
- `value` (String) Metadata value.

## Import

Import is supported using the following syntax:

```shell
# Hypervisor Resource Pool can be imported with the format HypervisorId,HypervisorResourcePoolId
terraform import citrix_amazon_workspaces_core_hypervisor_resource_pool.example-amazon-workspaces-core-hypervisor-resource-pool sbf0dc45-5c42-45a0-a15d-a3df4ff5da8c,ce571dd9-1a46-4b85-891c-484423322c53

# Hypervisor Resource Pool can be imported by specifying the GUID
terraform import citrix_amazon_workspaces_core_hypervisor_resource_pool.example-amazon-workspaces-core-hypervisor-resource-pool ce571dd9-1a46-4b85-891c-484423322c53
```
45 changes: 45 additions & 0 deletions docs/resources/autoscale_plugin_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "citrix_autoscale_plugin_template Resource - citrix"
subcategory: "CVAD"
description: |-
Manages an autoscale plugin template.
---

# citrix_autoscale_plugin_template (Resource)

Manages an autoscale plugin template.

## Example Usage

```terraform
resource citrix_autoscale_plugin_template example-template {
name = "<template-name>"
type = "Holiday"
dates = [
"2025-12-25",
"2026-01-01"
]
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Name of the autoscale plugin template.
- `type` (String) Type of the autoscale plugin template. Only template type `Holiday` is supported.

### Optional

- `dates` (Set of String) Date range for the autoscale holiday plugin template.

## Import

Import is supported using the following syntax:

```shell
# Autoscale Plugin Template can be imported with the format TemplateType,TemplateName
terraform import citrix_autoscale_plugin_template.example-template "Holiday,MyTemplateName"
```
2 changes: 1 addition & 1 deletion docs/resources/aws_hypervisor_resource_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ resource "citrix_aws_hypervisor_resource_pool" "example-aws-hypervisor-resource-

### Optional

- `metadata` (Attributes List) Metadata for the Hypervosor Resource Pool. (see [below for nested schema](#nestedatt--metadata))
- `metadata` (Attributes List) Metadata for the Hypervisor Resource Pool. (see [below for nested schema](#nestedatt--metadata))
- `vm_tagging` (Boolean) Indicates whether VMs created by provisioning operations should be tagged. Default is `true`.

### Read-Only
Expand Down
19 changes: 19 additions & 0 deletions docs/resources/delivery_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,25 @@ resource "citrix_delivery_group" "example-delivery-group" {
}
]
color_depth = "TwentyFourBit"
autoscale_plugins = [
{
name ="plugin-1"
description = "test plugin"
priority = 10
enabled = true
dates = [
"2025-12-31",
"2025-12-25",
]
},
{
name ="plugin-2"
description = "test plugin 2"
priority = 20
enabled = true
dates = citrix_autoscale_plugin_template.example-template.dates # Alternatively, you can use data source. Eg. data.citrix_autoscale_plugin_template.example-template.dates
}
]
}
```

Expand Down
9 changes: 9 additions & 0 deletions docs/resources/image_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ resource "citrix_image_definition" "example_vsphere_image_definition" {
hypervisor = citrix_vsphere_hypervisor.example_vsphere_hypervisor.id
hypervisor_resource_pool = citrix_vsphere_hypervisor_resource_pool.example_vsphere_hypervisor_resource_pool.id
}

resource "citrix_image_definition" "example_workspaces_core_image_definition" {
name = "Example Amazon WorkSpaces Core Image Definition"
description = "Example Amazon WorkSpaces Core Image Definition Description"
os_type = "Windows"
session_support = "MultiSession"
hypervisor = citrix_amazon_workspaces_core_hypervisor.example-amazon-workspaces-core-hypervisor-using-api-key.id
hypervisor_resource_pool = citrix_amazon_workspaces_core_hypervisor_resource_pool.example-amazon-workspaces-core-hypervisor-resource-pool.id
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
Loading
Loading