Palo Alto Networks Certified Security Automation Engineer (PCSAE)IntegrationsEasy
A security architect is designing a new custom integration for Cortex XSOAR that needs to perform a health check on an external service. This health check should only verify network connectivity and basic API responsiveness, without requiring full authentication or complex data parsing. Which integration command type is most suitable for implementing this health check functionality?
- AA fetch incidents command, configured to retrieve a 'health status' incident.
- BA regular command decorated with `@demisto.command()`, returning a simple 'OK' or 'FAIL'.
- CThe `test-module` command, which is specifically designed for integration health checks.
- DA scheduled command that runs periodically to check the service status.
Show answer & explanationAnswer & explanation
Correct answer: C. The `test-module` command, which is specifically designed for integration health checks.
The `test-module` command is explicitly designed in Cortex XSOAR integrations for verifying the connectivity and basic functionality of an integration instance. It is executed when an integration instance is saved or tested, providing immediate feedback on its health without needing to run other commands.
Why the other options are wrong
- A. A fetch incidents command is for retrieving security events, not for general integration health checks.
- B. A regular command could do this, but `test-module` is the dedicated standard for integration health checks.
- D. A scheduled command runs periodically, but `test-module` is for direct, on-demand instance verification.
`test-module` Command
A special command in Cortex XSOAR custom integrations, defined in the YAML and implemented in Python, used to perform a health check on the integration's connectivity and basic functionality when an instance is saved or tested.
- Runs when integration instance is saved/tested.
- Verifies connectivity and basic functionality.
- Must return 'ok' or raise an exception on failure.
Memory trick: Test-module: The doctor for your integration's health.