Integrating NetScaler Control Center with Citrix CloudPlatform helps streamline management of NetScaler devices. After this integration, Citrix CloudPlatform communicates with NetScaler Control Center using REST APIs over HTTPS. A single instance of NetScaler Control Center is configured for an entire Citrix CloudPlatform deployment.

Roles and Privileges

You must require administrator privileges on NetScaler Control Center and on Citrix CloudPlatform to perform the integration tasks described in this blog post.

Prerequisites

Ensure the following before you integrate NetScaler Control Center with Citrix CloudPlatform:

  • Provision and Configure NetScaler Control Center Appliance on a Host
    A NetScaler Control Center administrator can do this task. For more information, refer to the NetScaler Control Center documentation.
  • Access NetScaler Control Center and Citrix CloudPlatform
    For convenience, you can access NetScaler Control Center and Citrix CloudPlatform in two adjacent tabs of your web browser and logon to them simultaneously.
    Note: The procedures described in this blog post assume that you are accessing active sessions of NetScaler Control Center and Citrix CloudPlatform.
    • Typical URL for NetScaler Control Center: http://<IP-address-of-NetScaler Control Center>/admin_ui/cc/html/index.html?
    • Typical URL for Citrix CloudPlatform:  http://<IP-address-of-Management-Server>:8080/client/
  • Generate API Key and Secret Key in Citrix CloudPlatform
    Generate API and Secret keys associated with your Citrix CloudPlatform account that has administrator privileges. You must provide these keys in NetScaler Control Center.
  1. In the Citrix CloudPlatform UI, in the left navigation bar, click Accounts.
  2. In the right-side panel, click the name of your account.
  3. Under Details, click the View Users link.
  4. In the table that displays the details of your account, click your user name that appears in the Username column.
  5. Under Details, click the Generate Keys icon to generate new API and Secret keys. You can save them in a notepad.

Integrate NetScaler Control Center with Citrix CloudPlatform

Perform the following tasks in the following order:

  • Task 1: Register Citrix CloudPlatform in NetScaler Control Center
  • Task 2: Register NetScaler Control Center in Citrix CloudPlatform
  • Task 3: Enable NetScaler as Network Service Provider in Citrix CloudPlatform

Integration Task Flow

NCC-CCP-taskflow-final

Task 1: Register Citrix CloudPlatform in NetScaler Control Center

To communicate with Citrix CloudPlatform, NetScaler Control Center uses API and Secret keys of CloudPlatform. To communicate with NetScaler Control Center, Citrix CloudPlatform uses the administrator account credentials that you configure in NetScaler Control Center.

  1. In NetScaler Control Center, in the page that displays a message to select a cloud platform, select Citrix CloudPlatform and click OK.choose_CCP
  2. In the Configure Citrix CloudPlatform Settings page, enter the following details and click OK:
    Field Description
    Citrix CloudPlatform Details
    Citrix CloudPlatform Management Server IP Address Enter the IP address of the Citrix CloudPlatform Management Server.
    HTTPS or HTTP Select the protocol that your Citrix CloudPlatform Management Server uses.
    Citrix CloudPlatform API Key Enter the API Key associated with the Citrix CloudPlatform administrator account.
    Citrix CloudPlatform Secret Key Enter the Secret Key associated with the Citrix CloudPlatform administrator account.
    Control Center Credentials Used by Citrix CloudPlatform
    Username Enter the user name for the administrator account that Citrix CloudPlatform will use to communicate with NetScaler Control Center.
    Password Enter the password for the administrator account that Citrix CloudPlatform will use to communicate with NetScaler Control Center.
    Confirm Password Enter the password again to confirm it.

    configure_CCP

Task 2: Register NetScaler Control Center in Citrix CloudPlatform

In this task, you must register NetScaler Control Center with a region in Citrix CloudPlatform.

  1. In the Citrix CloudPlatform UI, in the left navigation bar, click Regions.
  2. In the right-side panel, click the name of the region where you want to integrate NetScaler Control Center.
  3. Under Details, click the View NCC link.
  4. Click Register NCC.
  5. In the Register NCC dialog box, enter the following details and click OK:
    Field Description
    IP Address Enter the IP address of the NetScaler Control Center server.
    Username Enter the user name to access NetScaler Control Center. This is the user name specified for the account created for Citrix CloudPlatform in NetScaler Control Center.
    Password Enter the password to access NetScaler Control Center. This is the password specified for the account created for Citrix CloudPlatform in NetScaler Control Center.
    Number of Retries
    Number of attempts that Citrix CloudPlatform makes if a command that it runs on NetScaler Control Center fails.

    By default, this field displays the value 2. Citrix CloudPlatform should not attempt to run a command on NetScaler Control Center more than five times.

    register_NCC

Task 3: Enable NetScaler as Network Service Provider in Citrix CloudPlatform

You must enable NetScaler as the network service provider in a zone that is available in the region.

  1. In the Citrix CloudPlatform UI, in the left navigation bar, click Infrastructure.
  2. On the right-side panel, in the Zones tile, click View all.
  3. In the page that lists zones, in the Zone column, click the name of the zone that you want to associate with the NetScaler device.
  4. Click the Physical Network tab.
  5. In the table that lists the physical networks, click the name of the physical network where you want to enable NetScaler as network service provider.
  6. In the Network Service Providers node of the diagram, click Configure.
  7. In the table that lists network service providers, click NetScaler.
  8. In the Details page, click the Enable Provider icon.

Now, you have successfully integrated NetScaler Control Center with Citrix CloudPlatform.

In NetScaler Control Center, you can add NetScaler devices, associate the Citrix CloudPlatform zone where you have enabled NetScaler as network service provider to them, create service packages and assign devices to them, and publish these service packages in CloudPlatform. In Citrix CloudPlatform, you can use these service packages to create network offerings. Then, use these network offerings to create guest networks. The load balancer rules that you create on the guest networks will be communicated to NetScaler Control Center, which will transfer these rules to the NetScaler devices.