Tag Usage - Cloud Test

Tags are strings that identify items such as machines, applications, desktops, Delivery Groups, Application Groups, and policies. After creating a tag and adding it to an item, administrators can tailor certain operations to apply to only items that have a specified tag. Additionally, administrators can configure tag restrictions while creating or editing desktops in Delivery Groups, and creating and editing Application Groups. The tag restriction feature provides greater flexibility and allows administrators to use the existing machines for more than one publishing task, saving the costs associated with deployment and managing additional machines. Furthermore, the tags applied on the items help administrators to define and fine-tune the policies and usage restrictions for the items. Sometimes, administrators may wish to review the utilization of the tags and tag restrictions in the environment. For this purpose, administrators can use the Tag Usage - Cloud test!

This test auto-discovers the tags and tag restrictions, and reveals the count of Application Groups, Desktop Groups, machines and applications that are tagged. In addition, this test also reports the number of objects, unknown objects, reboot schedules and Entitlement policy rules with tag restrictions. This way, administrators can easily identify the count of the items that are tagged or tag restricted in the environment.

Target of the test : A Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each tag on the target Cloud Delivery Controller.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The IP address of the host for which this test is to be configured.

Port

Refers to the port at which the specified host listens to.

Customer ID

When configuring the Citrix Cloud service, you should have created an API client on the cloud, so that any external program can communicate with the cloud. This API client is tied to a customer ID. The Citrix Cloud API requires this customer ID, when calling REST APIs. To get the customer ID for the API client that you have created in your environment, do the following:

  • Sign in to the Citrix Cloud administrator console.
  • Click the “hamburger menu” in the upper left corner of the console.
  • Select “Identity and Access Management” from the drop-down menu. An API Access page (see Figure 1 ) will open in the right panel. Look for the phrase , "use <customerID> as the customer parameter" in the right panel. The <customerID> displayed within that phrase (as highlighted in Figure 1) is the customer ID you need to configure the eG tests with.

    Figure 1 : Customer ID mapped to the API client

Secure Client File Path

When creating the API client on the cloud, you will be provided with an ID and a Secret for your client. Downloading this information saves a file named secureclient.csv. The eG agent uses the ID and Secret stored in this file to connect to the Citrix Cloud API. This is why, you will have to configure this test with the full path to the secureclient.csv.here.

Proxy Host, Proxy Port, Proxy User Name, Proxy Password, and Proxy SSL

These parameters are applicable only if the Citrix Cloud Connector communicates with the Citrix Cloud via a Proxy server.

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.

By default, the Proxy SSL flag is set to No. If the specified proxy server is SSL-enabled, then set the Proxy SSL flag to Yes

On the other hand, if the Citrix Cloud Connector is not using a Proxy server to communicate with the Citrix Cloud, then you need not disturb the default setting of any of the Proxy-related parameters. By default, these parameters are set to none.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

Desktop groups with tags

Indicates the number of desktop groups that are tagged with this tag.

Number

 

Machines with tags

Indicates the number of machines that are tagged with this tag.

Number

 

Application groups with tags

Indicates the number of application groups that are tagged with this tag.

Number

 

Applications with tags

Indicates the number of applications to which this tag is applied.

Number

 

Total objects with tags

Indicates the total number of objects that are tagged with this tag.

Number

 

Unknown objects with tags

Indicates the number of unknown objects that are tagged with this tag.

Number

If a tag is applied to an object, but that object would not be visible to the calling delegated administrator via the corresponding Get-Broker* cmdlet, then the object is not counted as an object of that type, but is instead reported as an 'unknown' object.

Applications with tag restriction

Indicates the number of applications that have this tag restriction.

Number

An application group can be restricted to a single set of tagged machines. Once a tag restriction has been defined for an application group, applications within the group will only be hosted by machines with the tag. This helps administrators in managing the application launches

Entitlement policy rules with tag restriction

Indicates the number of Entitlement policy rules that are restricted with this tag.

Number

A tag may be used to restrict which machines may be made accessible to a user by an entitlement policy rule. A machine may be made accessible by an entitlement policy rule only if either the rule has no tag restriction or the rule has a tag restriction and the machine is tagged with the same tag.

Total objects with tag restriction

Indicates the total number of objects that have this tag restriction.

Number

 

Reboot schedules with tag restriction

Indicates the number of reboot schedules that have this tag restriction.

Number

A restart schedule specifies when machines in a Delivery Group are periodically restarted. You can create one or more schedules for a Delivery Group. The machines are identified by a tag that you apply to the machine. This is called a tag restriction, because the tag restricts an action to only items (in this case, machines) that have the tag.

For example, let’s say all of your machines are in one Delivery Group. You want every machine restarted once every week, and you want the machines used by the accounting team restarted daily. To accomplish this, set up one schedule for all machines, and another schedule for only the machines in accounting.

Unknown objects with tag restriction

Indicates the number of Unknown objects that have this tag restriction.

Number