1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["18269"],{79897(e,n,s){s.r(n),s.d(n,{metadata:()=>t,default:()=>u,frontMatter:()=>o,contentTitle:()=>l,toc:()=>r,assets:()=>c});var t=JSON.parse('{"id":"commands/secrets/list","title":"secrets list","description":"The \\"secrets list\\" command lists the enabled secrets engines on the OpenBao\\nserver. This command also outputs information about the enabled path including\\nconfigured TTLs and human-friendly descriptions. A TTL of \\"system\\" indicates\\nthat the system default is in use.","source":"@site/content/docs/commands/secrets/list.mdx","sourceDirName":"commands/secrets","slug":"/commands/secrets/list","permalink":"/docs/next/commands/secrets/list","draft":false,"unlisted":false,"editUrl":"https://github.com/openbao/openbao/blob/main/website/content/docs/commands/secrets/list.mdx","tags":[],"version":"current","frontMatter":{"sidebar_label":"list","description":"The \\"secrets list\\" command lists the enabled secrets engines on the OpenBao\\nserver. This command also outputs information about the enabled path including\\nconfigured TTLs and human-friendly descriptions. A TTL of \\"system\\" indicates\\nthat the system default is in use."},"sidebar":"docs","previous":{"title":"enable","permalink":"/docs/next/commands/secrets/enable"},"next":{"title":"move","permalink":"/docs/next/commands/secrets/move"}}'),i=s(94686),a=s(44812);let o={sidebar_label:"list",description:'The "secrets list" command lists the enabled secrets engines on the OpenBao\nserver. This command also outputs information about the enabled path including\nconfigured TTLs and human-friendly descriptions. A TTL of "system" indicates\nthat the system default is in use.'},l="secrets list",c={},r=[{value:"Deprecation status column",id:"deprecation-status-column",level:2},{value:"Version columns",id:"version-columns",level:2},{value:"Examples",id:"examples",level:2},{value:"Usage",id:"usage",level:2},{value:"Output options",id:"output-options",level:3},{value:"Command options",id:"command-options",level:3}];function d(e){let n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"secrets-list",children:"secrets list"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"secrets list"}),' command lists the enabled secrets engines on the OpenBao server.\nThis command also outputs information about the enabled path including\nconfigured TTLs and human-friendly descriptions. A TTL of "system" indicates\nthat the system default is in use.']}),"\n",(0,i.jsx)(n.h2,{id:"deprecation-status-column",children:"Deprecation status column"}),"\n",(0,i.jsxs)(n.p,{children:["As of 1.12, all built-in secrets engines will have an associated Deprecation\nStatus. This status will be reflected in the ",(0,i.jsx)(n.code,{children:"Deprecation Status"})," column, seen\nbelow. All secrets engines which are not provided by built-in plugins will show a\n",(0,i.jsx)(n.code,{children:"Deprecation Status"}),' of "n/a".']}),"\n",(0,i.jsx)(n.h2,{id:"version-columns",children:"Version columns"}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"-detailed"})," view displays some version information for each mount."]}),"\n",(0,i.jsx)(n.p,{children:'The Version field indicates the configured version for the plugin. Empty, or "n/a",\nindicates the built-in or any matching unversioned plugin that may have been registered.'}),"\n",(0,i.jsxs)(n.p,{children:["Running Version indicates the actual plugin version running, which may differ from\nVersion if the plugin hasn't been reloaded since the configured version was updated\nusing the ",(0,i.jsx)(n.code,{children:"secrets tune"})," command. Finally, the Running SHA256 field indicates the\nSHA256 sum of the running plugin's binary. This may be different from the SHA256\nregistered in the catalog if the plugin hasn't been reloaded since the plugin\nversion was overwritten in the catalog."]}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.p,{children:"List all enabled secrets engines:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell-session",children:"$ bao secrets list\nPath Type Accessor Description\n---- ---- -------- -----------\ncubbyhole/ cubbyhole cubbyhole_548b4dc
15 per-token private secret storage\nsecret/ kv identity_aa00c06d key/value secret storage\nsys/ system system_547412e3 system endpoints used for control, policy and debugging\n"})}),"\n",(0,i.jsx)(n.p,{children:"List all enabled secrets engines with detailed output:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell-session",children:"$ bao secrets list -detailed\nPath Plugin Accessor Default TTL Max TTL Force No Cache Replication Seal Wrap External Entropy Access Options Description UUID Version Running Version Running SHA256 Deprecation Status\n---- ------ -------- ----------- ------- -------------- ----------- --------- ----------------------- ------- ----------- ---- ------- --------------- -------------- ------------------\ncubbyhole/ cubbyhole cubbyhole_b16d1bc0 n/a n/a false local false false map[] per-token private secret storage 8c64d56b-9d46-d667-1155-a8c1a83a5d01 n/a v1.12.0+builtin.bao n/a n/a\nidentity/ identity identity_3d67c936 system system false replicated false false map[] identity store 5aa1e59c-33b5-9dec-05d6-c80c9a800557 n/a v1.12.0+builtin.bao n/a n/a\npostgresql/ postgresql postgresql_f0a54308 system system false replicated false false map[] n/a 8cdc1d2d-0713-eaa6-17e3-49790a60650b n/a v1.12.0+builtin.bao n/a deprecated\nsys/ system system_c86bd362 n/a n/a false replicated true false map[] system endpoints used for control, policy and debugging e3193999-0875-d38d-3458-21d9f2762c80 n/a v1.12.0+builtin.bao n/a n/a\n"})}),"\n",(0,i.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,i.jsxs)(n.p,{children:["The following flags are available in addition to the ",(0,i.jsx)(n.a,{href:"/docs/next/commands/",children:"standard set of\nflags"})," included on all commands."]}),"\n",(0,i.jsx)(n.h3,{id:"output-options",children:"Output options"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"-format"})," ",(0,i.jsx)(n.code,{children:'(string: "table")'}),' - Print the output in the given format. Valid\nformats are "table", "json", or "yaml". This can also be specified via the\n',(0,i.jsx)(n.code,{children:"BAO_FORMAT"})," environment variable."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"command-options",children:"Command options"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"-detailed"})," ",(0,i.jsx)(n.code,{children:"(bool: false)"})," - Print detailed information such as configuration\nand replication status about each secrets engine."]}),"\n"]})]})}function u(e={}){let{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},44812(e,n,s){s.d(n,{R:()=>o,x:()=>l});var t=s(92990);let i={},a=t.createContext(i);function o(e){let n=t.useContext(a);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.