Bandwidth Usage Test

Bandwidth is a measure of the total data transfer activity on a Citrix Content Collaboration account. Every time a file is uploaded or downloaded using the Citrix Content Collaboration account, bandwidth is used. Bandwidth is recorded on the account for any downloads, both complete or incomplete. Uploads count toward the bandwidth if they have been completed. If the bandwidth limit exceeds, then, a small overage fee is levied to download/upload data. To proactively identify the bandwidth consumed by the Citrix Content Collaboration account and plan the billing based on bandwidth utilization, administrators can use the Bandwidth Usage test.

This test tracks the average bandwidth consumed on the target Citrix Content Collaboration account. Using this test, administrators can figure out bandwidth consumption patterns and identify sudden surges, if any. This test also helps administrators plan their bandwidth utilization and purchase additional bandwidth, as and when required.

Target of the test : Citrix Content Collaboration

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the monitored Citrix Content Collaboration account

Configurable parameters for the test
Parameters Description

Test period

How often should the test be executed


The host for which the test is to be configured.


The port at which the Host listens. By default, this is NULL.

Email ID

Provide the email ID of the Citrix Content Collaboration user with ‘Admin’ access to Citrix Content Collaboration. The credentials of this user are necessary for connecting to the Citrix Content Collaboration REST API, running API commands, and pulling out metrics.


Specify the password associated with the configured Email ID.

Confirm Password

Confirm the Password by retyping it here.


  • Indicate whether/not Content Collaboration is SSL-enabled. By default, this flag is set to Yes.
  • Proxy Host, Proxy Port, Proxy User Name, Proxy Password and Confirm Password

    These parameters are applicable only if the eG agent needs to communicate with the Citrix Content Collaboration portal via a Proxy server.

    In this case, provide the IP/host name and port number of the Proxy server that the eG agent should use in the Proxy Host and Proxy Port parameters, respectively.

    If the Proxy server requires authentication, then specify the credentials of a valid Proxy user against the Proxy User Name and Proxy Password text boxes. Confirm that password by retyping it in the Confirm Password text box. If the Proxy server does not require authentication, then specify none against the Proxy User Name, Proxy Password, and Confirm Password text boxes.

    On the other hand, if the eG agent is not behind a Proxy server, then you need not disturb the default setting of any of the Proxy-related parameters. By default, these parameters are set to none.

    Detailed Diagnosis

    To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enabled/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

    • The eG manager license should allow the detailed diagnosis capability
    • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
    Measurements made by the test
    Measurement Description Measurement Unit Interpretation

    Average bandwidth consumed

    Indicates the average bandwidth consumed by the Citrix Content Collaboration account.


    If the monthly bandwidth allocated is exceeded, a small overage fee is charged to cover the amount of bandwidth used. When 80% of the allocated bandwidth limit is used for the month, a notification email is sent to the billing contact on the targegt Citrix Content Collaboration account warning that the bandwidth limit is fast approaching. Another notification is sent when 100% of the account’s bandwidth limit is reached. If the bandwidth limit is exceeded for the month, the account will continue to function and employees/clients will still be able to upload/download files without interruption. At the end of the month, the bandwidth overage will be totaled and administrators will be charged a per megabyte usage fee. Please note that the fee is dependent on the plan level opted for the account. Additional bandwidth can also be purchased on the plan, which is more cost-effective than the overage fee.

    The detailed diagnosis of this measure lists the name of the users who have consumed maximum bandwidth.