# Citrix Director

## Connection Requirements

{% stepper %}
{% step %}

### IP

IP address of the Citrix Director.
{% endstep %}

{% step %}

### Port

Port number (optional, default: 443).
{% endstep %}

{% step %}

### Client ID & Secret

If your instance is cloud, you need to enter client id & secret values while leaving username & password fields blank.

You need to create a service principal with Citrix Virtual Apps and Desktop administrator with read-only privileges.

To create Service Principal:

* In the Citrix Cloud console, click the menu in the upper left corner.
* Select Identity and Access Management > API Access > Service principals > Create service principal and follow the steps to completion. If these options do not appear, you might not have sufficient permissions to manage service principals. Contact your administrator to get the required full access permission.
* Enter values in the fields.
* Add the credentials to your secret management tool as the secret will only appear once.
  {% endstep %}

{% step %}

### Citrix Cloud Customer ID

Customer ID of the Citrix Cloud client.

To obtain Customer ID:

* In the left sidebar, go to Identity & Access Management.
* Then open the tab API Access.
* Under Secure Clients, click on your registered service principal (client).
* Inside the details window, you will see customer id.
  {% endstep %}

{% step %}

### Citrix Username & Password

Credentials for the on-prem setup of Citrix Director.
{% endstep %}

{% step %}

### Is Secure?

Choose if the API communication will be going through HTTPS or not. (default: HTTPS)
{% endstep %}

{% step %}

### Timeout

Amount of time to be waited for API response (default: 30)
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
⚠️ Attention

Please perform a **connection test** to ensure there is a valid connection to the host.\
When the discovery operation is finalized, you will be able to see the details on the **Assets** page.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.octoxlabs.com/adapters/adapters/citrix-director.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.