Citrix ADC Provider

https://registry.terraform.io/providers/citrix/citrixadc/latest/docs
Admin
Citrix ADC Provider is a Terraform provider for configuring Citrix ADC instances using the NITRO API...
Tokens:1,551
Snippets:11
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Provider Configuration Examples

Source: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs

Examples demonstrating various ways to configure the Citrix ADC provider, from basic HTTP/HTTPS setups to advanced configurations involving proxying through NetScaler Console and targeting specific partitions or cloud services.

```APIDOC
## Provider Configuration Examples

### Simplest and least secure configuration
```terraform
provider "citrixadc" {
  endpoint = "http://10.0.0.1"
}
```

### Use https and non default password
```terraform
provider "citrixadc" {
  endpoint = "https://10.0.0.1"
  username = "nsroot"
  password = "secret"
  insecure_skip_verify = true
}
```

### Proxy calls through NetScaler Console
```terraform
provider "citrixadc" {
  endpoint   = "https://10.22.0.1"
  username   = "nsroot"
  password   = "admpassword"
  proxied_ns = "10.0.0.1"
}
```

### Target non default partition
```terraform
provider "citrixadc" {
  endpoint   = "https://10.0.0.1"
  username   = "nsroot"
  password   = "admpassword"
  do_login   = true
  partition  = "par1"
}
```

### Proxy calls through NetScaler Console Service (Cloud)
```terraform
provider "citrixadc" {
  endpoint   = "https://<<ADM_CLOUD_URL>>/"
  username   = "<<USERNAME>>"
  password   = ""
  proxied_ns = "<<NS_IP>>"
  is_cloud   = true
  do_login   = true
}
```
```

--------------------------------

### Argument Reference

Source: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs

Detailed explanation of the arguments supported by the Citrix ADC provider for configuration.

```APIDOC
## Argument Reference

### `endpoint`
- **Type**: Required
- **Description**: Defines the NITRO API endpoint prefix. Can use either `http` or `https` protocol.

### `username`
- **Type**: Required
- **Description**: Defines the username that will be used by the NITRO API for authentication. Can be sourced from the `NS_LOGIN` environment variable. Defaults to `nsroot`.

### `password`
- **Type**: Required
- **Description**: Defines the password that will be used by the NITRO API for authentication. Can be sourced from the `NS_PASSWORD` environment variable. Defaults to `nsroot`.

### `insecure_skip_verify`
- **Type**: Optional
- **Description**: Boolean variable that defines if an error should be thrown if the target ADC's TLS certificate is not trusted. When `true` the error will be ignored. When `false` such an error will cause the failure of any provider operation. Defaults to `false`.

### `proxied_ns`
- **Type**: Optional
- **Description**: When defined use NetScaler Console as a proxy for the NITRO API calls. All credentials refer to the NetScaler Console. The value of this attribute is the target ADC's ip address. Can be sourced from the `_MPS_API_PROXY_MANAGED_INSTANCE_IP` environment variable.

### `do_login`
- **Type**: Optional
- **Description**: When set to `true` the NITRO client will perform the login operation and acquire a session token which will be used for all subsequent operations. This is required when targeting a non default admin partition.

### `is_cloud`
- **Type**: Optional
- **Description**: Boolean variable that defines whether NetScaler Console Service is used for proxied calls. When `true`, `username`, `password` and `endpoint` must refer to the Console Service. Defaults to `false`.

### `partition`
- **Type**: Optional
- **Description**: Partition to target. All resources utilizing this provider instance will reside on the target admin partition.
```

--------------------------------

### Target Non-Default Partition with Citrix ADC Provider

Source: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs

Configure the provider to target a non-default admin partition on the Citrix ADC. Set `do_login` to `true` to establish a session for the specified partition.

```terraform
provider "citrixadc" {
  endpoint   = "https://10.0.0.1"
  username   = "nsroot"
  password   = "admpassword"
  do_login   = true
  partition  = "par1"
}
```

--------------------------------

### Configure Citrix ADC Provider

Source: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs

Use this snippet to configure the Citrix ADC provider. It supports HTTP or HTTPS endpoints, with options for username, password, and skipping TLS certificate verification. Avoid hardcoding credentials in production environments.

```terraform
provider "citrixadc" {
  endpoint = "http://10.0.0.1"
}
```

```terraform
provider "citrixadc" {
  endpoint = "https://10.0.0.1"
  username = "nsroot"
  password = "secret"

  insecure_skip_verify = true
}
```

--------------------------------

### Proxy Citrix ADC Calls via NetScaler Console Cloud

Source: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs

Configure the provider for proxied calls through NetScaler Console Cloud. Use your NetScaler Console Cloud URL for the endpoint, API Client ID for username, and API Client Secret for password. Set `is_cloud` to `true` and `do_login` to `true`.

```terraform
provider "citrixadc" {
  endpoint   = "https://<<ADM_CLOUD_URL>>/"
  username   = "<<USERNAME>>"
  password   = ""
  proxied_ns = "<<NS_IP>>"
  is_cloud   = true
  do_login   = true
}
```

--------------------------------

### Proxy Citrix ADC Calls via NetScaler Console

Source: https://registry.terraform.io/providers/citrix/citrixadc/latest/docs

Configure the provider to proxy NITRO API calls through NetScaler Console. Credentials should refer to NetScaler Console, and the `proxied_ns` attribute specifies the target ADC's IP address.

```terraform
provider "citrixadc" {
  endpoint   = "https://10.22.0.1"
  username   = "nsroot"
  password   = "admpassword"
  proxied_ns = "10.0.0.1"
}
```
Tokens:
Raw