openoker
/
MeshCentral


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961
							
<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
        <meta name="description" content="A remote monitoring and management tool">
      
      
        <meta name="author" content="Ylianst">
      
      
        <link rel="canonical" href="https://ylianst.github.io/MeshCentral/meshcentral/agents/">
      
      
        <link rel="prev" href="../config/">
      
      
        <link rel="next" href="../assistant/">
      
      
      <link rel="icon" href="../../images/favicon.ico">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40">
    
    
        <title>Agent Information - MeshCentral Documentation</title>
      
    
      <link rel="stylesheet" href="../../assets/stylesheets/main.8c3ca2c6.min.css">
      
        
        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
      
      
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
      <link rel="stylesheet" href="../../stylesheets/extra.css">
    
    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      
  </head>
  
  
    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="indigo">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#mesh-agents" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
    
<header class="md-header" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="../.." title="MeshCentral Documentation" class="md-header__button md-logo" aria-label="MeshCentral Documentation" data-md-component="logo">
      
  <img src="../../images/favicon.ico" alt="logo">

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            MeshCentral Documentation
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              Agent Information
            
          </span>
        </div>
      </div>
    </div>
    
      
      <label class="md-header__button md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
      <div class="md-header__source">
        <a href="https://github.com/Ylianst/MeshCentral" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  </div>
  <div class="md-source__repository">
    Ylianst/MeshCentral
  </div>
</a>
      </div>
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  <div class="md-grid">
    <ul class="md-tabs__list">
      
        
    <li class="md-tabs__item">
      <a href="../.." class="md-tabs__link">
        
  
  Home

      </a>
    </li>
  

      <li class="md-tabs__item">
        <a href="../../install/" class="md-tabs__link">
          
  
  Install

        </a>
      </li>
    
  
      <li class="md-tabs__item md-tabs__item--active">
        <a href="../" class="md-tabs__link">
          
  
  MeshCentral2

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../design/" class="md-tabs__link">
          
  
  Design and Architecture

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../meshcmd/" class="md-tabs__link">
          
  
  MeshCmd

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../meshctrl/" class="md-tabs__link">
          
  
  MeshCtrl

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../meshrouter/" class="md-tabs__link">
          
  
  Mesh Router

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../intelamt/" class="md-tabs__link">
          
  
  Intel AMT

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../how-to-contribute/" class="md-tabs__link">
          
  
  How to Contribute

        </a>
      </li>
    
  
      <li class="md-tabs__item">
        <a href="../../other/adfs_sso_guide/" class="md-tabs__link">
          
  
  Other

        </a>
      </li>
    
  
    </ul>
  </div>
</nav>
          
        
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="../.." title="MeshCentral Documentation" class="md-nav__button md-logo" aria-label="MeshCentral Documentation" data-md-component="logo">
      
  <img src="../../images/favicon.ico" alt="logo">

    </a>
    MeshCentral Documentation
  </label>
  
    <div class="md-nav__source">
      <a href="https://github.com/Ylianst/MeshCentral" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  </div>
  <div class="md-source__repository">
    Ylianst/MeshCentral
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
    <li class="md-nav__item">
      <a href="../.." class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Home
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
        
          
          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Install
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_2">
            <span class="md-nav__icon md-icon"></span>
            Install
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../install/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Quick Start Guide
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../../install/install2/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Full Install Guide
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
        
          
          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
            
  
  <span class="md-ellipsis">
    MeshCentral2
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
          <label class="md-nav__title" for="__nav_3">
            <span class="md-nav__icon md-icon"></span>
            MeshCentral2
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    MeshCentral2 Guide
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../config/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    All Configuration Options
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    Agent Information
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="./" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    Agent Information
  </span>
  

      </a>
      
        
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#windows" class="md-nav__link">
    <span class="md-ellipsis">
      Windows
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#linux-bsd" class="md-nav__link">
    <span class="md-ellipsis">
      Linux / BSD
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos-binary-installer" class="md-nav__link">
    <span class="md-ellipsis">
      Apple macOS Binary Installer
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos-universal" class="md-nav__link">
    <span class="md-ellipsis">
      Apple macOS Universal
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos" class="md-nav__link">
    <span class="md-ellipsis">
      Apple macOS
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#mobile-device-android" class="md-nav__link">
    <span class="md-ellipsis">
      Mobile Device (Android)
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#meshcentral-assistant" class="md-nav__link">
    <span class="md-ellipsis">
      MeshCentral Assistant
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos-binary-installer_1" class="md-nav__link">
    <span class="md-ellipsis">
      Apple MacOS Binary Installer
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#agent-commands" class="md-nav__link">
    <span class="md-ellipsis">
      Agent Commands
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#agent-msh-options" class="md-nav__link">
    <span class="md-ellipsis">
      Agent msh options
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    <li class="md-nav__item">
      <a href="../assistant/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Assistant
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../codesigning/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Code Signing
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../debugging/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Debugging
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../devicetabs/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Device Tabs
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../plugins/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Plugins
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../SSLnletsencrypt/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    SSL
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../security/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Security
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../tokens/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Tokens
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../faq/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    FAQ
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../tipsntricks/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Tips n Tricks
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../../messaging/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Messaging
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../customization/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Customization
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../openidConnectStrategy/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    openidConnectStrategy
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
        
          
          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Design and Architecture
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_4">
            <span class="md-nav__icon md-icon"></span>
            Design and Architecture
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../design/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Design and Architecture
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
        
          
          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    MeshCmd
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_5">
            <span class="md-nav__icon md-icon"></span>
            MeshCmd
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../meshcmd/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    MeshCmd
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
        
          
          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    MeshCtrl
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_6">
            <span class="md-nav__icon md-icon"></span>
            MeshCtrl
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../meshctrl/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    MeshCtrl
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
        
          
          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Mesh Router
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_7">
            <span class="md-nav__icon md-icon"></span>
            Mesh Router
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../meshrouter/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    MeshCentral Router
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
        
          
          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Intel AMT
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_8">
            <span class="md-nav__icon md-icon"></span>
            Intel AMT
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../intelamt/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Intel AMT
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_9" >
        
          
          <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    How to Contribute
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_9">
            <span class="md-nav__icon md-icon"></span>
            How to Contribute
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../how-to-contribute/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Contribute to MeshCentral
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_10" >
        
          
          <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Other
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_10">
            <span class="md-nav__icon md-icon"></span>
            Other
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="../../other/adfs_sso_guide/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ADFS SSO Guide
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="../../other/meshcentral_satellite/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    MeshCentral Satellite
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#windows" class="md-nav__link">
    <span class="md-ellipsis">
      Windows
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#linux-bsd" class="md-nav__link">
    <span class="md-ellipsis">
      Linux / BSD
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos-binary-installer" class="md-nav__link">
    <span class="md-ellipsis">
      Apple macOS Binary Installer
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos-universal" class="md-nav__link">
    <span class="md-ellipsis">
      Apple macOS Universal
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos" class="md-nav__link">
    <span class="md-ellipsis">
      Apple macOS
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#mobile-device-android" class="md-nav__link">
    <span class="md-ellipsis">
      Mobile Device (Android)
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#meshcentral-assistant" class="md-nav__link">
    <span class="md-ellipsis">
      MeshCentral Assistant
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#apple-macos-binary-installer_1" class="md-nav__link">
    <span class="md-ellipsis">
      Apple MacOS Binary Installer
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#agent-commands" class="md-nav__link">
    <span class="md-ellipsis">
      Agent Commands
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#agent-msh-options" class="md-nav__link">
    <span class="md-ellipsis">
      Agent msh options
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  
<h1 id="mesh-agents">Mesh Agents<a class="headerlink" href="#mesh-agents" title="Permanent link">&para;</a></h1>
<h2 id="windows">Windows<a class="headerlink" href="#windows" title="Permanent link">&para;</a></h2>
<p>Default Install Path: <code>c:\Program Files\Mesh Agent</code></p>
<p>Application Path: <code>c:\Program Files\Mesh Agent\meshagent.exe</code></p>
<p>Application database Path: <code>c:\Program Files\Mesh Agent\meshagent.db</code></p>
<p>Application Log Path: <code>c:\Program Files\Mesh Agent\meshagent.log</code></p>
<p>xxx Path: <code>c:\Program Files\Mesh Agent\meshagent.msh</code></p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 19v-3h8v3zm-4.5-6L2.47 7h4.24l4.96 4.95c.58.59.58 1.55 0 2.12L6.74 19H2.5z"/></svg></span> Status</label><label for="__tabbed_1_2"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 19v-3h8v3zm-4.5-6L2.47 7h4.24l4.96 4.95c.58.59.58 1.55 0 2.12L6.74 19H2.5z"/></svg></span> Troubleshooting</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<ul>
<li>Start: <code>net start "mesh agent"</code></li>
<li>Stop: <code>net stop "mesh agent"</code></li>
<li>Restart: <code>net restart "mesh agent"</code></li>
<li>Status: Needs info</li>
</ul>
</div>
<div class="tabbed-block">
<p>Troubleshooting steps: Needs info</p>
</div>
</div>
</div>
<h2 id="linux-bsd">Linux / BSD<a class="headerlink" href="#linux-bsd" title="Permanent link">&para;</a></h2>
<p>Uninstall: <code>sudo /usr/local/mesh_services/meshagent/[agent-name]/meshagent -fulluninstall</code></p>
<h2 id="apple-macos-binary-installer">Apple macOS Binary Installer<a class="headerlink" href="#apple-macos-binary-installer" title="Permanent link">&para;</a></h2>
<p>Default Install Path: <code>/usr/local/mesh_services/meshagent/meshagent</code></p>
<p>Launches from <code>/Library/LaunchAgents/meshagent.plist</code></p>
<p>Controlling agent</p>
<div class="highlight"><pre><span></span><code>launchctl<span class="w"> </span>stop<span class="w"> </span>meshagent
launchctl<span class="w"> </span>start<span class="w"> </span>meshagent
</code></pre></div>
<p>Install: </p>
<p>Uninstall: <code>sudo /usr/local/mesh_services/meshagent/[agent-name]/meshagent -fulluninstall</code></p>
<h2 id="apple-macos-universal">Apple macOS Universal<a class="headerlink" href="#apple-macos-universal" title="Permanent link">&para;</a></h2>
<p>For OSx 11+ including Big Sur, Monterey and later</p>
<h2 id="apple-macos">Apple macOS<a class="headerlink" href="#apple-macos" title="Permanent link">&para;</a></h2>
<p>For macOS 10.x including Catalina, Mojave, High Sierra, Sierra, El Capitan, Yosemite, Mavericks, Mountain Lion and earlier.</p>
<h2 id="mobile-device-android">Mobile Device (Android)<a class="headerlink" href="#mobile-device-android" title="Permanent link">&para;</a></h2>
<h2 id="meshcentral-assistant">MeshCentral Assistant<a class="headerlink" href="#meshcentral-assistant" title="Permanent link">&para;</a></h2>
<p>See <a href="../assistant/">Assistant</a></p>
<h2 id="apple-macos-binary-installer_1">Apple MacOS Binary Installer<a class="headerlink" href="#apple-macos-binary-installer_1" title="Permanent link">&para;</a></h2>
<h2 id="agent-commands">Agent Commands<a class="headerlink" href="#agent-commands" title="Permanent link">&para;</a></h2>
<p><strong>agentmsg</strong> 
: Add/Remove badged messages to the device's web ui
<div class="highlight"><pre><span></span><code>  agentmsg add &quot;[message]&quot; [iconIndex]
  agentmsg remove [index]
  agentmsg list
</code></pre></div>
<strong>agentsize</strong>
: Returns the binary size of the agent</p>
<p><strong>agentupdate</strong>
: Manually trigger an agent self-update</p>
<p><strong>alert</strong>
: Display an alert dialog on the logged in session
<div class="highlight"><pre><span></span><code>alert TITLE, CAPTION [, TIMEOUT]
</code></pre></div></p>
<p><strong>amt</strong></p>
<p><strong>amtconfig</strong></p>
<p><strong>amtevents</strong></p>
<p><strong>apf</strong></p>
<p><strong>args</strong></p>
<p><strong>av</strong>
: Displays Antivirus State</p>
<p><strong>coredump</strong></p>
<p><strong>coreinfo</strong></p>
<p><strong>cpuinfo</strong></p>
<p><strong>cs</strong>
: Display Windows Connected Standby State</p>
<p><strong>dbcompact</strong>
: Compacts the agent database</p>
<p><strong>dbget</strong></p>
<p><strong>dbkeys</strong></p>
<p><strong>dbset</strong></p>
<p><strong>dnsinfo</strong>
: Display DNS server info</p>
<p><strong>domain</strong>
: Display domain metadata</p>
<p><strong>errorlog</strong></p>
<p><strong>eval</strong>
: executes javascript on the agent
<div class="highlight"><pre><span></span><code>eval [code]
</code></pre></div></p>
<p><strong>fdcount</strong>
: Returns the number of active descriptors in the event loop</p>
<p><strong>fdsnapshot</strong>
: Returns detailed descriptor/handle/timer metadata</p>
<p><strong>getclip</strong>
: Fetches clipboard data from agent</p>
<p><strong>getscript</strong></p>
<p><strong>help</strong>
: Returns the list of supported console commands</p>
<p><strong>httpget</strong></p>
<p><strong>info</strong>
: Returns general information about the agent, such as connected state, loaded modules, LMS state, etc</p>
<p><strong>kill</strong>
: Sends a SIGKILL signal to the specified PID
<div class="highlight"><pre><span></span><code>kill [pid]
</code></pre></div></p>
<p><strong>kvmmode</strong>
: Displays the KVM Message Format</p>
<p><strong>location</strong>
: Displays saves location information about the connected agent</p>
<p><strong>lock</strong></p>
<p><strong>log</strong>
: Writes a message to the logfile
<div class="highlight"><pre><span></span><code>log [message]
</code></pre></div></p>
<p><strong>ls</strong>
: Enumerates the files in the agent's install folder</p>
<p><strong>mousetrails</strong>
: Enables/Disables Mouse Trails Accessibility on Windows. To change setting, specify a positive integer representing the number of latent cursors, where 0 is disable
<div class="highlight"><pre><span></span><code>mousetrails [n]
</code></pre></div></p>
<p><strong>msh</strong>
: Displays the loaded msh settings file</p>
<p><strong>netinfo</strong>
: Displays network interface information</p>
<p><strong>notify</strong>
: Display a notification on the web interface</p>
<p><strong>openurl</strong></p>
<p><strong>osinfo</strong>
: Displays OS information</p>
<p><strong>parseuri</strong>
: Parses the specified URI, and displays the parsed output
<div class="highlight"><pre><span></span><code>parseuri [uri]
</code></pre></div></p>
<p><strong>plugin</strong>
: Invokes a plugin
<div class="highlight"><pre><span></span><code>plugin [pluginName] [args]
</code></pre></div></p>
<p><strong>power</strong>
: Performs the specified power action
<div class="highlight"><pre><span></span><code>power [action]
  LOGOFF = 1
  SHUTDOWN = 2
  REBOOT = 3
  SLEEP = 4
  HIBERNATE = 5
  DISPLAYON = 6
  KEEPAWAKE = 7
  BEEP = 8
  CTRLALTDEL = 9
  VIBRATE = 13
  FLASH = 14
</code></pre></div></p>
<p><strong>print</strong></p>
<p><strong>privacybar</strong>
: Sets/Gets the default pinned state of the Privacy Bar on windows
<div class="highlight"><pre><span></span><code>privacybar [PINNED|UNPINNED]
</code></pre></div></p>
<p><strong>ps</strong>
: Enumerates processes on the agent</p>
<p><strong>rawsmbios</strong>
: Fetches the raw smbios table</p>
<p><strong>safemode</strong>
: Sets/Gets the SAFEMODE configuration of the agent, as well as the next boot state.
<div class="highlight"><pre><span></span><code>safemode (ON|OFF|STATUS)
</code></pre></div></p>
<p><strong>scanwifi</strong>
: Scans the available Wifi access points, and displays the SSID and Signal Strength</p>
<p><strong>service</strong>
: Shortcut to be able to restart the agent service
<div class="highlight"><pre><span></span><code>service status|restart
</code></pre></div></p>
<p><strong>setclip</strong>
: Sets clipboard data to the agent
<div class="highlight"><pre><span></span><code>setclip [text]
</code></pre></div></p>
<p><strong>setdebug</strong>
: Sets the location target for debug messages
<div class="highlight"><pre><span></span><code>setdebug [target]
0 = Disabled
1 = StdOut
2 = This Console
* = All Consoles
4 = WebLog
8 = Logfile
</code></pre></div></p>
<p><strong>smbios</strong>
: Displays the parsed SMBIOS metadata</p>
<p><strong>startupoptions</strong>
: Displays the command-line options that the agent was started with</p>
<p><strong>sysinfo</strong>
: Collects and displays telemetry on the platform</p>
<p><strong>task</strong></p>
<p><strong>taskbar</strong>
: Hides or shows the Windows System task bar, optionally on the specified Terminal Server Session ID
<div class="highlight"><pre><span></span><code>taskbar HIDE|SHOW [TSID]
</code></pre></div></p>
<p><strong>timerinfo</strong>
: Displays metadata about any configured timers on the event loop</p>
<p><strong>toast</strong>
: Displays a toast message on the logged in user's session
<div class="highlight"><pre><span></span><code>toast [message]
</code></pre></div></p>
<p><strong>translations</strong>
: Shows the currently configured translations</p>
<p><strong>type</strong>
<div class="highlight"><pre><span></span><code>type (filepath) [maxlength]
</code></pre></div></p>
<p><strong>uac</strong>
: Get/Sets the Windows UAC mode
<div class="highlight"><pre><span></span><code>uac [get|interactive|secure]
</code></pre></div></p>
<p><strong>unzip</strong>
<div class="highlight"><pre><span></span><code>unzip input, destination
</code></pre></div>
: Unzips the specified file</p>
<p><strong>users</strong>
: Enumerates the logged in users on the system</p>
<p><strong>versions</strong>
: Displays version information about the agent</p>
<p><strong>vm</strong>
: Detects if the system is a Virtual Machine</p>
<p><strong>volumes</strong>
: Displays volume information reported by the OS</p>
<p><strong>wakeonlan</strong>
: Sends wake-on-lan packets to the specified MAC address
<div class="highlight"><pre><span></span><code>wakeonlan [mac]
</code></pre></div></p>
<p><strong>wallpaper</strong>
: Gets/Toggles the logged in user's desktop background image
<div class="highlight"><pre><span></span><code>wallpaper (GET|TOGGLE)
</code></pre></div></p>
<p><strong>wpfhwacceleration</strong>
: Enable/Disable WPF HW Acceleration on Windows
<div class="highlight"><pre><span></span><code>wpfhwacceleration (ON|OFF|STATUS)
</code></pre></div></p>
<p><strong>wsclose</strong></p>
<p><strong>wsconnect</strong></p>
<p><strong>wslist</strong></p>
<p><strong>wssend</strong></p>
<p><strong>zip</strong>
<div class="highlight"><pre><span></span><code>zip (output file name), input1 [, input n]
</code></pre></div></p>
<h2 id="agent-msh-options">Agent msh options<a class="headerlink" href="#agent-msh-options" title="Permanent link">&para;</a></h2>
<p>You can find a full list of options for the agent <a href="https://github.com/Ylianst/MeshAgent?tab=readme-ov-file#msh-format">here</a></p>
<p><code>skipmaccheck=1</code>: Will not regenerate the agents nodeid and cause duplication of the agent when the MAC address changes.</p>
<p>You can add options to your .msh on agent install with <a href="https://github.com/Ylianst/MeshCentral/blob/15ff7d12a1e4e5d78936b473ea207b7e02b8ff26/meshcentral-config-schema.json#L2504">this</a></p>


              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
    <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
    
    
      <script src="../../assets/javascripts/bundle.525ec568.min.js"></script>
      
    
  </body>
</html>