Custom reporting tags can be added to your CWP instance either through the portal, through your config.json file, or through the API. All approaches allow you to sort and filter your CWP endpoints by the tag(s) you define.
Defining Custom Tags in the Portal
Please see this article to learn how to apply custom tags in the portal.
Defining Custom Tags in the Config.json File
You can also define arbitrary custom tags in your config.json file. This makes it easy to define a custom tag for a group of servers, without the need to add a tag for each device. To add a custom tag to your config.json file, you will need to:
- Add a trailing comma to the end of the last argument on your config.json file
- Add a new line below the comma
- Add a custom tag in the format "reporting_tags": { "example_custom_tag": "tag_value" }, where "example_custom_tag" is the name of the tag you want to define and "tag_value" is the value. Include quote marks around the tag name and value. Note that "reporting_tags" takes an object so be sure to include all custom tags within these curly braces. Multiple tags can be added within this object, delimited by commas.
- Save your config.json file and apply it to your servers
- Restart the CWP sensor using sudo systemctl restart cfsvcd
Example
Original config.json file
{
"access_token": "YOUR_TOKEN",
"subscription_plan": "Managed"
}
Config.json file with one custom tag
{
"access_token": "YOUR_TOKEN",
"subscription_plan": "Managed",
"reporting_tags": {
"example_custom_tag": "tag_value"
}
}
Config.json file with multiple custom tags
{
"access_token": "YOUR_TOKEN",
"subscription_plan": "Managed",
"reporting_tags": {
"example_custom_tag_1": "tag_value_1",
"example_custom_tag_2": "tag_value_2",
"example_custom_tag_3": "tag_value_3"
}
}
Note that tags are literal. If you mistype a tag name or value, the CWP portal will interpret exactly what you've typed and will create a new tag or edit an existing tag. Please ensure that you add exactly the tag and value you want in the config.json file to avoid errors.
If you have multiple tags to add, add each as its own line separated by a comma.
Defining Custom Tags with the API
Please see this article to learn how to apply custom tags with the API.
Viewing Custom Tags
You can view custom tags assigned to a server either on the Endpoints page in the Reporting Tags column or when viewing a specific endpoint under the User Defined Reporting Tags section.
Endpoints page
Specific endpoint view
Tag Searching/Filtering/Bulk Actions
You can search or take bulk actions against any custom reporting tag. To search by a reporting tag, use the same "example_custom_tag": "tag_value" formatting:
Once you have searched for the value, only those servers with the custom reporting tag will show. You can then take bulk actions on this group of servers.
Using Custom Tags in Automations
Custom reporting tags can also be used in automations to help you take specific actions based on a group or type of server. Once a custom reporting tag is defined, you can use it to filter down specific triggers by adding a condition.
