Apply or Remove an Agent Blackout by Agent Type Using fglcmd (4311039)

This article describes how to apply or remove a blackout schedule for one or more agents based on their agent type using the fglcmd command-line utility.

This method is useful when a blackout must be applied to all agents of a specific type (for example, all DB_SQL_Server agents) without manually selecting each agent in the Foglight UI.

Administrators may need to apply or remove blackout schedules for a large number of agents simultaneously during planned maintenance activities, application deployments, infrastructure changes, or troubleshooting events. Using the fglcmd utility allows a blackout schedule to be assigned or removed for all agents of a specific type without manually updating each agent through the Foglight UI.

Common use cases include:

• Applying a blackout during scheduled maintenance windows.
• Suppressing alarms and notifications during planned outages.
• Removing an existing blackout from multiple agents at once.
• Automating blackout administration through scripts or operational procedures.

Apply a Blackout Schedule

1. Open a command prompt or terminal.
2. Navigate to the Foglight bin directory.
3. Run the following command:

fglcmd.{bat|sh} -usr <username> -pwd <password> -cmd agent:setschedule -type DB_SQL_Server -schedulename "Beginning of the day" -force

Parameter Description

• -type - Agent type to target (for example, DB_SQL_Server).
• -schedulename - Name of the blackout schedule to apply.
• -force - Applies the schedule without prompting for confirmation.

Notes

• In this example:
  • DB_SQL_Server is the agent type.
  • Beginning of the day is the blackout schedule being applied.
• To place agents into a continuous blackout immediately, use the schedule name: Always
• Available schedules can be viewed and managed from:
  Administration | Schedules | Manage Schedules
• Regular expressions (regex) may be used with the -type parameter to target multiple agent types.

Verify the Blackout Was Applied

1. Open the Foglight Console.
2. Navigate to Administration | Agents | Agent Blackout Dashboard.
3. Filter or sort by the desired agent type.
4. Verify that the selected schedule is displayed in the Schedule Name column.

Remove a Blackout Schedule

1. Open a command prompt or terminal.
2. Navigate to the Foglight bin directory.
3. Run the following command:

fglcmd.{bat|sh} -usr <username> -pwd <password> -cmd agent:setschedule -type DB_SQL_Server -none -force

This command removes the blackout schedule from all matching agents.

Verify the Blackout Was Removed

1. Open the Foglight Console.
2. Navigate to Administration | Agents | Agent Blackout Dashboard.
3. Filter or sort by the desired agent type.
4. Confirm that the Schedule Name column displays none for the affected agents.

• Blackout schedules suppress alarms and monitoring activity according to the configured schedule.
• Use caution when applying blackouts with regular expression patterns, as multiple agent types may be affected.
• For additional information on supported regular expression syntax, refer to the Foglight Administration Guide.