Citrix Application Delivery Management service

Configure IP address management (IPAM)

Citrix ADM IPAM provides you an ability to auto-assign and release IP addresses in Citrix ADM managed configurations. You can assign IPs from networks or IP ranges defined using the following IP providers:

  • Citrix ADM built-in IPAM provider.
  • Infoblox IPAM solution. For more information, see Infoblox DDI.

Currently, you can use Citrix ADM IPAM in:

  • StyleBooks: Auto-Allocate IPs to virtual servers when you create configurations.
  • Kubernetes Ingress: Auto-assign a virtual IP address to an Ingress configuration in a Kubernetes cluster.
  • API gateway: Auto-allocate an IP address to the API proxy.

You can also track the allocated and available IP addresses in each network or IP range managed by Citrix ADM.

Add an external IP address provider

Citrix ADM has a built-in IPAM provider to manage IPs and IP ranges. You can also add an external IP address provider to Citrix ADM.


Before you begin, ensure that the following permissions are enabled in the external IP address provider:

  • Ability to query networks that are present in the provider.
  • Register a new network.
  • Unregister an existing network.
  • Reserve an IP address in the network.
  • Free an IP address from the network.
  • Retrieve the used IP addresses from a network.
  • Retrieve available IP addresses from a network.

Perform the following steps to add an external IP provider solution in Citrix ADM:

  1. Navigate to Settings > IPAM.

  2. In Providers, click Add.

  3. Specify the following details to add an IP provider:

    • Name - Specify the IP provider name to use in Citrix ADM.

    • Vendor - Select an IPAM vendor from the list.

    • URL - Specify the URL of the IPAM solution that assigns IP addresses in an Citrix ADM environment. Ensure to specify the URL in the following format:

       https://<host name>


    • User Name - Specify the user name to log in to the IPAM solution.

    • Password - Specify the password to log in to the IPAM solution.

  4. Click Add.

Add a network

Add a network to use IPAM with Citrix ADM managed configurations.

  1. Navigate to Settings > IPAM.

  2. Under Networks*, click **Add.

  3. Specify the following details:

    • Network Name - Specify the network name to identify the network in Citrix ADM.

    • Provider - Select the provider from the list.

      This list displays the providers added in Citrix ADM.

    • Network Type - Select IP range or CIDR from the list based on your requirement.

    • Network Value - Specify the network value.


      Citrix ADM IPAM supports only IPv4 addresses.

      For IP range, specify the network value in the following format:



      For CIDR, specify the network value in the following format:


  4. Click Create.

View allocated IP addresses

To view more details about allocated IP addresses from the IPAM network, do the following steps:

  1. Navigate to Settings > IPAM.

  2. Under the Networks tab, click View All Allocated IPs.

    View allocated IPs

    This pane displays IP address, provider name, provider vendor, and description. It also displays the resource details that reserved this IP address:

    • Module: Displays the Citrix ADM module that reserved the IP address. For example, if StyleBooks reserved the IP address, this column displays StyleBooks as the module.

    • Resource Type: Displays the resource type in that module. For the StyleBooks module, only the configurations resource type uses the IPAM network. So, it displays Configurations under this column.

    • Resource ID: Displays the exact resource id with a link. Click this link to access the resource that is using the IP address. For the configuration resource type, it displays the configuration pack ID as the resource ID.


If you want to release the IP address, select the IP address that you want to release and click Release Allocated IPs.

Configure IP address management (IPAM)