QRadar App Management - support utilities, CLI, API (2025)

\n QRadar App Management - support utilities, CLI, API (1)\n \n '):m?"\n \n ").concat(u&&"

".concat(u,"

")||"","\n "):'\n

\n '.concat(o,"\n

\n ").concat(u&&"

".concat(u,"

")||"","\n "),this.rendered=!0}},{key:"connectedCallback",value:function(){this.rendered||this.render()}},{key:"attributeChangedCallback",value:function(e,t,n){t!==n&&(this.previousAttributes[e]=t,this[e]=null,this.render())}}])&&i(n.prototype,m),u&&i(n,u),Object.defineProperty(n,"prototype",{writable:!1}),y}(m(HTMLElement));function l(e){return l="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},l(e)}function b(e,t){for(var n=0;n\n ").concat(r||m,"\n ").concat(megaMenuConfig.svgs.megamenuArrowSvg,"\n "):"\n

\n ".concat(m,"\n

\n "),"\n "),this.appendChild(b),n){var y=document.createElement("p");y.classList.add("menu_right_subtitle"),y.innerHTML=n,this.appendChild(y)}var d=document.createElement("ul");d.classList.add("menu_sub-links");var p=assembleLinks(c),f=assembleLinks(a),h=assembleLinks(s);d.appendChild(p),d.appendChild(f),d.appendChild(h),this.appendChild(d),this.rendered=!0}},{key:"connectedCallback",value:function(){this.rendered||this.render()}},{key:"attributeChangedCallback",value:function(e,t,n){t!==n&&(this.previousAttributes[e]=t,this.render())}}])&&b(o.prototype,i),m&&b(o,m),Object.defineProperty(o,"prototype",{writable:!1}),a}(y(HTMLElement));window.customElements.define("ibm-community-menu-sub-right",g),n(459),n(480),n(680),n(111)})()})();
  • Log in

Skip to main content (Press Enter).

Sign in

Skip auxiliary navigation (Press Enter).

`;class IBMCommunitySearch extends HTMLElement { constructor() { super(); this.rendered = false; this.searchResults = []; this.isSearchResultsListVisible = false; this.timeout = false; this.isLoading = false; this.controller = new AbortController(); // Added initialization of controller } static get observedAttributes() { return [ 'data-identifier', ]; } handleDocumentClick(e) { if (this.searchContainerEl && !this.searchContainerEl.contains(e.composedPath()[0])) { if (this.isSearchResultsListVisible) { this.isSearchResultsListVisible = false; } } if (this.filterContainerEl && !this.filterContainerEl.contains(e.composedPath()[0])) { if (this.communityFiltersVisible) { this.communityFiltersVisible = false; } } } buildBrowserSearchUrl(val) { let url = 'https://community.ibm.com/community/user'; if (this.selectedCommunityFilterIndex === 0) { // this community if (this.currentCommunity !== '') { url += `/${this.currentCommunity}`; } } url += `/search?executeSearch=true&SearchTerm=${val}`; return url; } buildSearchUrl(val) { let query = `http://localhost:8001/hl/search?keywords=${val}`; if (this.selectedCommunityFilterIndex === 0 && this.currentCommunity !== '') { query += `&filter=${this.currentCommunity}`; } else if (this.selectedCommunityFilterIndex === 1) { query += '&filter=all'; } return query; } async getBrowserSearchResults(val, signal) { try { this.isLoading = true; const url = this.buildBrowserSearchUrl(val); const res = await fetch(url, { signal }); const data = await res.text(); const parser = new DOMParser(); const domContent = parser.parseFromString(data, 'text/html'); const resultElements = domContent.querySelectorAll('[id^="FacetedSearchResult"]'); const arr = [].slice.call(resultElements).slice(0, 5); const out = []; arr.forEach((el) => { const $div = el.querySelector('h3 > div.hl-type > span'); const $a = el.querySelector('h3 > a'); let type = ''; for (const child of $div.childNodes) { if (child.nodeType === Node.TEXT_NODE) { type += child.textContent; } } const title = $a.textContent.trim(); const $url = $a.getAttribute('href'); out.push({ type, title, url: $url }); }); this.searchResults = out; } catch (e) { console.error('Error searching: \n', e); } finally { this.isLoading = false; this.isSearchResultsListVisible = true; this.render(); const input = this.querySelector('#ibmc-search-input'); if (input) { setTimeout(() => { input.focus(); }, 1); } } } async debouncedSearch() { if (this.timeout) { clearTimeout(this.timeout); this.timeout = false; } this.timeout = setTimeout(async () => { const { signal } = this.controller; // Changed 'controller' to 'this.controller' await this.getBrowserSearchResults(this.searchText, signal); }, 300); } searchTextWatchHandler(val) { try { if (val.length > 0) { if (this.isLoading) { this.controller.abort('User still typing'); // Changed 'controller' to 'this.controller' this.controller = new AbortController(); // Added initialization of controller } this.debouncedSearch(val); } else { this.searchResults = []; this.isSearchResultsListVisible = false; } } catch (e) { console.error('Error running debounced search: \n', e); } } handleSearchInputOnInput(e) { this.searchText = e.target.value.trim(); this.searchTextWatchHandler(this.searchText); } handleSearchInputKeyUp(e) { if (e.key === 'Enter' || e.keyCode === 13) { const searchUrl = this.buildBrowserSearchUrl(this.searchText); window.open(searchUrl, '_self'); } } handleSearchInputOnClick() { this.isSearchResultsListVisible = this.searchResults.length > 0; } handleResultListClick(e) { console.log('e', e.target); const liElement = e.target.closest('li[data-url]'); if (liElement) { this.isSearchResultsListVisible = false; window.open(liElement.getAttribute('data-url'), '_self'); } } createTemplate() { const template = document.createElement('template'); template.id = 'ibmcommunity-leadspace'; template.innerHTML = defaultSearchTemplate; return template; } render() { if (this.rendered) { this.innerHTML = ''; } let template = document.getElementById('ibmcommunity-search'); if (!template) { template = this.createTemplate(); } const templateContent = template.content; this.appendChild(templateContent.cloneNode(true)); const SearchInput = this.querySelector('input.bx--search-input.ibmc-search-input'); const SubmitButton = this.querySelector('#ibmcommunity-search-button-submit'); if (this.rendered) { SearchInput.value = this.searchText; } if (SearchInput) { SearchInput.addEventListener('click', () => this.handleSearchInputOnClick()); SearchInput.addEventListener('input', (e) => this.handleSearchInputOnInput(e)); SearchInput.addEventListener('keyup', (e) => this.handleSearchInputKeyUp(e)); } if (SubmitButton) { SubmitButton.addEventListener('click', () => this.handleSearchInputOnClick()); } const SearchResultsContainer = this.querySelector('[aria-selector="search-results-container"]'); if (!SearchResultsContainer) { return; } if (this.searchResults && this.searchResults.length > 0) { if (this.rendered) { SearchResultsContainer.innerHTML = ''; } const SearchResultsUl = document.createElement('ul'); SearchResultsUl.setAttribute('role', 'menu'); SearchResultsUl.setAttribute('class', 'bx--dropdown-list'); SearchResultsUl.setAttribute('tabindex', '0'); SearchResultsUl.setAttribute('aria-hidden', 'true'); SearchResultsUl.setAttribute('wh-menu-anchor', 'left'); SearchResultsUl.addEventListener('click', (e) => this.handleResultListClick(e)); this.searchResults.forEach((item) => { console.log('item', item) SearchResultsUl.innerHTML += (`
  • ${item.type}

    ${item.title}

  • `); }); SearchResultsContainer.appendChild(SearchResultsUl); } else { SearchResultsContainer.style.display = 'none'; } this.rendered = true; } connectedCallback() { if (!this.rendered) { this.render(); } document.addEventListener('click', (e) => this.handleDocumentClick(e)); }}document.addEventListener('DOMContentLoaded', () => { if (!window.customElements.get('ibmcommunity-search')) { window.customElements.define('ibmcommunity-search', IBMCommunitySearch); }});// For testingtry { module.exports = IBMCommunitySearch;} catch (e) {}
    • Security
    • Topic groups
      • IBM Cloud Pak for Security
      • IBM Security Global Forum
      • IBM Guardium
      • IBM MaaS360
      • IBM QRadar
      • IBM QRadar SOAR
      • IBM Trusteer
      • IBM Verify
      • IBM Z Security
    • Groups
      • AI
      • Automation
      • Data
      • Security
      • Sustainability
      • Cloud
      • Power
      • Storage
      • IBM Japan
      • All Groups
    • Champions
    • User groups
    • Events
    • Participate
      • Welcome Corner
      • Blogging in the Community
      • Directory
      • Community Leaders
      • Resources
      • Gamification
    • Marketplace

    IBM Security

    Join our 16,000+ members as we work together to
    overcome the toughest challenges of cybersecurity.

    Start collaborating

    Limited-Time Offer: 50% off IBM TechXchange Conference 2025

    IBM’s largest technical learning event is back October 6-9 in Orlando, FL

    Skip main navigation (Press Enter).

    View Only

    • Group Home
    • Threads 7.5K
    • Library 260
    • Blogs 414
    • Events 0
    • Members 4.1K

    QRadar App Management - support utilities, CLI, API - need-to-know

    By Ralph Belfiore posted Mon December 28, 2020 08:18 PM

    1 Like

    During the course of my troubleshooting experience i had to be aware of some “utility changes” regarding to app extension management and monitoring.
    According to the applied Release of QRadar and deployment scenario (AiO / Apphost as a managed host), you’ll have to keep in mind some improvements/changes of available “support utilities” or CLI commands.

    For those who haven’t yet found a summary list or have been updated already their bookmarks with helpful links regarding to this subject, here an offer of consolidated information, helpful support links, commands and “utility changes” just in case..

    In case of investigation a status of an app, starting/stopping an app, updating an app there a some details to consider. For example, in Release 7.3.x you needed to remember the following psql command with many options in CLI to display app id, name, status, version and more context of the applied apps running on the CONSOLE:

    QRadar App Management - support utilities, CLI, API (4)

    Starting with the Qradar Assistant App Release 3.0 (current release is 3.2.1) as an admin you can use also the assistant app to comfortable handle and maintain apps over the UI using the "Manage" Button:

    QRadar App Management - support utilities, CLI, API (5)


    Further information about the assistant app will be found here:
    Assistant App Features

    To investigate the status of apps on an APPHOST with Release 7.3.x you could use so far the following cli command to get the following output displayed:

    - /opt/qradar/support/recon ps

    QRadar App Management - support utilities, CLI, API (6)

    The recon ps command disappeared for example with 7.4.1FP2! At the latest from this release you’ll have to be aware about the qappmanager support utility (details stated below). Similar context will be called for example in Release 7.4.1FP2 by the following commands:

    - docker images
    - docker ps

    QRadar App Management - support utilities, CLI, API (7)

    The qappmanager utility was introduced with QRadar Release 7.4.0. The current status and helpful context of applied apps now can be shown with the new support tool.
    It has to be executed from the CONSOLE and provides many options to maintain, start, stop, delete or create new instances of apps:

    - /opt/qradar/support/qappmanager

    QRadar App Management - support utilities, CLI, API (8)

    Further support information about the qappmanager support utility will be found here:
    qappmanager utility

    Finaly in rare cases, in cases of scripting or integration with other systems you can use the API as well. It's well documented and for example straight forward to start or stop an app using the API:

    QRadar App Management - support utilities, CLI, API (9)

    Using the "Try Button":

    QRadar App Management - support utilities, CLI, API (10)


    So concluding for me, it’s exiting to chase the continuous enhancements of QRadar and specifically the app management stuff. The support utilities to manage apps are more and more easily operated supporting app extension management.

    #Highlights
    #Highlights-home
    #QRadar

    0 comments

    1779 views

    Permalink

    Additional
    Resources


    Discover these carefully selected resources to dive deeper into your journey and unlock fresh insights

    Office


    If you need immediate assistance please contact the Community Management team

    QRadar App Management - support utilities, CLI, API (11) support@communitysite.ibm.com

    QRadar App Management - support utilities, CLI, API (12) Monday - Friday: 8AM - 5 PM MT

    Quick Links


    About Us

    Terms of Use

    Community Netiquette

    Sitemap

    FAQ

    Community

    • Security
    • Topic groups
      • IBM Cloud Pak for Security
      • IBM Security Global Forum
      • IBM Guardium
      • IBM MaaS360
      • IBM QRadar
      • IBM QRadar SOAR
      • IBM Trusteer
      • IBM Verify
      • IBM Z Security
    • Groups
      • AI
      • Automation
      • Data
      • Security
      • Sustainability
      • Cloud
      • Power
      • Storage
      • IBM Japan
      • All Groups
    • Champions
    • User groups
    • Events
    • Participate
      • Welcome Corner
      • Blogging in the Community
      • Directory
      • Community Leaders
      • Resources
      • Gamification
    • Marketplace

    QRadar App Management - support utilities, CLI, API (13)

    QRadar App Management - support utilities, CLI, API (2025)
    Top Articles
    Latest Posts
    Recommended Articles
    Article information

    Author: Aron Pacocha

    Last Updated:

    Views: 6306

    Rating: 4.8 / 5 (68 voted)

    Reviews: 83% of readers found this page helpful

    Author information

    Name: Aron Pacocha

    Birthday: 1999-08-12

    Address: 3808 Moen Corner, Gorczanyport, FL 67364-2074

    Phone: +393457723392

    Job: Retail Consultant

    Hobby: Jewelry making, Cooking, Gaming, Reading, Juggling, Cabaret, Origami

    Introduction: My name is Aron Pacocha, I am a happy, tasty, innocent, proud, talented, courageous, magnificent person who loves writing and wants to share my knowledge and understanding with you.