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 Control Plane

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each tag on the target Cloud Control Plane

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 determine the customer ID that is mapped to the API client you created, refer to Determining the Customer ID Mapped to an 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 the Citrix Cloud Connectivity test with the full path to the secureclient.csv. Note: Before specifying the path of the secureclient.csv file, make sure that the API client is created and this file downloaded by a valid Citrix cloud user with Read-only administrator rights to virtual apps/desktops. To know how to create this user on the cloud, refer to theCreating a New Citrix Cloud User for Monitoring PurposestopicTo know how this user can create an API client on the cloud, refer to Creating API Client on the Citrix Cloud.
Proxy Host and Proxy Port	If the Citrix Cloud Connector communicates with the Citrix Cloud via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Citrix cloud without a glitch, and pull metrics. To facilitate this communication. do the following: Specify the IP address/fully-qualified host name of the proxy server, against PROXY HOST. Specify the port at which the Proxy server listens for requests from the eG agent, against PROXY PORT. By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy. Note: Before configuring these test parameters, make sure that the proxy server settings are imported to the eG agent side from the connector. To know how to achieve this, refer to Configuring the eG Agent with Proxy Server Settings. To know what values you should configure these parameters with, do the following: Login to the system hosting the Citrix Cloud Connector being monitored. Open the Internet Explorer browser on that system, and click on the icon provided at the right corner of that browser. Clicking the icon will invoke a menu. Choose Internet Optionsfrom the menu. Then, select the Connections tab in the Internet Options window that appears. Now, click the LAN Settings button. This will open the Local Area Network (LAN) Settings window. In the Proxy Server section of this window, you will find that the Use a proxy server for your LAN check box is enabled. Configure the PROXY HOST and PROXY PORT parameters with the IP address and port numbers displayed in the Address and Port text boxes (respectively) under that check box. If the Use a proxy server for your LAN check box is not enabled, then it means that the connector is not communicating with the cloud via a proxy. In this case, you need not change the default configuration for these parameters.
Region Endpoint	By default, US is chosen from this list indicating that this test will report metrics for those organizations whose users and resources are located in the United States region. Sometimes, the eG agent may collect the required metrics with a minor time delay due to the users and resources being monitored are in a different region. To avoid such time delays and to ensure end-user proximity and offer the best user experience, administrators are allowed to change the region based on where most of the users and resources are located. For instance, if the users and resources are located in the Asia-Pacific South region or approximately nearer to the Asia-Pacific South region, then, administrators need to choose 'AP-S' from this list. However, from this list, administrators are required to choose only the region that they had chosen when they signed in for the first time after onboarding their organization to the target Citrix Cloud.

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