Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0
View PDF

Create an application definition

December 31, 2023
Contributed by: 
C

You can define a custom application based on a collection of discovered applications in Citrix ADM.

In Citrix ADM, when you navigate to Application Dashboard, the Application Overview page displays default applications. These default applications or “discrete applications” are the 30 applications for which you have the default licenses. You discover these applications when you install Citrix ADM in your business environment.

As you create “custom applications,” the custom applications replace the discrete applications. The custom applications are arranged on the dashboard according to the category you have chosen while creating them.

You can view these applications, both discovered and custom, in two ways - tree map and tiles.

App definition

You can create a custom application through either a static or dynamic configuration.

  1. Static Definition of Applications - In a static definition, you can define an application. This definition does not get updated when new virtual servers are configured on your Citrix ADC instance. You must manually update this list to include more virtual servers.

  2. Dynamic Definition of Applications - In a dynamic definition, you can use one of the following three criteria listed to define an application:

    1. Servers. Specify the server or service IP address, server name, or the port of the back end server on which the applications are running. You can enter one IP address, a range of IP addresses, or a combination of both separated by commas. For example, you can enter 10.102.29.20, 10.102.43.10-60, 10.216.43.45.

    2. Virtual Servers. You can specify either one of the following:

      1. Virtual server IP address

      2. Virtual server name, or

      3. Port of the back end server on which the applications are running.

    You can enter one IP address or a range of IP addresses or a combination of both separated by commas. For example, you can enter 10.102.29.20, 10.102.43.10-60, 10.216.43.45.

  3. StyleBooks. You can create custom applications by using either a default or custom StyleBook that is already present in the Citrix ADM. StyleBooks simplify the task of managing complex Citrix ADC configurations for your applications. Select a StyleBook that is present in Citrix ADM and type in the StyleBook parameter values Citrix ADM creates the configuration pack on the target Citrix ADC instances based on the selected StyleBook. Citrix ADM also creates a custom application that includes all the virtual servers defined in the configuration pack.

Note

A custom application and ConfigPack are created if sufficient Citrix ADC licenses are available.

When you create an application that meets these conditions defined above in one of the three criteria, the application gets updated in the Application Dashboard automatically when Citrix ADM polls the entities. To initiate a poll manually, click Poll Now located in the Applications tab.

To create an application

  1. In Citrix ADM, navigate to Applications > dashboard and click Define Custom App to create a custom application.

  2. In the Define Application window, type the name of the application in the Name field.

  3. Select the application category from the Category section. Citrix ADM allows you to define categories to group the user-defined applications. You can also add more categories if necessary.

  4. You can create a custom application in one of the following three methods:

    1. Select Existing Applications. To select existing applications, ensure that Select Existing Applications is enabled. Choose the application from the list in the Applications section. Click Add Applications to add new applications to the list.

    2. Define Selection Criteria. You can also define a selection criterion to add applications in Citrix ADM. You can add apps in one of the following three methods:

      1. Specifying the IP address of the virtual server. You can enter one IP address or a range of IP addresses or a combination of both separated by commas.

      2. Specifying the name of the server on which the applications or services are running.

        Note

        You can also search for server names by using wildcard extensions. For example, ssl* will add all SSL virtual servers to the application.

      3. Specifying the port number at which the application is listening to on the selected server.

    3. Create a new application from StyleBook. Select the required StyleBook in Citrix ADM to create ConfigPacks on the Citrix ADC instances and associate the virtual servers with a custom application.

      New application

  5. Click OK. If you have opted to create applications from StyleBooks, the Choose StyleBook page opens. This page contains a list of all StyleBooks present in Citrix ADM.

    Choose StyleBooks

  6. Select the StyleBook. The StyleBook opens as a user interface form. Type the values for all parameters in the StyleBook. You can also click View Definition to view the construct of the StyleBook before using it. For more information on how to use custom or default StyleBooks, see Use default StyleBooks.

  7. A custom application and the ConfigPack are now created on the Citrix ADC instances that you have selected in the target section in the StyleBook

    Note

    A custom application and ConfigPack are created if sufficient Citrix ADM licenses are available.

Migrate the application configuration to a different StyleBook

If you want to migrate an application configuration from the existing StyleBook to another StyleBook, perform the following steps:

  1. Select the application.

  2. On the App Info Panel tab, click the edit icon.

    The Configure Application page appears.

  3. In the Config Pack Details section, click Migrate Configuration.

    Migrate application configuration from StyleBook-StyleBook

  4. Select the StyleBook to which you want to migrate.

  5. Click Migrate.

For more information, see Migrate ConfigPack of a StyleBook to another StyleBook.

To auto-select virtual servers for licensing

You must allow Citrix ADM to auto select the virtual servers for licensing when you use the StyleBook option to create configurations. If you have not enabled auto-select, you might get an error message:

Auto select

To enable auto-selection of virtual servers:

  1. In Citrix ADM, navigate to Networks > Licenses > System Licenses.

  2. Click Auto-select Virtual Servers to enable the option in Licensed Virtual Servers section.

    Licensing

When enabled, Citrix ADM automatically selects the virtual servers to license. And when it is not enabled, you must explicitly select the virtual servers.

To View Application Details in Citrix ADM

Citrix ADM displays all details of an application in a separate pane at the rightmost side known as App Info Panel.

To view the App Info Panel:

  1. In Citrix ADM, navigate to Application > Dashboard.

  2. In the Application Overview section, click the application for which you want to see the details.

    App details

The entities that are bound to the application that you have selected are arranged vertically in the App Info Panel pane. Vertically arranged boxes in the pane display the following:

  • name of each entity

  • the number of entities that are active

  • entities that are inactive

  • entities that are out of service

The entities that are displayed here are the virtual servers, services, service groups, and the application servers. The pane also displays other data like App Score, data volume, throughput, both server and client connections, and the transactions that happen in each application.

You can view the count of virtual servers, services, service groups that are in different states for each application. You can click the name of the entity or the displayed count to directly enable or disable the entities. You can also enable or disable other bound entities such as virtual servers, services, and service groups.

For more information on how to configure load balancing servers, see Create Load Balancing Support through Application Dashboard.

Create an application definition
December 31, 2023
Contributed by: 
C
December 31, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.