[{"data":1,"prerenderedAt":485},["ShallowReactive",2],{"docs-discovery-credentials-":3,"docs-navigation":341},{"id":4,"title":5,"body":6,"dateModified":330,"datePublished":330,"description":331,"extension":332,"meta":333,"navigation":334,"path":336,"proficiencyLevel":337,"seo":338,"stem":339,"__hash__":340},"docs\u002Fdocs\u002F3.discovery\u002F2.credentials.md","Setting Up Credentials",{"type":7,"value":8,"toc":322},"minimark",[9,13,17,22,82,86,126,129,133,141,148,152,159,185,188,285,289,300,304,307,315,318],[10,11,5],"h1",{"id":12},"setting-up-credentials",[14,15,16],"p",{},"Before Open-AudIT can audit a device it needs credentials to authenticate with it. You'll need to create credential sets for each type of device in your environment.",[18,19,21],"h2",{"id":20},"supported-credential-types","Supported Credential Types",[23,24,25,38],"table",{},[26,27,28],"thead",{},[29,30,31,35],"tr",{},[32,33,34],"th",{},"Type",[32,36,37],{},"Used For",[39,40,41,50,58,66,74],"tbody",{},[29,42,43,47],{},[44,45,46],"td",{},"SNMP v1\u002Fv2",[44,48,49],{},"Network devices, printers, and any SNMP-enabled device",[29,51,52,55],{},[44,53,54],{},"SNMP v3",[44,56,57],{},"Same as above, with stronger security",[29,59,60,63],{},[44,61,62],{},"SSH",[44,64,65],{},"Linux, macOS, Unix, AIX, HP-UX, Solaris, ESXi",[29,67,68,71],{},[44,69,70],{},"SSH Key",[44,72,73],{},"Same as SSH but using a private key file",[29,75,76,79],{},[44,77,78],{},"Windows (WMI)",[44,80,81],{},"Windows servers and workstations",[18,83,85],{"id":84},"creating-a-credential-set","Creating a Credential Set",[87,88,89,97,104,111,117,120],"ol",{},[90,91,92,93],"li",{},"Go to ",[94,95,96],"strong",{},"Menu → Discover → Credentials → Create Credentials",[90,98,99,100,103],{},"Give the credential set a ",[94,101,102],{},"Name"," (e.g., \"Linux Root SSH\" or \"Windows Admin\")",[90,105,106,107,110],{},"Choose an ",[94,108,109],{},"Organization"," and optionally add a description",[90,112,113,114,116],{},"Select the ",[94,115,34],{}," from the dropdown — additional fields will appear based on your selection",[90,118,119],{},"Fill in the relevant details (username, password, community string, etc.)",[90,121,122,123],{},"Click ",[94,124,125],{},"Submit",[14,127,128],{},"Repeat this for each credential type you need. Open-AudIT will test each credential against each device during discovery and remember which ones worked for next time.",[18,130,132],{"id":131},"ssh-keys","SSH Keys",[14,134,135,136,140],{},"If you're using key-based SSH authentication, paste the entire contents of your private key file into the SSH Key field — including the ",[137,138,139],"code",{},"-----BEGIN RSA PRIVATE KEY-----"," header and footer lines.",[142,143,145],"docs-callout",{"type":144},"note",[14,146,147],{},"SSH key authentication is not currently supported on Windows-hosted Open-AudIT servers.",[18,149,151],{"id":150},"importing-credentials-in-bulk","Importing Credentials in Bulk",[14,153,154,155,158],{},"If you have a lot of credentials to add, you can import them from a CSV file via ",[94,156,157],{},"Menu → Discover → Credentials → Import Multiple Credentials",".",[14,160,161,162,165,166,165,169,172,173,176,177,180,181,184],{},"The CSV requires at minimum: ",[137,163,164],{},"name",", ",[137,167,168],{},"org_id",[137,170,171],{},"type",", and the relevant credential fields (e.g., ",[137,174,175],{},"credentials.community"," for SNMP, or ",[137,178,179],{},"credentials.username"," and ",[137,182,183],{},"credentials.password"," for SSH\u002FWindows).",[14,186,187],{},"Example CSV:",[189,190,195],"pre",{"className":191,"code":192,"language":193,"meta":194,"style":194},"language-csv shiki shiki-themes github-light github-dark","\"name\",\"org_id\",\"type\",\"credentials.community\",\"credentials.username\",\"credentials.password\"\n\"Public SNMP\",\"1\",\"snmp\",\"public\",\"\",\"\"\n\"My SSH\",\"1\",\"ssh\",\"\",\"my_user\",\"my_password\"\n\"Windows Creds\",\"1\",\"windows\",\"\",\"my_win_user@open-audit.com\",\"my_win_password\"\n","csv","",[137,196,197,226,247,266],{"__ignoreMap":194},[198,199,202,206,210,214,218,222],"span",{"class":200,"line":201},"line",1,[198,203,205],{"class":204},"sVt8B","\"name\",",[198,207,209],{"class":208},"szBVR","\"org_id\",",[198,211,213],{"class":212},"sScJk","\"type\",",[198,215,217],{"class":216},"sJ8bj","\"credentials.community\",",[198,219,221],{"class":220},"sZZnC","\"credentials.username\",",[198,223,225],{"class":224},"s4XuR","\"credentials.password\"\n",[198,227,229,232,235,238,241,244],{"class":200,"line":228},2,[198,230,231],{"class":204},"\"Public SNMP\",",[198,233,234],{"class":208},"\"1\",",[198,236,237],{"class":212},"\"snmp\",",[198,239,240],{"class":216},"\"public\",",[198,242,243],{"class":220},"\"\",",[198,245,246],{"class":224},"\"\"\n",[198,248,250,253,255,258,260,263],{"class":200,"line":249},3,[198,251,252],{"class":204},"\"My SSH\",",[198,254,234],{"class":208},[198,256,257],{"class":212},"\"ssh\",",[198,259,243],{"class":216},[198,261,262],{"class":220},"\"my_user\",",[198,264,265],{"class":224},"\"my_password\"\n",[198,267,269,272,274,277,279,282],{"class":200,"line":268},4,[198,270,271],{"class":204},"\"Windows Creds\",",[198,273,234],{"class":208},[198,275,276],{"class":212},"\"windows\",",[198,278,243],{"class":216},[198,280,281],{"class":220},"\"my_win_user@open-audit.com\",",[198,283,284],{"class":224},"\"my_win_password\"\n",[18,286,288],{"id":287},"a-note-on-security","A Note on Security",[14,290,291,292,295,296,299],{},"Credential details are stored encrypted in the database. However, be aware that if you export credentials to CSV, XML, or JSON format, the actual decrypted values are included in the output. You can disable this behaviour by setting ",[137,293,294],{},"decrypt_credentials"," to ",[137,297,298],{},"n"," in the configuration.",[18,301,303],{"id":302},"how-open-audit-uses-credentials","How Open-AudIT Uses Credentials",[14,305,306],{},"When a discovery runs, Open-AudIT tests credentials in this order:",[87,308,309,312],{},[90,310,311],{},"Device-specific credentials (if the device has been seen before and has working credentials on record)",[90,313,314],{},"All other credential sets, starting with those known to have worked previously",[14,316,317],{},"The first set that works is used for the full audit. This keeps discovery fast.",[319,320,321],"style",{},"html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":194,"searchDepth":228,"depth":228,"links":323},[324,325,326,327,328,329],{"id":20,"depth":228,"text":21},{"id":84,"depth":228,"text":85},{"id":131,"depth":228,"text":132},{"id":150,"depth":228,"text":151},{"id":287,"depth":228,"text":288},{"id":302,"depth":228,"text":303},"2026-04-10","Learn how to create and manage the credential sets Open-AudIT uses to authenticate with devices during network discovery.","md",{},{"title":335},"Credentials","\u002Fdocs\u002Fdiscovery\u002Fcredentials","Beginner",{"title":5,"description":331},"docs\u002F3.discovery\u002F2.credentials","dABBVwQPA9gHCPEw6NKMaOtZi8BA3ouq2IZJGYU3FLE",[342],{"title":343,"path":344,"stem":345,"children":346},"Docs","\u002Fdocs","docs",[347,351,363,385,412,434,441,463,480],{"title":348,"path":344,"stem":349,"description":350},"Overview","docs\u002Findex","Guides to help you install, configure, and get the most out of Open-AudIT — a powerful network discovery, audit, and asset tracking system.",{"title":352,"path":353,"stem":354,"children":355,"description":357},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started\u002F1.index",[356,358],{"title":352,"path":353,"stem":354,"description":357},"Get from a fresh install to discovering devices on your network in under 10 minutes. This guide walks through each step in order.",{"title":359,"path":360,"stem":361,"description":362},"Activating Your License","\u002Fdocs\u002Fgetting-started\u002Factivating-your-license","docs\u002F1.getting-started\u002F2.activating-your-license","How to activate your free 100-device Open-AudIT Enterprise license after installation.",{"title":364,"path":365,"stem":366,"children":367,"description":369},"Installation","\u002Fdocs\u002Finstallation","docs\u002F2.installation\u002F1.index",[368,370,375,380],{"title":364,"path":365,"stem":366,"description":369},"Install or upgrade Open-AudIT on Windows Server or Linux. Includes virtual appliance option for the fastest setup.",{"title":371,"path":372,"stem":373,"description":374},"Server Requirements","\u002Fdocs\u002Finstallation\u002Fserver-requirements","docs\u002F2.installation\u002F2.server-requirements","Hardware, operating system, browser, and dependency requirements for running Open-AudIT.",{"title":376,"path":377,"stem":378,"description":379},"Install on Linux","\u002Fdocs\u002Finstallation\u002Finstall-linux","docs\u002F2.installation\u002F3.install-linux","Step-by-step guide to installing Open-AudIT on supported Linux distributions including Red Hat, Rocky Linux, Debian, and Ubuntu.",{"title":381,"path":382,"stem":383,"description":384},"Install on Windows","\u002Fdocs\u002Finstallation\u002Finstall-windows","docs\u002F2.installation\u002F4.install-windows","Step-by-step guide to installing Open-AudIT on Windows Server, including Nmap and Visual C++ prerequisites.",{"title":348,"path":386,"stem":387,"children":388,"description":390},"\u002Fdocs\u002Fdiscovery","docs\u002F3.discovery\u002F1.index",[389,391,392,397,402,407],{"title":348,"path":386,"stem":387,"description":390},"Discovery is how Open-AudIT finds and audits devices on your network. Learn about credentials, running scans, discovery types, and how it all works under the hood.",{"title":335,"path":336,"stem":339,"description":331},{"title":393,"path":394,"stem":395,"description":396},"Running a Discovery","\u002Fdocs\u002Fdiscovery\u002Frunning-a-discovery","docs\u002F3.discovery\u002F3.running-a-discovery","Step-by-step guide to creating and running your first network discovery in Open-AudIT, including advanced options and scheduling.",{"title":398,"path":399,"stem":400,"description":401},"Discovery Types","\u002Fdocs\u002Fdiscovery\u002Fdiscovery-types","docs\u002F3.discovery\u002F4.discovery-types","Open-AudIT supports Subnet, Active Directory, and Seed discovery types. Learn when to use each and how they work.",{"title":403,"path":404,"stem":405,"description":406},"How It Works","\u002Fdocs\u002Fdiscovery\u002Fhow-discovery-works","docs\u002F3.discovery\u002F5.how-discovery-works","A detailed look at what Open-AudIT does during a discovery — from Nmap scanning through credential testing, audit script execution, and data processing.",{"title":408,"path":409,"stem":410,"description":411},"Matching Devices","\u002Fdocs\u002Fdiscovery\u002Fmatching-devices","docs\u002F3.discovery\u002F6.matching-devices","How Open-AudIT decides whether a discovered device is new or already exists in the database, and how to configure match rules to avoid duplicates.",{"title":413,"path":414,"stem":415,"children":416,"description":418},"Reporting","\u002Fdocs\u002Freporting","docs\u002F4.reporting\u002F1.index",[417,419,424,429],{"title":413,"path":414,"stem":415,"description":418},"Open-AudIT gives you multiple ways to pull meaningful information out of collected data using Queries, Summaries, and Reports.",{"title":420,"path":421,"stem":422,"description":423},"Queries, Summaries & Reports","\u002Fdocs\u002Freporting\u002Fqueries-summaries-reports","docs\u002F4.reporting\u002F2.queries-summaries-reports","Understand the three types of reporting in Open-AudIT — Queries, Summaries, and Reports — how they differ, and how to use filters and permissions.",{"title":425,"path":426,"stem":427,"description":428},"Creating a Query","\u002Fdocs\u002Freporting\u002Fcreating-a-query","docs\u002F4.reporting\u002F3.creating-a-query","Learn how to write custom SQL queries in Open-AudIT to extract device information, with examples for common use cases like warranty tracking and open ports.",{"title":430,"path":431,"stem":432,"description":433},"Groups","\u002Fdocs\u002Freporting\u002Fgroups","docs\u002F4.reporting\u002F4.groups","Learn how to use Groups in Open-AudIT to create dynamic collections of devices for filtering reports, building dashboards, and baselining configurations.",{"title":435,"path":436,"stem":437,"children":438,"description":440},"Dashboards","\u002Fdocs\u002Fdashboards","docs\u002F5.dashboards\u002F1.index",[439],{"title":435,"path":436,"stem":437,"description":440},"Configure and customise Open-AudIT dashboards and widgets to create at-a-glance visual overviews of your network environment.",{"title":442,"path":443,"stem":444,"children":445,"description":447},"Administration","\u002Fdocs\u002Fadministration","docs\u002F6.administration\u002F1.index",[446,448,453,458],{"title":442,"path":443,"stem":444,"description":447},"Covers the ongoing administration of Open-AudIT including configuration, user management, permissions, and backup procedures.",{"title":449,"path":450,"stem":451,"description":452},"Configuration","\u002Fdocs\u002Fadministration\u002Fconfiguration","docs\u002F6.administration\u002F2.configuration","Key configuration settings in Open-AudIT covering discovery behaviour, change logging, data retention, and how to edit them.",{"title":454,"path":455,"stem":456,"description":457},"Users, Roles & Orgs","\u002Fdocs\u002Fadministration\u002Fusers-roles-orgs","docs\u002F6.administration\u002F3.users-roles-orgs","Understand Open-AudIT's role-based access control system including users, roles, organisations, LDAP integration, and permission inheritance.",{"title":459,"path":460,"stem":461,"description":462},"Backup & Restore","\u002Fdocs\u002Fadministration\u002Fbackup-restore","docs\u002F6.administration\u002F4.backup-restore","How to back up and restore your Open-AudIT database on Linux and Windows, including database reset procedures.",{"title":464,"path":465,"stem":466,"children":467,"description":469},"Troubleshooting","\u002Fdocs\u002Ftroubleshooting","docs\u002F7.troubleshooting\u002F1.index",[468,470,475],{"title":464,"path":465,"stem":466,"description":469},"General troubleshooting guidance for Open-AudIT covering discovery problems, common errors, and first steps for diagnosing issues.",{"title":471,"path":472,"stem":473,"description":474},"Common Errors","\u002Fdocs\u002Ftroubleshooting\u002Fcommon-errors","docs\u002F7.troubleshooting\u002F2.common-errors","Explanations and solutions for common Open-AudIT error messages including MySQL lock errors, LDAP issues, Apache problems, and license screens.",{"title":476,"path":477,"stem":478,"description":479},"Discovery Problems","\u002Fdocs\u002Ftroubleshooting\u002Fdiscovery-problems","docs\u002F7.troubleshooting\u002F3.discovery-problems","Troubleshoot Open-AudIT discovery issues including devices not found, duplicate records, Nmap problems, stuck queues, and cross-platform auditing.",{"title":481,"path":482,"stem":483,"description":484},"Release Notes","\u002Fdocs\u002Frelease-notes","docs\u002Frelease-notes","What's new in each Open-AudIT release — features, fixes, and improvements.",1779864900915]