[{"data":1,"prerenderedAt":292},["ShallowReactive",2],{"\u002Fdocs\u002Fguides\u002Fagents":3},{"id":4,"title":5,"body":6,"description":284,"extension":285,"meta":286,"navigation":287,"path":288,"seo":289,"stem":290,"__hash__":291},"docs\u002Fdocs\u002Fguides\u002Fagents.md","Managing Agents",{"type":7,"value":8,"toc":275},"minimark",[9,13,17,22,74,77,81,116,123,168,186,196,200,243,252,256,262,265,269],[10,11,5],"h1",{"id":12},"managing-agents",[14,15,16],"p",{},"An agent is the part of NetIgnite that lives inside your network. It keeps a WebSocket connection\nto the server and sends Wake-on-LAN packets for the devices assigned to it. You need one agent per\nnetwork (broadcast domain) that contains devices you want to wake.",[18,19,21],"h2",{"id":20},"agent-types","Agent types",[23,24,25,38],"table",{},[26,27,28],"thead",{},[29,30,31,35],"tr",{},[32,33,34],"th",{},"Type",[32,36,37],{},"Use it for",[39,40,41,59],"tbody",{},[29,42,43,50],{},[44,45,46],"td",{},[47,48,49],"strong",{},"Microcontroller",[44,51,52,53,58],{},"The ",[54,55,57],"a",{"href":56},"\u002Fdocs\u002Fagents\u002Fesp32","ESP32 agent"," or other embedded agents.",[29,60,61,66],{},[44,62,63],{},[47,64,65],{},"Server",[44,67,68,69,73],{},"An agent running on an always-on computer, such as a ",[54,70,72],{"href":71},"\u002Fdocs\u002Fagents\u002Fprotocol","custom agent",".",[14,75,76],{},"The type is informational. It doesn't change how the server talks to the agent.",[18,78,80],{"id":79},"creating-an-agent","Creating an agent",[82,83,84,95,109],"ol",{},[85,86,87,88,91,92,73],"li",{},"Open ",[47,89,90],{},"Agents"," and click ",[47,93,94],{},"Add New Agent",[85,96,97,98,101,102,105,106,73],{},"Enter a ",[47,99,100],{},"Name",", choose the ",[47,103,104],{},"Agent Type"," and optionally add a ",[47,107,108],{},"Description",[85,110,111,112,115],{},"Click ",[47,113,114],{},"Create Agent",". The server generates a random secret, and the agent's page opens.",[14,117,118,119,122],{},"The agent's page shows its ",[47,120,121],{},"Connection Details",":",[23,124,125,135],{},[26,126,127],{},[29,128,129,132],{},[32,130,131],{},"Field",[32,133,134],{},"Agent setting",[39,136,137,155],{},[29,138,139,144],{},[44,140,141],{},[47,142,143],{},"Connection ID",[44,145,146,147,151,152,73],{},"The agent's numeric ID, for example ",[148,149,150],"code",{},"3",". ESP32: ",[148,153,154],{},"C_CONTROL_SERVER_AUTH_ID",[29,156,157,162],{},[44,158,159],{},[47,160,161],{},"Connection Secret",[44,163,164,165,73],{},"A random 32-character secret. ESP32: ",[148,166,167],{},"C_CONTROL_SERVER_AUTH_SECRET",[169,170,171],"warning",{},[14,172,173,174,177,178,181,182,73],{},"The secret is shown ",[47,175,176],{},"only once",", right after the agent is created. Copy it with ",[47,179,180],{},"Copy Secret","\n(or reveal it with the eye icon) before you leave the page. NetIgnite stores only a hash of it, so\nit can't be displayed again; if you lose it, ",[54,183,185],{"href":184},"#changing-the-secret","generate a new one",[14,187,188,189,192,193,73],{},"Configure your agent with the two connection values and the server address. As soon as it\nconnects, its status turns ",[47,190,191],{},"online",". To change the name, type or description later, edit the\nfields and click ",[47,194,195],{},"Update Agent",[18,197,199],{"id":198},"agent-status","Agent status",[23,201,202,212],{},[26,203,204],{},[29,205,206,209],{},[32,207,208],{},"Status",[32,210,211],{},"Meaning",[39,213,214,223,233],{},[29,215,216,220],{},[44,217,218],{},[148,219,191],{},[44,221,222],{},"The agent is connected to the server.",[29,224,225,230],{},[44,226,227],{},[148,228,229],{},"offline",[44,231,232],{},"The agent is known but not connected.",[29,234,235,240],{},[44,236,237],{},[148,238,239],{},"unknown",[44,241,242],{},"The server has no state for this agent.",[14,244,52,245,247,248,251],{},[47,246,90],{}," page refreshes the status every 20 seconds. The ",[47,249,250],{},"Ping"," button refreshes it right\naway. An agent that loses its connection reconnects on its own (the ESP32 agent retries every 60\nseconds).",[18,253,255],{"id":254},"changing-the-secret","Changing the secret",[14,257,111,258,261],{},[47,259,260],{},"Regenerate Secret"," on the agent's page to replace the secret, for example if you lost it\nor it may have leaked. The new secret is shown once. The old secret stops working right away and\nthe agent is disconnected; it can only reconnect once it's configured with the new secret. For the\nESP32 agent, that means rebuilding and reflashing the firmware.",[14,263,264],{},"Secrets are always generated by the server; you can't choose your own.",[18,266,268],{"id":267},"deleting-an-agent","Deleting an agent",[14,270,271,272,274],{},"Delete an agent with the trash icon on the ",[47,273,90],{}," page. A connected agent is disconnected\nimmediately. Reassign or delete the devices that use it first: devices keep pointing at the\ndeleted agent and can no longer be woken.",{"title":276,"searchDepth":277,"depth":277,"links":278},"",2,[279,280,281,282,283],{"id":20,"depth":277,"text":21},{"id":79,"depth":277,"text":80},{"id":198,"depth":277,"text":199},{"id":254,"depth":277,"text":255},{"id":267,"depth":277,"text":268},"Create NetIgnite agents, find their Connection ID and Secret, and understand agent status.","md",{},{"title":5},"\u002Fdocs\u002Fguides\u002Fagents",{"title":5,"description":284},"docs\u002Fguides\u002Fagents","N_kqc7V_TV1DJ7bBo3Ws28Qtl4dhBJgHYYSBAjXYI-k",1792355946318]