blob: a77ed5a510fa938f4c931a8ec73b1c7fe4db416d [file] [log] [blame]
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-3.2.x plugin-docs plugin-id-default docs-doc-id-reference-pulsar-admin">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.0">
<title data-rh="true">Pulsar admin CLI | Apache Pulsar</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://pulsar.apache.org/img/pulsar-social-media-card.png"><meta data-rh="true" name="twitter:image" content="https://pulsar.apache.org/img/pulsar-social-media-card.png"><meta data-rh="true" property="og:url" content="https://pulsar.apache.org/docs/3.2.x/reference-pulsar-admin/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="3.2.x"><meta data-rh="true" name="docusaurus_tag" content="docs-default-3.2.x"><meta data-rh="true" name="docsearch:version" content="3.2.x"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-3.2.x"><meta data-rh="true" property="og:title" content="Pulsar admin CLI | Apache Pulsar"><meta data-rh="true" name="description" content="This page is deprecated and not updated anymore. For the latest and complete information about Pulsar admin, including commands, flags, descriptions, and more, see Pulsar admin doc."><meta data-rh="true" property="og:description" content="This page is deprecated and not updated anymore. For the latest and complete information about Pulsar admin, including commands, flags, descriptions, and more, see Pulsar admin doc."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="alternate" href="https://pulsar.apache.org/docs/3.2.x/reference-pulsar-admin/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pulsar.apache.org/docs/3.2.x/reference-pulsar-admin/" hreflang="x-default"><link data-rh="true" rel="canonical" href="https://pulsar.apache.org/docs/reference-pulsar-admin/"><link data-rh="true" rel="preconnect" href="https://WK2YL0SALL-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Pulsar RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Pulsar Atom Feed">
<link rel="search" type="application/opensearchdescription+xml" title="Apache Pulsar" href="/opensearch.xml">
<link rel="stylesheet" href="/css/katex-0.13.24.min.css" media="print" onload="this.media=&#39;all&#39;">
<script src="/js/sine-waves.min.js" async></script>
<script src="/js/matomo-agent.js"></script><link rel="stylesheet" href="/assets/css/styles.b0f65ef3.css">
<link rel="preload" href="/assets/js/runtime~main.1d0ed2a7.js" as="script">
<link rel="preload" href="/assets/js/main.e07a0c68.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:#282826;color:#fff" role="banner"><div class="content_knG7 announcementBarContent_xLdY">
<a class="announcement-bar" href="https://registration.socio.events/e/pulsarvirtualsummiteurope2024" target="_blank">
<div class="announcement-bar__content">
<svg class="announcement-bar__icon">
<svg viewBox="0 0 33 32" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M6.5 19.6001H16.1L15.3 29.2001L26.5 12.4H17.06L18.1 2.80005L6.5 19.6001Z" stroke="#F7F7F7" stroke-width="1.5" stroke-linejoin="round"/>
</svg>
</svg>
<span>
Get your free pass for Pulsar Virtual Summit Europe 2024 on May 14, 2024 🗓️
</span>
<svg class="announcement-bar__icon">
<svg viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
<rect width="20" height="20" transform="translate(6 6)" fill="white" fill-opacity="0.01"/>
<path d="M17.6667 10.1667L23.5 16.0001M23.5 16.0001L17.6667 21.8334M23.5 16.0001L8.5 16.0001" stroke="white" stroke-linecap="round" stroke-linejoin="round"/>
<rect x="0.5" y="0.5" width="31" height="31" rx="15.5" stroke="white"/>
</svg>
</svg>
</div>
</a>
</div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-black.svg" alt="Apache Pulsar logo" class="themedImage_ToTc themedImage--light_HNdA" height="25" width="127"><img src="/img/logo-black.svg" alt="Apache Pulsar logo" class="themedImage_ToTc themedImage--dark_i4oU" height="25" width="127"></div><b class="navbar__title text--truncate"></b></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Get Started</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/3.2.x/concepts-overview/">Concepts</a></li><li><a class="dropdown__link" href="/docs/3.2.x/">Quickstart</a></li><li><a class="dropdown__link" href="/ecosystem/">Ecosystem</a></li></ul></div><a class="navbar__item navbar__link" href="/docs/3.2.x/">Docs</a><a class="navbar__item navbar__link" href="/features/">Features</a><a class="navbar__item navbar__link" href="/use-cases/">Use Cases</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link community-dropdown">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link scroll-link scroll-welcome" id="scroll-welcome" href="/community/">Welcome</a></li><li><a class="dropdown__link scroll-link scroll-discussions" id="scroll-discussions" href="/community/#section-discussions">Discussions</a></li><li><a class="dropdown__link scroll-link" id="scroll-governance" href="/community/#section-governance">Governance</a></li><li><a class="dropdown__link scroll-link" id="scroll-community" href="/community/#section-community">Meet the Community</a></li><li><a class="dropdown__link scroll-link" id="scroll-contribute" href="/community/#section-contribute">Contribute</a></li><li><a class="dropdown__link" href="/contribute/">Contribution Guide</a></li><li><a href="https://github.com/apache/pulsar/wiki" target="_blank" rel="noopener noreferrer" class="dropdown__link">Wiki</a></li><li><a href="https://github.com/apache/pulsar/issues" target="_blank" rel="noopener noreferrer" class="dropdown__link">Issue Tracking</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/blog/">Blog</a></li><li><a class="dropdown__link" href="/books/">Books</a></li><li><a class="dropdown__link" href="/case-studies/">Case Studies</a></li><li><a class="dropdown__link" href="/articles/">Articles</a></li><li><a class="dropdown__link" href="/presentations/">Presentations</a></li><li><a class="dropdown__link" href="/events/">Events</a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link navbar_download_button" href="/download/">Download</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><main class="docMainContainer_gTbr docMainContainerEnhanced_Uz_u"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><span class="theme-doc-version-badge badge badge--secondary">Version: 3.2.x</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Pulsar admin CLI</h1></header><div class="theme-admonition theme-admonition-tip alert alert--success admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_S0QG"><p>This page is deprecated and not updated anymore. For the latest and complete information about <code>Pulsar admin</code>, including commands, flags, descriptions, and more, see <a href="/reference/#/3.2.x/pulsar-admin/" target="_blank" rel="noopener noreferrer">Pulsar admin doc</a>.</p></div></div><p>The <code>pulsar-admin</code> tool enables you to manage Pulsar installations, including clusters, brokers, namespaces, tenants, and more.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin </span><span class="token builtin class-name" style="color:rgb(189, 147, 249)">command</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Commands</p><ul><li><code>broker-stats</code></li><li><code>brokers</code></li><li><code>clusters</code></li><li><code>functions</code></li><li><code>functions-worker</code></li><li><code>namespaces</code></li><li><code>ns-isolation-policy</code></li><li><code>sources</code>
For more information, see <a href="/docs/3.2.x/io-cli/#sources">here</a></li><li><code>sinks</code>
For more information, see <a href="/docs/3.2.x/io-cli/#sinks">here</a></li><li><code>topics</code></li><li><code>tenants</code></li><li><code>resource-quotas</code></li><li><code>schemas</code></li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="broker-stats"><code>broker-stats</code><a href="#broker-stats" class="hash-link" aria-label="Direct link to broker-stats" title="Direct link to broker-stats"></a></h2><p>Operations to collect broker statistics</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin broker-stats subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>allocator-stats</code></li><li><code>topics(destinations)</code></li><li><code>mbeans</code></li><li><code>monitoring-metrics</code></li><li><code>load-report</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="allocator-stats"><code>allocator-stats</code><a href="#allocator-stats" class="hash-link" aria-label="Direct link to allocator-stats" title="Direct link to allocator-stats"></a></h3><p>Dump allocator stats</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin broker-stats allocator-stats allocator-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="topicsdestinations"><code>topics(destinations)</code><a href="#topicsdestinations" class="hash-link" aria-label="Direct link to topicsdestinations" title="Direct link to topicsdestinations"></a></h3><p>Dump topic stats</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin broker-stats topics options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-i</code>, <code>--indent</code></td><td>Indent JSON output</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="mbeans"><code>mbeans</code><a href="#mbeans" class="hash-link" aria-label="Direct link to mbeans" title="Direct link to mbeans"></a></h3><p>Dump Mbean stats</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin broker-stats mbeans options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-i</code>, <code>--indent</code></td><td>Indent JSON output</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="monitoring-metrics"><code>monitoring-metrics</code><a href="#monitoring-metrics" class="hash-link" aria-label="Direct link to monitoring-metrics" title="Direct link to monitoring-metrics"></a></h3><p>Dump metrics for monitoring</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin broker-stats monitoring-metrics options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-i</code>, <code>--indent</code></td><td>Indent JSON output</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="load-report"><code>load-report</code><a href="#load-report" class="hash-link" aria-label="Direct link to load-report" title="Direct link to load-report"></a></h3><p>Dump broker load-report</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin broker-stats load-report</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="brokers"><code>brokers</code><a href="#brokers" class="hash-link" aria-label="Direct link to brokers" title="Direct link to brokers"></a></h2><p>Operations about brokers</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>list</code></li><li><code>namespaces</code></li><li><code>update-dynamic-config</code></li><li><code>list-dynamic-config</code></li><li><code>get-all-dynamic-config</code></li><li><code>get-internal-config</code></li><li><code>get-runtime-config</code></li><li><code>healthcheck</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list"><code>list</code><a href="#list" class="hash-link" aria-label="Direct link to list" title="Direct link to list"></a></h3><p>List active brokers of the cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers list cluster-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="leader-broker"><code>leader-broker</code><a href="#leader-broker" class="hash-link" aria-label="Direct link to leader-broker" title="Direct link to leader-broker"></a></h3><p>Get the information of the leader broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers leader-broker</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="namespaces"><code>namespaces</code><a href="#namespaces" class="hash-link" aria-label="Direct link to namespaces" title="Direct link to namespaces"></a></h3><p>List namespaces owned by the broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers namespaces cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--url</code></td><td>The URL for the broker</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-dynamic-config"><code>update-dynamic-config</code><a href="#update-dynamic-config" class="hash-link" aria-label="Direct link to update-dynamic-config" title="Direct link to update-dynamic-config"></a></h3><p>Update a broker&#x27;s dynamic service configuration</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers update-dynamic-config options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--config</code></td><td>Service configuration parameter name</td><td></td></tr><tr><td><code>--value</code></td><td>Value for the configuration parameter value specified using the <code>--config</code> flag</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-dynamic-config"><code>list-dynamic-config</code><a href="#list-dynamic-config" class="hash-link" aria-label="Direct link to list-dynamic-config" title="Direct link to list-dynamic-config"></a></h3><p>Get the list of updatable configuration names</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers list-dynamic-config</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-dynamic-config"><code>delete-dynamic-config</code><a href="#delete-dynamic-config" class="hash-link" aria-label="Direct link to delete-dynamic-config" title="Direct link to delete-dynamic-config"></a></h3><p>Delete dynamic-serviceConfiguration of broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers delete-dynamic-config options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--config</code></td><td>Service configuration parameter name</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-all-dynamic-config"><code>get-all-dynamic-config</code><a href="#get-all-dynamic-config" class="hash-link" aria-label="Direct link to get-all-dynamic-config" title="Direct link to get-all-dynamic-config"></a></h3><p>Get all overridden dynamic-configuration values</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers get-all-dynamic-config</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-internal-config"><code>get-internal-config</code><a href="#get-internal-config" class="hash-link" aria-label="Direct link to get-internal-config" title="Direct link to get-internal-config"></a></h3><p>Get internal configuration information</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers get-internal-config</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-runtime-config"><code>get-runtime-config</code><a href="#get-runtime-config" class="hash-link" aria-label="Direct link to get-runtime-config" title="Direct link to get-runtime-config"></a></h3><p>Get runtime configuration values</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers get-runtime-config</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="healthcheck"><code>healthcheck</code><a href="#healthcheck" class="hash-link" aria-label="Direct link to healthcheck" title="Direct link to healthcheck"></a></h3><p>Run a health check against the broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin brokers healthcheck</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="clusters"><code>clusters</code><a href="#clusters" class="hash-link" aria-label="Direct link to clusters" title="Direct link to clusters"></a></h2><p>Operations about clusters</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>get</code></li><li><code>create</code></li><li><code>update</code></li><li><code>delete</code></li><li><code>list</code></li><li><code>update-peer-clusters</code></li><li><code>get-peer-clusters</code></li><li><code>get-failure-domain</code></li><li><code>create-failure-domain</code></li><li><code>update-failure-domain</code></li><li><code>delete-failure-domain</code></li><li><code>list-failure-domains</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get"><code>get</code><a href="#get" class="hash-link" aria-label="Direct link to get" title="Direct link to get"></a></h3><p>Get the configuration data for the specified cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters get cluster-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create"><code>create</code><a href="#create" class="hash-link" aria-label="Direct link to create" title="Direct link to create"></a></h3><p>Provisions a new cluster. This operation requires Pulsar super-user privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters create cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--broker-url</code></td><td>The URL for the broker service.</td><td></td></tr><tr><td><code>--broker-url-secure</code></td><td>The broker service URL for a secure connection</td><td></td></tr><tr><td><code>--url</code></td><td>service-url</td><td></td></tr><tr><td><code>--url-secure</code></td><td>service-url for secure connection</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update"><code>update</code><a href="#update" class="hash-link" aria-label="Direct link to update" title="Direct link to update"></a></h3><p>Update the configuration for a cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters update cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--broker-url</code></td><td>The URL for the broker service.</td><td></td></tr><tr><td><code>--broker-url-secure</code></td><td>The broker service URL for a secure connection</td><td></td></tr><tr><td><code>--url</code></td><td>service-url</td><td></td></tr><tr><td><code>--url-secure</code></td><td>service-url for secure connection</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-cluster-migration"><code>update cluster migration</code><a href="#update-cluster-migration" class="hash-link" aria-label="Direct link to update-cluster-migration" title="Direct link to update-cluster-migration"></a></h3><p>Update the configuration for a cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters update-cluster-migration cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--migrated</code></td><td>Is cluster migrated.</td><td></td></tr><tr><td><code>--broker-url</code></td><td>New cluster URL for the broker service.</td><td></td></tr><tr><td><code>--broker-url-secure</code></td><td>New cluster service URL for a secure connection</td><td></td></tr><tr><td><code>--url</code></td><td>service-url</td><td></td></tr><tr><td><code>--url-secure</code></td><td>service-url for secure connection</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete"><code>delete</code><a href="#delete" class="hash-link" aria-label="Direct link to delete" title="Direct link to delete"></a></h3><p>Deletes an existing cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters delete cluster-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-1"><code>list</code><a href="#list-1" class="hash-link" aria-label="Direct link to list-1" title="Direct link to list-1"></a></h3><p>List the existing clusters</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters list</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-peer-clusters"><code>update-peer-clusters</code><a href="#update-peer-clusters" class="hash-link" aria-label="Direct link to update-peer-clusters" title="Direct link to update-peer-clusters"></a></h3><p>Update peer cluster names</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters update-peer-clusters cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--peer-clusters</code></td><td>Comma separated peer cluster names (Pass empty string &quot;&quot; to delete list)</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-peer-clusters"><code>get-peer-clusters</code><a href="#get-peer-clusters" class="hash-link" aria-label="Direct link to get-peer-clusters" title="Direct link to get-peer-clusters"></a></h3><p>Get the list of peer clusters</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters get-peer-clusters</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-failure-domain"><code>get-failure-domain</code><a href="#get-failure-domain" class="hash-link" aria-label="Direct link to get-failure-domain" title="Direct link to get-failure-domain"></a></h3><p>Get the configuration brokers of a failure domain</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters get-failure-domain cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-failure-domain"><code>create-failure-domain</code><a href="#create-failure-domain" class="hash-link" aria-label="Direct link to create-failure-domain" title="Direct link to create-failure-domain"></a></h3><p>Create a new failure domain for a cluster (updates it if already created)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters create-failure-domain cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--broker-list</code></td><td>Comma separated broker list</td><td></td></tr><tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-failure-domain"><code>update-failure-domain</code><a href="#update-failure-domain" class="hash-link" aria-label="Direct link to update-failure-domain" title="Direct link to update-failure-domain"></a></h3><p>Update failure domain for a cluster (creates a new one if not exist)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters update-failure-domain cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--broker-list</code></td><td>Comma separated broker list</td><td></td></tr><tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-failure-domain"><code>delete-failure-domain</code><a href="#delete-failure-domain" class="hash-link" aria-label="Direct link to delete-failure-domain" title="Direct link to delete-failure-domain"></a></h3><p>Delete an existing failure domain</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters delete-failure-domain cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-failure-domains"><code>list-failure-domains</code><a href="#list-failure-domains" class="hash-link" aria-label="Direct link to list-failure-domains" title="Direct link to list-failure-domains"></a></h3><p>List the existing failure domains for a cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin clusters list-failure-domains cluster-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="functions"><code>functions</code><a href="#functions" class="hash-link" aria-label="Direct link to functions" title="Direct link to functions"></a></h2><p>A command-line interface for Pulsar Functions</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>localrun</code></li><li><code>create</code></li><li><code>delete</code></li><li><code>update</code></li><li><code>get</code></li><li><code>restart</code></li><li><code>stop</code></li><li><code>start</code></li><li><code>status</code></li><li><code>stats</code></li><li><code>list</code></li><li><code>querystate</code></li><li><code>putstate</code></li><li><code>trigger</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="localrun"><code>localrun</code><a href="#localrun" class="hash-link" aria-label="Direct link to localrun" title="Direct link to localrun"></a></h3><p>Run the Pulsar Function locally (rather than deploying it to the Pulsar cluster)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions localrun options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--cpu</code></td><td>The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr><tr><td><code>--ram</code></td><td>The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)</td><td></td></tr><tr><td><code>--disk</code></td><td>The disk in bytes that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr><tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages</td><td></td></tr><tr><td><code>--subs-name</code></td><td>Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer</td><td></td></tr><tr><td><code>--broker-service-url </code></td><td>The URL of the Pulsar broker</td><td></td></tr><tr><td><code>--classname</code></td><td>The function&#x27;s class name</td><td></td></tr><tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string)</td><td></td></tr><tr><td><code>--custom-schema-inputs</code></td><td>The map of input topics to Schema class names (as a JSON string)</td><td></td></tr><tr><td><code>--client-auth-params</code></td><td>Client authentication param</td><td></td></tr><tr><td><code>--client-auth-plugin</code></td><td>Client authentication plugin using which function-process can connect to broker</td><td></td></tr><tr><td><code>--function-config-file</code></td><td>The absolute path to a YAML config file specifying the function&#x27;s configuration</td><td></td></tr><tr><td><code>--hostname-verification-enabled</code></td><td>Enable hostname verification</td><td>false</td></tr><tr><td><code>--instance-id-offset</code></td><td>Start the instanceIds from this offset</td><td>0</td></tr><tr><td><code>--inputs</code></td><td>The function&#x27;s input topic or topics (multiple topics can be specified as a comma-separated list)</td><td></td></tr><tr><td><code>--log-topic</code></td><td>The topic to which the function&#x27;s logs are produced</td><td></td></tr><tr><td><code>--jar</code></td><td>Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--output</code></td><td>The function&#x27;s output topic (If none is specified, no output is written)</td><td></td></tr><tr><td><code>--output-serde-classname</code></td><td>The SerDe class to be used for messages output by the function</td><td></td></tr><tr><td><code>--parallelism</code></td><td>The function&#x27;s parallelism factor, i.e. the number of instances of the function to run</td><td>1</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (aka delivery semantics) applied to the function. Possible Values: <!-- -->[ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]</td><td>ATLEAST_ONCE</td></tr><tr><td><code>--py</code></td><td>Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--go</code></td><td>Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--schema-type</code></td><td>The built-in schema type or custom schema class name to be used for messages output by the function</td><td></td></tr><tr><td><code>--sliding-interval-count</code></td><td>The number of messages after which the window slides</td><td></td></tr><tr><td><code>--sliding-interval-duration-ms</code></td><td>The time duration after which the window slides</td><td></td></tr><tr><td><code>--state-storage-service-url</code></td><td>The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr><tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from list of topics under a namespace that match the pattern. <!-- -->[--input]<!-- --> and <!-- -->[--topic-pattern]<!-- --> are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)</td><td></td></tr><tr><td><code>--user-config</code></td><td>User-defined config key/values</td><td></td></tr><tr><td><code>--window-length-count</code></td><td>The number of messages per window</td><td></td></tr><tr><td><code>--window-length-duration-ms</code></td><td>The time duration of the window in milliseconds</td><td></td></tr><tr><td><code>--dead-letter-topic</code></td><td>The topic where all messages which could not be processed successfully are sent</td><td></td></tr><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--max-message-retries</code></td><td>How many times should we try to process a message before giving up</td><td></td></tr><tr><td><code>--retain-ordering</code></td><td>Function consumes and processes messages in order</td><td></td></tr><tr><td><code>--retain-key-ordering</code></td><td>Function consumes and processes messages in key order</td><td></td></tr><tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr><tr><td><code>--tls-allow-insecure</code></td><td>Allow insecure tls connection</td><td>false</td></tr><tr><td><code>--tls-trust-cert-path</code></td><td>The tls trust cert file path</td><td></td></tr><tr><td><code>--use-tls</code></td><td>Use tls connection</td><td>false</td></tr><tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string)</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-1"><code>create</code><a href="#create-1" class="hash-link" aria-label="Direct link to create-1" title="Direct link to create-1"></a></h3><p>Create a Pulsar Function in cluster mode (i.e. deploy it on a Pulsar cluster)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions create options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--cpu</code></td><td>The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr><tr><td><code>--ram</code></td><td>The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)</td><td></td></tr><tr><td><code>--disk</code></td><td>The disk in bytes that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr><tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages</td><td></td></tr><tr><td><code>--subs-name</code></td><td>Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer</td><td></td></tr><tr><td><code>--classname</code></td><td>The function&#x27;s class name</td><td></td></tr><tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string)</td><td></td></tr><tr><td><code>--custom-schema-inputs</code></td><td>The map of input topics to Schema class names (as a JSON string)</td><td></td></tr><tr><td><code>--function-config-file</code></td><td>The absolute path to a YAML config file specifying the function&#x27;s configuration</td><td></td></tr><tr><td><code>--inputs</code></td><td>The function&#x27;s input topic or topics (multiple topics can be specified as a comma-separated list)</td><td></td></tr><tr><td><code>--log-topic</code></td><td>The topic to which the function&#x27;s logs are produced</td><td></td></tr><tr><td><code>--jar</code></td><td>Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--output</code></td><td>The function&#x27;s output topic (If none is specified, no output is written)</td><td></td></tr><tr><td><code>--output-serde-classname</code></td><td>The SerDe class to be used for messages output by the function</td><td></td></tr><tr><td><code>--parallelism</code></td><td>The function&#x27;s parallelism factor, i.e. the number of instances of the function to run</td><td>1</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (aka delivery semantics) applied to the function. Possible Values: <!-- -->[ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]</td><td>ATLEAST_ONCE</td></tr><tr><td><code>--py</code></td><td>Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--go</code></td><td>Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--schema-type</code></td><td>The built-in schema type or custom schema class name to be used for messages output by the function</td><td></td></tr><tr><td><code>--sliding-interval-count</code></td><td>The number of messages after which the window slides</td><td></td></tr><tr><td><code>--sliding-interval-duration-ms</code></td><td>The time duration after which the window slides</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr><tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from list of topics under a namespace that match the pattern. <!-- -->[--input]<!-- --> and <!-- -->[--topic-pattern]<!-- --> are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)</td><td></td></tr><tr><td><code>--user-config</code></td><td>User-defined config key/values</td><td></td></tr><tr><td><code>--window-length-count</code></td><td>The number of messages per window</td><td></td></tr><tr><td><code>--window-length-duration-ms</code></td><td>The time duration of the window in milliseconds</td><td></td></tr><tr><td><code>--dead-letter-topic</code></td><td>The topic where all messages which could not be processed</td><td></td></tr><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--max-message-retries</code></td><td>How many times should we try to process a message before giving up</td><td></td></tr><tr><td><code>--retain-ordering</code></td><td>Function consumes and processes messages in order</td><td></td></tr><tr><td><code>--retain-key-ordering</code></td><td>Function consumes and processes messages in key order</td><td></td></tr><tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr><tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string)</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-1"><code>delete</code><a href="#delete-1" class="hash-link" aria-label="Direct link to delete-1" title="Direct link to delete-1"></a></h3><p>Delete a Pulsar Function that&#x27;s running on a Pulsar cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions delete options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-1"><code>update</code><a href="#update-1" class="hash-link" aria-label="Direct link to update-1" title="Direct link to update-1"></a></h3><p>Update a Pulsar Function that&#x27;s been deployed to a Pulsar cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions update options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--cpu</code></td><td>The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr><tr><td><code>--ram</code></td><td>The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)</td><td></td></tr><tr><td><code>--disk</code></td><td>The disk in bytes that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr><tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages</td><td></td></tr><tr><td><code>--subs-name</code></td><td>Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer</td><td></td></tr><tr><td><code>--classname</code></td><td>The function&#x27;s class name</td><td></td></tr><tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string)</td><td></td></tr><tr><td><code>--custom-schema-inputs</code></td><td>The map of input topics to Schema class names (as a JSON string)</td><td></td></tr><tr><td><code>--function-config-file</code></td><td>The absolute path to a YAML config file specifying the function&#x27;s configuration</td><td></td></tr><tr><td><code>--inputs</code></td><td>The function&#x27;s input topic or topics (multiple topics can be specified as a comma-separated list)</td><td></td></tr><tr><td><code>--log-topic</code></td><td>The topic to which the function&#x27;s logs are produced</td><td></td></tr><tr><td><code>--jar</code></td><td>Absolute path to the jar file for the function (if the function is written in Java). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--output</code></td><td>The function&#x27;s output topic (If none is specified, no output is written)</td><td></td></tr><tr><td><code>--output-serde-classname</code></td><td>The SerDe class to be used for messages output by the function</td><td></td></tr><tr><td><code>--parallelism</code></td><td>The function&#x27;s parallelism factor, i.e. the number of instances of the function to run</td><td>1</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (aka delivery semantics) applied to the function. Possible Values: <!-- -->[ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]</td><td>ATLEAST_ONCE</td></tr><tr><td><code>--py</code></td><td>Absolute path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--go</code></td><td>Absolute path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path <!-- -->[http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)]<!-- --> from which worker can download the package.</td><td></td></tr><tr><td><code>--schema-type</code></td><td>The built-in schema type or custom schema class name to be used for messages output by the function</td><td></td></tr><tr><td><code>--sliding-interval-count</code></td><td>The number of messages after which the window slides</td><td></td></tr><tr><td><code>--sliding-interval-duration-ms</code></td><td>The time duration after which the window slides</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr><tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from list of topics under a namespace that match the pattern. <!-- -->[--input]<!-- --> and <!-- -->[--topic-pattern]<!-- --> are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)</td><td></td></tr><tr><td><code>--user-config</code></td><td>User-defined config key/values</td><td></td></tr><tr><td><code>--window-length-count</code></td><td>The number of messages per window</td><td></td></tr><tr><td><code>--window-length-duration-ms</code></td><td>The time duration of the window in milliseconds</td><td></td></tr><tr><td><code>--dead-letter-topic</code></td><td>The topic where all messages which could not be processed</td><td></td></tr><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--max-message-retries</code></td><td>How many times should we try to process a message before giving up</td><td></td></tr><tr><td><code>--retain-ordering</code></td><td>Function consumes and processes messages in order</td><td></td></tr><tr><td><code>--retain-key-ordering</code></td><td>Function consumes and processes messages in key order</td><td></td></tr><tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr><tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string)</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-1"><code>get</code><a href="#get-1" class="hash-link" aria-label="Direct link to get-1" title="Direct link to get-1"></a></h3><p>Fetch information about a Pulsar Function</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions get options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="restart"><code>restart</code><a href="#restart" class="hash-link" aria-label="Direct link to restart" title="Direct link to restart"></a></h3><p>Restart function instance</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions restart options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--instance-id</code></td><td>The function instanceId (restart all instances if instance-id is not provided)</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stop"><code>stop</code><a href="#stop" class="hash-link" aria-label="Direct link to stop" title="Direct link to stop"></a></h3><p>Stops function instance</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions stop options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--instance-id</code></td><td>The function instanceId (stop all instances if instance-id is not provided)</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="start"><code>start</code><a href="#start" class="hash-link" aria-label="Direct link to start" title="Direct link to start"></a></h3><p>Starts a stopped function instance</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions start options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--instance-id</code></td><td>The function instanceId (start all instances if instance-id is not provided)</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="status"><code>status</code><a href="#status" class="hash-link" aria-label="Direct link to status" title="Direct link to status"></a></h3><p>Check the current status of a Pulsar Function</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions status options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--instance-id</code></td><td>The function instanceId (Get-status of all instances if instance-id is not provided)</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stats"><code>stats</code><a href="#stats" class="hash-link" aria-label="Direct link to stats" title="Direct link to stats"></a></h3><p>Get the current stats of a Pulsar Function</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions stats options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--instance-id</code></td><td>The function instanceId (Get-stats of all instances if instance-id is not provided)</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-2"><code>list</code><a href="#list-2" class="hash-link" aria-label="Direct link to list-2" title="Direct link to list-2"></a></h3><p>List all of the Pulsar Functions running under a specific tenant and namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions list options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="querystate"><code>querystate</code><a href="#querystate" class="hash-link" aria-label="Direct link to querystate" title="Direct link to querystate"></a></h3><p>Fetch the current state associated with a Pulsar Function running in cluster mode</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions querystate options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>-k</code>, <code>--key</code></td><td>The key for the state you want to fetch</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr><tr><td><code>-w</code>, <code>--watch</code></td><td>Watch for changes in the value associated with a key for a Pulsar Function</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="putstate"><code>putstate</code><a href="#putstate" class="hash-link" aria-label="Direct link to putstate" title="Direct link to putstate"></a></h3><p>Put a key/value pair to the state associated with a Pulsar Function</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions putstate options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the Pulsar Function</td><td></td></tr><tr><td><code>--name</code></td><td>The name of a Pulsar Function</td><td></td></tr><tr><td><code>--namespace</code></td><td>The namespace of a Pulsar Function</td><td></td></tr><tr><td><code>--tenant</code></td><td>The tenant of a Pulsar Function</td><td></td></tr><tr><td><code>-s</code>, <code>--state</code></td><td>The FunctionState that needs to be put</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="trigger"><code>trigger</code><a href="#trigger" class="hash-link" aria-label="Direct link to trigger" title="Direct link to trigger"></a></h3><p>Triggers the specified Pulsar Function with a supplied value</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions trigger options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr><tr><td><code>--name</code></td><td>The function&#x27;s name</td><td></td></tr><tr><td><code>--namespace</code></td><td>The function&#x27;s namespace</td><td></td></tr><tr><td><code>--tenant</code></td><td>The function&#x27;s tenant</td><td></td></tr><tr><td><code>--topic</code></td><td>The specific topic name that the function consumes from that you want to inject the data to</td><td></td></tr><tr><td><code>--trigger-file</code></td><td>The path to the file that contains the data with which you&#x27;d like to trigger the function</td><td></td></tr><tr><td><code>--trigger-value</code></td><td>The value with which you want to trigger the function</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="functions-worker"><code>functions-worker</code><a href="#functions-worker" class="hash-link" aria-label="Direct link to functions-worker" title="Direct link to functions-worker"></a></h2><p>Operations to collect function-worker statistics</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions-worker subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>function-stats</code></li><li><code>get-cluster</code></li><li><code>get-cluster-leader</code></li><li><code>get-function-assignments</code></li><li><code>monitoring-metrics</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="function-stats"><code>function-stats</code><a href="#function-stats" class="hash-link" aria-label="Direct link to function-stats" title="Direct link to function-stats"></a></h3><p>Dump all functions stats running on this broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions-worker function-stats</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-cluster"><code>get-cluster</code><a href="#get-cluster" class="hash-link" aria-label="Direct link to get-cluster" title="Direct link to get-cluster"></a></h3><p>Get all workers belonging to this cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions-worker get-cluster</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-cluster-leader"><code>get-cluster-leader</code><a href="#get-cluster-leader" class="hash-link" aria-label="Direct link to get-cluster-leader" title="Direct link to get-cluster-leader"></a></h3><p>Get the leader of the worker cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions-worker get-cluster-leader</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-function-assignments"><code>get-function-assignments</code><a href="#get-function-assignments" class="hash-link" aria-label="Direct link to get-function-assignments" title="Direct link to get-function-assignments"></a></h3><p>Get the assignments of the functions across the worker cluster</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions-worker get-function-assignments</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="monitoring-metrics-1"><code>monitoring-metrics</code><a href="#monitoring-metrics-1" class="hash-link" aria-label="Direct link to monitoring-metrics-1" title="Direct link to monitoring-metrics-1"></a></h3><p>Dump metrics for Monitoring</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin functions-worker monitoring-metrics</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="namespaces-1"><code>namespaces</code><a href="#namespaces-1" class="hash-link" aria-label="Direct link to namespaces-1" title="Direct link to namespaces-1"></a></h2><p>Operations for managing namespaces</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>list</code></li><li><code>topics</code></li><li><code>policies</code></li><li><code>create</code></li><li><code>delete</code></li><li><code>set-deduplication</code></li><li><code>set-auto-topic-creation</code></li><li><code>remove-auto-topic-creation</code></li><li><code>set-auto-subscription-creation</code></li><li><code>remove-auto-subscription-creation</code></li><li><code>permissions</code></li><li><code>grant-permission</code></li><li><code>revoke-permission</code></li><li><code>grant-subscription-permission</code></li><li><code>revoke-subscription-permission</code></li><li><code>set-clusters</code></li><li><code>get-clusters</code></li><li><code>get-backlog-quotas</code></li><li><code>set-backlog-quota</code></li><li><code>remove-backlog-quota</code></li><li><code>get-persistence</code></li><li><code>set-persistence</code></li><li><code>get-message-ttl</code></li><li><code>set-message-ttl</code></li><li><code>remove-message-ttl</code></li><li><code>get-anti-affinity-group</code></li><li><code>set-anti-affinity-group</code></li><li><code>get-anti-affinity-namespaces</code></li><li><code>delete-anti-affinity-group</code></li><li><code>get-retention</code></li><li><code>set-retention</code></li><li><code>unload</code></li><li><code>split-bundle</code></li><li><code>set-dispatch-rate</code></li><li><code>get-dispatch-rate</code></li><li><code>set-replicator-dispatch-rate</code></li><li><code>get-replicator-dispatch-rate</code></li><li><code>set-subscribe-rate</code></li><li><code>get-subscribe-rate</code></li><li><code>set-subscription-dispatch-rate</code></li><li><code>get-subscription-dispatch-rate</code></li><li><code>clear-backlog</code></li><li><code>unsubscribe</code></li><li><code>set-encryption-required</code></li><li><code>set-delayed-delivery</code></li><li><code>get-delayed-delivery</code></li><li><code>set-subscription-auth-mode</code></li><li><code>get-max-producers-per-topic</code></li><li><code>set-max-producers-per-topic</code></li><li><code>get-max-consumers-per-topic</code></li><li><code>set-max-consumers-per-topic</code></li><li><code>get-max-consumers-per-subscription</code></li><li><code>set-max-consumers-per-subscription</code></li><li><code>get-max-unacked-messages-per-subscription</code></li><li><code>set-max-unacked-messages-per-subscription</code></li><li><code>get-max-unacked-messages-per-consumer</code></li><li><code>set-max-unacked-messages-per-consumer</code></li><li><code>get-compaction-threshold</code></li><li><code>set-compaction-threshold</code></li><li><code>get-offload-threshold</code></li><li><code>set-offload-threshold</code></li><li><code>get-offload-deletion-lag</code></li><li><code>set-offload-deletion-lag</code></li><li><code>clear-offload-deletion-lag</code></li><li><code>get-schema-autoupdate-strategy</code></li><li><code>set-schema-autoupdate-strategy</code></li><li><code>set-offload-policies</code></li><li><code>get-offload-policies</code></li><li><code>set-max-subscriptions-per-topic</code></li><li><code>get-max-subscriptions-per-topic</code></li><li><code>remove-max-subscriptions-per-topic</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-3"><code>list</code><a href="#list-3" class="hash-link" aria-label="Direct link to list-3" title="Direct link to list-3"></a></h3><p>Get the namespaces for a tenant</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces list tenant-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="topics"><code>topics</code><a href="#topics" class="hash-link" aria-label="Direct link to topics" title="Direct link to topics"></a></h3><p>Get the list of topics for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces topics tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="policies"><code>policies</code><a href="#policies" class="hash-link" aria-label="Direct link to policies" title="Direct link to policies"></a></h3><p>Get the configuration policies of a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces policies tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-2"><code>create</code><a href="#create-2" class="hash-link" aria-label="Direct link to create-2" title="Direct link to create-2"></a></h3><p>Create a new namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces create tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundles</code></td><td>The number of bundles to activate</td><td>0</td></tr><tr><td><code>-c</code>, <code>--clusters</code></td><td>List of clusters this namespace will be assigned</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-2"><code>delete</code><a href="#delete-2" class="hash-link" aria-label="Direct link to delete-2" title="Direct link to delete-2"></a></h3><p>Deletes a namespace. The namespace needs to be empty</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces delete tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-deduplication"><code>set-deduplication</code><a href="#set-deduplication" class="hash-link" aria-label="Direct link to set-deduplication" title="Direct link to set-deduplication"></a></h3><p>Enable or disable message deduplication on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-deduplication tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--enable</code>, <code>-e</code></td><td>Enable message deduplication on the specified namespace</td><td>false</td></tr><tr><td><code>--disable</code>, <code>-d</code></td><td>Disable message deduplication on the specified namespace</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-auto-topic-creation"><code>set-auto-topic-creation</code><a href="#set-auto-topic-creation" class="hash-link" aria-label="Direct link to set-auto-topic-creation" title="Direct link to set-auto-topic-creation"></a></h3><p>Enable or disable autoTopicCreation for a namespace, overriding broker settings</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-auto-topic-creation tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--enable</code>, <code>-e</code></td><td>Enable allowAutoTopicCreation on namespace</td><td>false</td></tr><tr><td><code>--disable</code>, <code>-d</code></td><td>Disable allowAutoTopicCreation on namespace</td><td>false</td></tr><tr><td><code>--type</code>, <code>-t</code></td><td>Type of topic to be auto-created. Possible values: (partitioned, non-partitioned)</td><td>non-partitioned</td></tr><tr><td><code>--num-partitions</code>, <code>-n</code></td><td>Default number of partitions of topic to be auto-created, applicable to partitioned topics only</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-auto-topic-creation"><code>remove-auto-topic-creation</code><a href="#remove-auto-topic-creation" class="hash-link" aria-label="Direct link to remove-auto-topic-creation" title="Direct link to remove-auto-topic-creation"></a></h3><p>Remove override of autoTopicCreation for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces remove-auto-topic-creation tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-auto-subscription-creation"><code>set-auto-subscription-creation</code><a href="#set-auto-subscription-creation" class="hash-link" aria-label="Direct link to set-auto-subscription-creation" title="Direct link to set-auto-subscription-creation"></a></h3><p>Enable autoSubscriptionCreation for a namespace, overriding broker settings</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-auto-subscription-creation tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--enable</code>, <code>-e</code></td><td>Enable allowAutoSubscriptionCreation on namespace</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-auto-subscription-creation"><code>remove-auto-subscription-creation</code><a href="#remove-auto-subscription-creation" class="hash-link" aria-label="Direct link to remove-auto-subscription-creation" title="Direct link to remove-auto-subscription-creation"></a></h3><p>Remove override of autoSubscriptionCreation for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces remove-auto-subscription-creation tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="permissions"><code>permissions</code><a href="#permissions" class="hash-link" aria-label="Direct link to permissions" title="Direct link to permissions"></a></h3><p>Get the permissions on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces permissions tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="grant-permission"><code>grant-permission</code><a href="#grant-permission" class="hash-link" aria-label="Direct link to grant-permission" title="Direct link to grant-permission"></a></h3><p>Grant permissions on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces grant-permission tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--actions</code></td><td>Actions to be granted (<code>produce</code> or <code>consume</code>)</td><td></td></tr><tr><td><code>--role</code></td><td>The client role to which to grant the permissions</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="revoke-permission"><code>revoke-permission</code><a href="#revoke-permission" class="hash-link" aria-label="Direct link to revoke-permission" title="Direct link to revoke-permission"></a></h3><p>Revoke permissions on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces revoke-permission tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--role</code></td><td>The client role to which to revoke the permissions</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="grant-subscription-permission"><code>grant-subscription-permission</code><a href="#grant-subscription-permission" class="hash-link" aria-label="Direct link to grant-subscription-permission" title="Direct link to grant-subscription-permission"></a></h3><p>Grant permissions to access subscription admin-api</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces grant-subscription-permission tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--roles</code></td><td>The client roles to which to grant the permissions (comma separated roles)</td><td></td></tr><tr><td><code>--subscription</code></td><td>The subscription name for which permission will be granted to roles</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="revoke-subscription-permission"><code>revoke-subscription-permission</code><a href="#revoke-subscription-permission" class="hash-link" aria-label="Direct link to revoke-subscription-permission" title="Direct link to revoke-subscription-permission"></a></h3><p>Revoke permissions to access subscription admin-api</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces revoke-subscription-permission tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--role</code></td><td>The client role to which to revoke the permissions</td><td></td></tr><tr><td><code>--subscription</code></td><td>The subscription name for which permission will be revoked to roles</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-clusters"><code>set-clusters</code><a href="#set-clusters" class="hash-link" aria-label="Direct link to set-clusters" title="Direct link to set-clusters"></a></h3><p>Set replication clusters for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-clusters tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--clusters</code></td><td>Replication clusters ID list (comma-separated values)</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-clusters"><code>get-clusters</code><a href="#get-clusters" class="hash-link" aria-label="Direct link to get-clusters" title="Direct link to get-clusters"></a></h3><p>Get replication clusters for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-clusters tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-backlog-quotas"><code>get-backlog-quotas</code><a href="#get-backlog-quotas" class="hash-link" aria-label="Direct link to get-backlog-quotas" title="Direct link to get-backlog-quotas"></a></h3><p>Get the backlog quota policies for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-backlog-quotas tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-backlog-quota"><code>set-backlog-quota</code><a href="#set-backlog-quota" class="hash-link" aria-label="Direct link to set-backlog-quota" title="Direct link to set-backlog-quota"></a></h3><p>Set a backlog quota policy for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-backlog-quota tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--type</code></td><td>The backlog quota type. The valid options are: <code>destination_storage</code> and <code>message_age</code>.</td><td>destination_storage</td></tr><tr><td><code>-l</code>, <code>--limit</code></td><td>If the backlog quota type is set to <code>destination_storage</code>, you can use this parameter to set the backlog size limit (for example, <code>10MB</code> or <code>16GB</code>). To disable the size limit, use a non-positive number.</td><td></td></tr><tr><td><code>-lt</code>, <code>--limitTime</code></td><td>If the backlog quota type is set to <code>message_age</code>, you can use this parameter to set the time limit in seconds (or minutes, hours, days, weeks, e.g., 100m, 3h, 2d, 5w). To disable the time limit, use a non-positive number.</td><td></td></tr><tr><td><code>-p</code>, <code>--policy</code></td><td>The retention policy to enforce when the limit is reached. The valid options are: <code>producer_request_hold</code>, <code>producer_exception</code>, and <code>consumer_backlog_eviction</code>.</td><td></td></tr></tbody></table><p>If you want to set both the time limit and the size limit, you need to set them separately.</p><p>Example</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-backlog-quota my-tenant/my-ns </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --type destination_storage </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --limit 2G </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --policy producer_request_hold</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-backlog-quota my-tenant/my-ns </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --limitTime </span><span class="token number">3600</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --policy producer_request_hold </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> --type message_age</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-backlog-quota"><code>remove-backlog-quota</code><a href="#remove-backlog-quota" class="hash-link" aria-label="Direct link to remove-backlog-quota" title="Direct link to remove-backlog-quota"></a></h3><p>Remove a backlog quota policy from a namespace</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--type</code></td><td>Backlog quota type to remove. The valid options are: <code>destination_storage</code>, <code>message_age</code></td><td>destination_storage</td></tr></tbody></table><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces remove-backlog-quota tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-persistence"><code>get-persistence</code><a href="#get-persistence" class="hash-link" aria-label="Direct link to get-persistence" title="Direct link to get-persistence"></a></h3><p>Get the persistence policies for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-persistence tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-persistence"><code>set-persistence</code><a href="#set-persistence" class="hash-link" aria-label="Direct link to set-persistence" title="Direct link to set-persistence"></a></h3><p>Set the persistence policies for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-persistence tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--bookkeeper-ack-quorum</code></td><td>The number of acks (guaranteed copies) to wait for each entry</td><td>2</td></tr><tr><td><code>-e</code>, <code>--bookkeeper-ensemble</code></td><td>The number of bookies to use for a topic</td><td>2</td></tr><tr><td><code>-w</code>, <code>--bookkeeper-write-quorum</code></td><td>How many writes to make of each entry</td><td>2</td></tr><tr><td><code>-r</code>, <code>--ml-mark-delete-max-rate</code></td><td>Throttling rate of mark-delete operation (0 means no throttle)</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-message-ttl"><code>get-message-ttl</code><a href="#get-message-ttl" class="hash-link" aria-label="Direct link to get-message-ttl" title="Direct link to get-message-ttl"></a></h3><p>Get the message TTL for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-message-ttl tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-message-ttl"><code>set-message-ttl</code><a href="#set-message-ttl" class="hash-link" aria-label="Direct link to set-message-ttl" title="Direct link to set-message-ttl"></a></h3><p>Set the message TTL for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-message-ttl tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-ttl</code>, <code>--messageTTL</code></td><td>Message TTL in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w). When the value is set to <code>0</code>, TTL is disabled. TTL is disabled by default.</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-message-ttl"><code>remove-message-ttl</code><a href="#remove-message-ttl" class="hash-link" aria-label="Direct link to remove-message-ttl" title="Direct link to remove-message-ttl"></a></h3><p>Remove the message TTL for a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces remove-message-ttl tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-anti-affinity-group"><code>get-anti-affinity-group</code><a href="#get-anti-affinity-group" class="hash-link" aria-label="Direct link to get-anti-affinity-group" title="Direct link to get-anti-affinity-group"></a></h3><p>Get Anti-affinity group name for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-anti-affinity-group tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-anti-affinity-group"><code>set-anti-affinity-group</code><a href="#set-anti-affinity-group" class="hash-link" aria-label="Direct link to set-anti-affinity-group" title="Direct link to set-anti-affinity-group"></a></h3><p>Set Anti-affinity group name for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-anti-affinity-group tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-g</code>, <code>--group</code></td><td>Anti-affinity group name</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-anti-affinity-namespaces"><code>get-anti-affinity-namespaces</code><a href="#get-anti-affinity-namespaces" class="hash-link" aria-label="Direct link to get-anti-affinity-namespaces" title="Direct link to get-anti-affinity-namespaces"></a></h3><p>Get Anti-affinity namespaces grouped with the given anti-affinity group name</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-anti-affinity-namespaces options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--cluster</code></td><td>Cluster name</td><td></td></tr><tr><td><code>-g</code>, <code>--group</code></td><td>Anti-affinity group name</td><td></td></tr><tr><td><code>-p</code>, <code>--tenant</code></td><td>Tenant is only used for authorization. Client has to be admin of any of the tenant to access this api</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-anti-affinity-group"><code>delete-anti-affinity-group</code><a href="#delete-anti-affinity-group" class="hash-link" aria-label="Direct link to delete-anti-affinity-group" title="Direct link to delete-anti-affinity-group"></a></h3><p>Remove Anti-affinity group name for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces delete-anti-affinity-group tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-retention"><code>get-retention</code><a href="#get-retention" class="hash-link" aria-label="Direct link to get-retention" title="Direct link to get-retention"></a></h3><p>Get the retention policy that is applied to each topic within the specified namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-retention tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-retention"><code>set-retention</code><a href="#set-retention" class="hash-link" aria-label="Direct link to set-retention" title="Direct link to set-retention"></a></h3><p>Set the retention policy for each topic within the specified namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-retention tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-s</code>, <code>--size</code></td><td>The retention size limits (for example 10M, 16G or 3T) for each topic in the namespace. 0 means no retention and -1 means infinite size retention</td><td></td></tr><tr><td><code>-t</code>, <code>--time</code></td><td>The retention time with optional time unit suffix. For example, 100m, 3h, 2d, 5w. If the time unit is not specified, the default unit is seconds. For example, -t 120 sets retention to 2 minutes. 0 means no retention and -1 means infinite time retention</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="unload"><code>unload</code><a href="#unload" class="hash-link" aria-label="Direct link to unload" title="Direct link to unload"></a></h3><p>Unload a namespace or namespace bundle from the current serving broker.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces unload tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="split-bundle"><code>split-bundle</code><a href="#split-bundle" class="hash-link" aria-label="Direct link to split-bundle" title="Direct link to split-bundle"></a></h3><p>Split a namespace-bundle from the current serving broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces split-bundle tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr><tr><td><code>-u</code>, <code>--unload</code></td><td>Unload newly split bundles after splitting old bundle</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-dispatch-rate"><code>set-dispatch-rate</code><a href="#set-dispatch-rate" class="hash-link" aria-label="Direct link to set-dispatch-rate" title="Direct link to set-dispatch-rate"></a></h3><p>Set message-dispatch-rate for all topics of the namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-dispatch-rate tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-bd</code>, <code>--byte-dispatch-rate</code></td><td>The byte dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr><tr><td><code>-dt</code>, <code>--dispatch-rate-period</code></td><td>The dispatch rate period in second type (default 1 second will be overwrite if not passed)</td><td>1</td></tr><tr><td><code>-md</code>, <code>--msg-dispatch-rate</code></td><td>The message dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-dispatch-rate"><code>get-dispatch-rate</code><a href="#get-dispatch-rate" class="hash-link" aria-label="Direct link to get-dispatch-rate" title="Direct link to get-dispatch-rate"></a></h3><p>Get configured message-dispatch-rate for all topics of the namespace (Disabled if value &lt; 0)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-dispatch-rate tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-replicator-dispatch-rate"><code>set-replicator-dispatch-rate</code><a href="#set-replicator-dispatch-rate" class="hash-link" aria-label="Direct link to set-replicator-dispatch-rate" title="Direct link to set-replicator-dispatch-rate"></a></h3><p>Set replicator message-dispatch-rate for all topics of the namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-replicator-dispatch-rate tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-bd</code>, <code>--byte-dispatch-rate</code></td><td>The byte dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr><tr><td><code>-dt</code>, <code>--dispatch-rate-period</code></td><td>The dispatch rate period in second type (default 1 second will be overwrite if not passed)</td><td>1</td></tr><tr><td><code>-md</code>, <code>--msg-dispatch-rate</code></td><td>The message dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-replicator-dispatch-rate"><code>get-replicator-dispatch-rate</code><a href="#get-replicator-dispatch-rate" class="hash-link" aria-label="Direct link to get-replicator-dispatch-rate" title="Direct link to get-replicator-dispatch-rate"></a></h3><p>Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value &lt; 0)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-replicator-dispatch-rate tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-subscribe-rate"><code>set-subscribe-rate</code><a href="#set-subscribe-rate" class="hash-link" aria-label="Direct link to set-subscribe-rate" title="Direct link to set-subscribe-rate"></a></h3><p>Set subscribe-rate per consumer for all topics of the namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-subscribe-rate tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-sr</code>, <code>--subscribe-rate</code></td><td>The subscribe rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr><tr><td><code>-st</code>, <code>--subscribe-rate-period</code></td><td>The subscribe rate period in second type (default 30 second will be overwrite if not passed)</td><td>30</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-subscribe-rate"><code>get-subscribe-rate</code><a href="#get-subscribe-rate" class="hash-link" aria-label="Direct link to get-subscribe-rate" title="Direct link to get-subscribe-rate"></a></h3><p>Get configured subscribe-rate per consumer for all topics of the namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-subscribe-rate tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-subscription-dispatch-rate"><code>set-subscription-dispatch-rate</code><a href="#set-subscription-dispatch-rate" class="hash-link" aria-label="Direct link to set-subscription-dispatch-rate" title="Direct link to set-subscription-dispatch-rate"></a></h3><p>Set subscription message-dispatch-rate for all subscription of the namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-subscription-dispatch-rate tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-bd</code>, <code>--byte-dispatch-rate</code></td><td>The byte dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr><tr><td><code>-dt</code>, <code>--dispatch-rate-period</code></td><td>The dispatch rate period in second type (default 1 second will be overwrite if not passed)</td><td>1</td></tr><tr><td><code>-md</code>, <code>--sub-msg-dispatch-rate</code></td><td>The message dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-subscription-dispatch-rate"><code>get-subscription-dispatch-rate</code><a href="#get-subscription-dispatch-rate" class="hash-link" aria-label="Direct link to get-subscription-dispatch-rate" title="Direct link to get-subscription-dispatch-rate"></a></h3><p>Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value &lt; 0)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-subscription-dispatch-rate tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="clear-backlog"><code>clear-backlog</code><a href="#clear-backlog" class="hash-link" aria-label="Direct link to clear-backlog" title="Direct link to clear-backlog"></a></h3><p>Clear the backlog for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces clear-backlog tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr><tr><td><code>-force</code>, <code>--force</code></td><td>Whether to force a clear backlog without prompt</td><td>false</td></tr><tr><td><code>-s</code>, <code>--sub</code></td><td>The subscription name</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="unsubscribe"><code>unsubscribe</code><a href="#unsubscribe" class="hash-link" aria-label="Direct link to unsubscribe" title="Direct link to unsubscribe"></a></h3><p>Unsubscribe the given subscription on all destinations on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces unsubscribe tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr><tr><td><code>-s</code>, <code>--sub</code></td><td>The subscription name</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-encryption-required"><code>set-encryption-required</code><a href="#set-encryption-required" class="hash-link" aria-label="Direct link to set-encryption-required" title="Direct link to set-encryption-required"></a></h3><p>Enable or disable message encryption required for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-encryption-required tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-d</code>, <code>--disable</code></td><td>Disable message encryption required</td><td>false</td></tr><tr><td><code>-e</code>, <code>--enable</code></td><td>Enable message encryption required</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-delayed-delivery"><code>set-delayed-delivery</code><a href="#set-delayed-delivery" class="hash-link" aria-label="Direct link to set-delayed-delivery" title="Direct link to set-delayed-delivery"></a></h3><p>Set the delayed delivery policy on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-delayed-delivery tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-d</code>, <code>--disable</code></td><td>Disable delayed delivery messages</td><td>false</td></tr><tr><td><code>-e</code>, <code>--enable</code></td><td>Enable delayed delivery messages</td><td>false</td></tr><tr><td><code>-t</code>, <code>--time</code></td><td>The tick time for when retrying on delayed delivery messages</td><td>1s</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-delayed-delivery"><code>get-delayed-delivery</code><a href="#get-delayed-delivery" class="hash-link" aria-label="Direct link to get-delayed-delivery" title="Direct link to get-delayed-delivery"></a></h3><p>Get the delayed delivery policy on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-delayed-delivery-time tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--time</code></td><td>The tick time for when retrying on delayed delivery messages</td><td>1s</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-subscription-auth-mode"><code>set-subscription-auth-mode</code><a href="#set-subscription-auth-mode" class="hash-link" aria-label="Direct link to set-subscription-auth-mode" title="Direct link to set-subscription-auth-mode"></a></h3><p>Set subscription auth mode on a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-subscription-auth-mode tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-m</code>, <code>--subscription-auth-mode</code></td><td>Subscription authorization mode for Pulsar policies. Valid options are: <!-- -->[None, Prefix]</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-max-producers-per-topic"><code>get-max-producers-per-topic</code><a href="#get-max-producers-per-topic" class="hash-link" aria-label="Direct link to get-max-producers-per-topic" title="Direct link to get-max-producers-per-topic"></a></h3><p>Get maxProducersPerTopic for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-max-producers-per-topic tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-max-producers-per-topic"><code>set-max-producers-per-topic</code><a href="#set-max-producers-per-topic" class="hash-link" aria-label="Direct link to set-max-producers-per-topic" title="Direct link to set-max-producers-per-topic"></a></h3><p>Set maxProducersPerTopic for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-max-producers-per-topic tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-p</code>, <code>--max-producers-per-topic</code></td><td>maxProducersPerTopic for a namespace</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-max-consumers-per-topic"><code>get-max-consumers-per-topic</code><a href="#get-max-consumers-per-topic" class="hash-link" aria-label="Direct link to get-max-consumers-per-topic" title="Direct link to get-max-consumers-per-topic"></a></h3><p>Get maxConsumersPerTopic for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-max-consumers-per-topic tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-max-consumers-per-topic"><code>set-max-consumers-per-topic</code><a href="#set-max-consumers-per-topic" class="hash-link" aria-label="Direct link to set-max-consumers-per-topic" title="Direct link to set-max-consumers-per-topic"></a></h3><p>Set maxConsumersPerTopic for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-max-consumers-per-topic tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--max-consumers-per-topic</code></td><td>maxConsumersPerTopic for a namespace</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-max-consumers-per-subscription"><code>get-max-consumers-per-subscription</code><a href="#get-max-consumers-per-subscription" class="hash-link" aria-label="Direct link to get-max-consumers-per-subscription" title="Direct link to get-max-consumers-per-subscription"></a></h3><p>Get maxConsumersPerSubscription for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-max-consumers-per-subscription tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-max-consumers-per-subscription"><code>set-max-consumers-per-subscription</code><a href="#set-max-consumers-per-subscription" class="hash-link" aria-label="Direct link to set-max-consumers-per-subscription" title="Direct link to set-max-consumers-per-subscription"></a></h3><p>Set maxConsumersPerSubscription for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-max-consumers-per-subscription tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--max-consumers-per-subscription</code></td><td>maxConsumersPerSubscription for a namespace</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-max-unacked-messages-per-subscription"><code>get-max-unacked-messages-per-subscription</code><a href="#get-max-unacked-messages-per-subscription" class="hash-link" aria-label="Direct link to get-max-unacked-messages-per-subscription" title="Direct link to get-max-unacked-messages-per-subscription"></a></h3><p>Get maxUnackedMessagesPerSubscription for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-max-unacked-messages-per-subscription tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-max-unacked-messages-per-subscription"><code>set-max-unacked-messages-per-subscription</code><a href="#set-max-unacked-messages-per-subscription" class="hash-link" aria-label="Direct link to set-max-unacked-messages-per-subscription" title="Direct link to set-max-unacked-messages-per-subscription"></a></h3><p>Set maxUnackedMessagesPerSubscription for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-max-unacked-messages-per-subscription tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--max-unacked-messages-per-subscription</code></td><td>maxUnackedMessagesPerSubscription for a namespace</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-max-unacked-messages-per-consumer"><code>get-max-unacked-messages-per-consumer</code><a href="#get-max-unacked-messages-per-consumer" class="hash-link" aria-label="Direct link to get-max-unacked-messages-per-consumer" title="Direct link to get-max-unacked-messages-per-consumer"></a></h3><p>Get maxUnackedMessagesPerConsumer for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-max-unacked-messages-per-consumer tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-max-unacked-messages-per-consumer"><code>set-max-unacked-messages-per-consumer</code><a href="#set-max-unacked-messages-per-consumer" class="hash-link" aria-label="Direct link to set-max-unacked-messages-per-consumer" title="Direct link to set-max-unacked-messages-per-consumer"></a></h3><p>Set maxUnackedMessagesPerConsumer for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-max-unacked-messages-per-consumer tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--max-unacked-messages-per-consumer</code></td><td>maxUnackedMessagesPerConsumer for a namespace</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-compaction-threshold"><code>get-compaction-threshold</code><a href="#get-compaction-threshold" class="hash-link" aria-label="Direct link to get-compaction-threshold" title="Direct link to get-compaction-threshold"></a></h3><p>Get compactionThreshold for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-compaction-threshold tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-compaction-threshold"><code>set-compaction-threshold</code><a href="#set-compaction-threshold" class="hash-link" aria-label="Direct link to set-compaction-threshold" title="Direct link to set-compaction-threshold"></a></h3><p>Set compactionThreshold for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-compaction-threshold tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--threshold</code></td><td>Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-offload-threshold"><code>get-offload-threshold</code><a href="#get-offload-threshold" class="hash-link" aria-label="Direct link to get-offload-threshold" title="Direct link to get-offload-threshold"></a></h3><p>Get offloadThreshold for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-offload-threshold tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-offload-threshold"><code>set-offload-threshold</code><a href="#set-offload-threshold" class="hash-link" aria-label="Direct link to set-offload-threshold" title="Direct link to set-offload-threshold"></a></h3><p>Set offloadThreshold for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-offload-threshold tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-s</code>, <code>--size</code></td><td>Maximum number of bytes stored in the pulsar cluster for a topic before data will start being automatically offloaded to longterm storage (eg: 10M, 16G, 3T, 100). Negative values disable automatic offload. 0 triggers offloading as soon as possible.</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-offload-deletion-lag"><code>get-offload-deletion-lag</code><a href="#get-offload-deletion-lag" class="hash-link" aria-label="Direct link to get-offload-deletion-lag" title="Direct link to get-offload-deletion-lag"></a></h3><p>Get offloadDeletionLag, in minutes, for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-offload-deletion-lag tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-offload-deletion-lag"><code>set-offload-deletion-lag</code><a href="#set-offload-deletion-lag" class="hash-link" aria-label="Direct link to set-offload-deletion-lag" title="Direct link to set-offload-deletion-lag"></a></h3><p>Set offloadDeletionLag for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-offload-deletion-lag tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-l</code>, <code>--lag</code></td><td>Duration to wait after offloading a ledger segment, before deleting the copy of that segment from cluster local storage. (eg: 10m, 5h, 3d, 2w).</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="clear-offload-deletion-lag"><code>clear-offload-deletion-lag</code><a href="#clear-offload-deletion-lag" class="hash-link" aria-label="Direct link to clear-offload-deletion-lag" title="Direct link to clear-offload-deletion-lag"></a></h3><p>Clear offloadDeletionLag for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces clear-offload-deletion-lag tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-schema-autoupdate-strategy"><code>get-schema-autoupdate-strategy</code><a href="#get-schema-autoupdate-strategy" class="hash-link" aria-label="Direct link to get-schema-autoupdate-strategy" title="Direct link to get-schema-autoupdate-strategy"></a></h3><p>Get the schema auto-update strategy for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-schema-autoupdate-strategy tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-schema-autoupdate-strategy"><code>set-schema-autoupdate-strategy</code><a href="#set-schema-autoupdate-strategy" class="hash-link" aria-label="Direct link to set-schema-autoupdate-strategy" title="Direct link to set-schema-autoupdate-strategy"></a></h3><p>Set the schema auto-update strategy for a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-schema-autoupdate-strategy tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--compatibility</code></td><td>Compatibility level required for new schemas created via a Producer. Possible values (Full, Backward, Forward, None).</td><td>Full</td></tr><tr><td><code>-d</code>, <code>--disabled</code></td><td>Disable automatic schema updates.</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-publish-rate"><code>get-publish-rate</code><a href="#get-publish-rate" class="hash-link" aria-label="Direct link to get-publish-rate" title="Direct link to get-publish-rate"></a></h3><p>Get the message publish rate for each topic in a namespace, in bytes as well as messages per second</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-publish-rate tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-publish-rate"><code>set-publish-rate</code><a href="#set-publish-rate" class="hash-link" aria-label="Direct link to set-publish-rate" title="Direct link to set-publish-rate"></a></h3><p>Set the message publish rate for each topic in a namespace</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-publish-rate tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-m</code>, <code>--msg-publish-rate</code></td><td>Threshold for number of messages per second per topic in the namespace (-1 implies not set, 0 for no limit).</td><td>-1</td></tr><tr><td><code>-b</code>, <code>--byte-publish-rate</code></td><td>Threshold for number of bytes per second per topic in the namespace (-1 implies not set, 0 for no limit).</td><td>-1</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-offload-policies"><code>set-offload-policies</code><a href="#set-offload-policies" class="hash-link" aria-label="Direct link to set-offload-policies" title="Direct link to set-offload-policies"></a></h3><p>Set the offload policy for a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-offload-policies tenant/namespace options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-d</code>, <code>--driver</code></td><td>Driver to use to offload old data to long term storage,(Possible values: S3, aws-s3, google-cloud-storage)</td><td></td></tr><tr><td><code>-r</code>, <code>--region</code></td><td>The long term storage region</td><td></td></tr><tr><td><code>-b</code>, <code>--bucket</code></td><td>Bucket to place offloaded ledger into</td><td></td></tr><tr><td><code>-e</code>, <code>--endpoint</code></td><td>Alternative endpoint to connect to</td><td></td></tr><tr><td><code>-i</code>, <code>--aws-id</code></td><td>AWS Credential Id to use when using driver S3 or aws-s3</td><td></td></tr><tr><td><code>-s</code>, <code>--aws-secret</code></td><td>AWS Credential Secret to use when using driver S3 or aws-s3</td><td></td></tr><tr><td><code>-ro</code>, <code>--s3-role</code></td><td>S3 Role used for STSAssumeRoleSessionCredentialsProvider using driver S3 or aws-s3</td><td></td></tr><tr><td><code>-rsn</code>, <code>--s3-role-session-name</code></td><td>S3 role session name used for STSAssumeRoleSessionCredentialsProvider using driver S3 or aws-s3</td><td></td></tr><tr><td><code>-mbs</code>, <code>--maxBlockSize</code></td><td>Max block size</td><td>64MB</td></tr><tr><td><code>-rbs</code>, <code>--readBufferSize</code></td><td>Read buffer size</td><td>1MB</td></tr><tr><td><code>-oat</code>, <code>--offloadAfterThreshold</code></td><td>Offload after threshold size (eg: 1M, 5M)</td><td></td></tr><tr><td><code>-oae</code>, <code>--offloadAfterElapsed</code></td><td>Offload after elapsed in millis (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w).</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-offload-policies"><code>get-offload-policies</code><a href="#get-offload-policies" class="hash-link" aria-label="Direct link to get-offload-policies" title="Direct link to get-offload-policies"></a></h3><p>Get the offload policy for a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-offload-policies tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-max-subscriptions-per-topic"><code>set-max-subscriptions-per-topic</code><a href="#set-max-subscriptions-per-topic" class="hash-link" aria-label="Direct link to set-max-subscriptions-per-topic" title="Direct link to set-max-subscriptions-per-topic"></a></h3><p>Set the maximum subscription per topic for a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-max-subscriptions-per-topic tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-max-subscriptions-per-topic"><code>get-max-subscriptions-per-topic</code><a href="#get-max-subscriptions-per-topic" class="hash-link" aria-label="Direct link to get-max-subscriptions-per-topic" title="Direct link to get-max-subscriptions-per-topic"></a></h3><p>Get the maximum subscription per topic for a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces get-max-subscriptions-per-topic tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-max-subscriptions-per-topic"><code>remove-max-subscriptions-per-topic</code><a href="#remove-max-subscriptions-per-topic" class="hash-link" aria-label="Direct link to remove-max-subscriptions-per-topic" title="Direct link to remove-max-subscriptions-per-topic"></a></h3><p>Remove the maximum subscription per topic for a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces remove-max-subscriptions-per-topic tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ns-isolation-policy"><code>ns-isolation-policy</code><a href="#ns-isolation-policy" class="hash-link" aria-label="Direct link to ns-isolation-policy" title="Direct link to ns-isolation-policy"></a></h2><p>Operations for managing namespace isolation policies.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>set</code></li><li><code>get</code></li><li><code>list</code></li><li><code>delete</code></li><li><code>brokers</code></li><li><code>broker</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set"><code>set</code><a href="#set" class="hash-link" aria-label="Direct link to set" title="Direct link to set"></a></h3><p>Create/update a namespace isolation policy for a cluster. This operation requires Pulsar superuser privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy </span><span class="token builtin class-name" style="color:rgb(189, 147, 249)">set</span><span class="token plain"> cluster-name policy-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--auto-failover-policy-params</code></td><td>Comma-separated name=value auto failover policy parameters</td><td>[]</td></tr><tr><td><code>--auto-failover-policy-type</code></td><td>Auto failover policy type name. Currently available options: min_available.</td><td>[]</td></tr><tr><td><code>--namespaces</code></td><td>Comma-separated namespaces regex list</td><td>[]</td></tr><tr><td><code>--primary</code></td><td>Comma-separated primary broker regex list</td><td>[]</td></tr><tr><td><code>--secondary</code></td><td>Comma-separated secondary broker regex list</td><td>[]</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-2"><code>get</code><a href="#get-2" class="hash-link" aria-label="Direct link to get-2" title="Direct link to get-2"></a></h3><p>Get the namespace isolation policy of a cluster. This operation requires Pulsar superuser privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy get cluster-name policy-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-4"><code>list</code><a href="#list-4" class="hash-link" aria-label="Direct link to list-4" title="Direct link to list-4"></a></h3><p>List all namespace isolation policies of a cluster. This operation requires Pulsar superuser privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy list cluster-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-3"><code>delete</code><a href="#delete-3" class="hash-link" aria-label="Direct link to delete-3" title="Direct link to delete-3"></a></h3><p>Delete namespace isolation policy of a cluster. This operation requires superuser privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy delete</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="brokers-1"><code>brokers</code><a href="#brokers-1" class="hash-link" aria-label="Direct link to brokers-1" title="Direct link to brokers-1"></a></h3><p>List all brokers with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy brokers cluster-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="broker"><code>broker</code><a href="#broker" class="hash-link" aria-label="Direct link to broker" title="Direct link to broker"></a></h3><p>Get broker with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin ns-isolation-policy broker cluster-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--broker</code></td><td>Broker name to get namespace-isolation policies attached to it</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="topics-1"><code>topics</code><a href="#topics-1" class="hash-link" aria-label="Direct link to topics-1" title="Direct link to topics-1"></a></h2><p>Operations for managing Pulsar topics (both persistent and non-persistent).</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>From Pulsar 2.7.0, some namespace-level policies are available on topic level. To enable topic-level policy in Pulsar, you need to configure the following parameters in the <code>broker.conf</code> file.</p><div class="language-conf codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-conf codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">systemTopicEnabled=true</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">topicLevelPoliciesEnabled=true</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>compact</code></li><li><code>compaction-status</code></li><li><code>offload</code></li><li><code>offload-status</code></li><li><code>create-partitioned-topic</code></li><li><code>create-missed-partitions</code></li><li><code>delete-partitioned-topic</code></li><li><code>create</code></li><li><code>get-partitioned-topic-metadata</code></li><li><code>update-partitioned-topic</code></li><li><code>list-partitioned-topics</code></li><li><code>list</code></li><li><code>terminate</code></li><li><code>permissions</code></li><li><code>grant-permission</code></li><li><code>revoke-permission</code></li><li><code>lookup</code></li><li><code>bundle-range</code></li><li><code>delete</code></li><li><code>unload</code></li><li><code>create-subscription</code></li><li><code>subscriptions</code></li><li><code>unsubscribe</code></li><li><code>stats</code></li><li><code>stats-internal</code></li><li><code>info-internal</code></li><li><code>partitioned-stats</code></li><li><code>partitioned-stats-internal</code></li><li><code>skip</code></li><li><code>clear-backlog</code></li><li><code>expire-messages</code></li><li><code>expire-messages-all-subscriptions</code></li><li><code>peek-messages</code></li><li><code>reset-cursor</code></li><li><code>get-message-by-id</code></li><li><code>last-message-id</code></li><li><code>get-backlog-quotas</code></li><li><code>set-backlog-quota</code></li><li><code>remove-backlog-quota</code></li><li><code>get-persistence</code></li><li><code>set-persistence</code></li><li><code>remove-persistence</code></li><li><code>get-message-ttl</code></li><li><code>set-message-ttl</code></li><li><code>remove-message-ttl</code></li><li><code>get-deduplication</code></li><li><code>set-deduplication</code></li><li><code>remove-deduplication</code></li><li><code>get-retention</code></li><li><code>set-retention</code></li><li><code>remove-retention</code></li><li><code>get-dispatch-rate</code></li><li><code>set-dispatch-rate</code></li><li><code>remove-dispatch-rate</code></li><li><code>get-max-unacked-messages-per-subscription</code></li><li><code>set-max-unacked-messages-per-subscription</code></li><li><code>remove-max-unacked-messages-per-subscription</code></li><li><code>get-max-unacked-messages-per-consumer</code></li><li><code>set-max-unacked-messages-per-consumer</code></li><li><code>remove-max-unacked-messages-per-consumer</code></li><li><code>get-delayed-delivery</code></li><li><code>set-delayed-delivery</code></li><li><code>remove-delayed-delivery</code></li><li><code>get-max-producers</code></li><li><code>set-max-producers</code></li><li><code>remove-max-producers</code></li><li><code>get-max-consumers</code></li><li><code>set-max-consumers</code></li><li><code>remove-max-consumers</code></li><li><code>get-compaction-threshold</code></li><li><code>set-compaction-threshold</code></li><li><code>remove-compaction-threshold</code></li><li><code>get-offload-policies</code></li><li><code>set-offload-policies</code></li><li><code>remove-offload-policies</code></li><li><code>get-inactive-topic-policies</code></li><li><code>set-inactive-topic-policies</code></li><li><code>remove-inactive-topic-policies</code></li><li><code>set-max-subscriptions</code></li><li><code>get-max-subscriptions</code></li><li><code>remove-max-subscriptions</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="compact"><code>compact</code><a href="#compact" class="hash-link" aria-label="Direct link to compact" title="Direct link to compact"></a></h3><p>Run compaction on the specified topic (persistent topics only)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics compact persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="compaction-status"><code>compaction-status</code><a href="#compaction-status" class="hash-link" aria-label="Direct link to compaction-status" title="Direct link to compaction-status"></a></h3><p>Check the status of a topic compaction (persistent topics only)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics compaction-status persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-w</code>, <code>--wait-complete</code></td><td>Wait for compaction to complete</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="offload"><code>offload</code><a href="#offload" class="hash-link" aria-label="Direct link to offload" title="Direct link to offload"></a></h3><p>Trigger offload of data from a topic to long-term storage (e.g. Amazon S3)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics offload persistent://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-s</code>, <code>--size-threshold</code></td><td>The maximum amount of data to keep in BookKeeper for the specific topic</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="offload-status"><code>offload-status</code><a href="#offload-status" class="hash-link" aria-label="Direct link to offload-status" title="Direct link to offload-status"></a></h3><p>Check the status of data offloading from a topic to long-term storage</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics offload-status persistent://tenant/namespace/topic </span><span class="token function" style="color:rgb(80, 250, 123)">op</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-w</code>, <code>--wait-complete</code></td><td>Wait for compaction to complete</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-partitioned-topic"><code>create-partitioned-topic</code><a href="#create-partitioned-topic" class="hash-link" aria-label="Direct link to create-partitioned-topic" title="Direct link to create-partitioned-topic"></a></h3><p>Create a partitioned topic. A partitioned topic must be created before producers can publish to it.</p><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>By default, after 60 seconds of creation, topics are considered inactive and deleted automatically to prevent from generating trash data.
To disable this feature, set <code>brokerDeleteInactiveTopicsEnabled</code> to <code>false</code>.
To change the frequency of checking inactive topics, set <code>brokerDeleteInactiveTopicsFrequencySeconds</code> to your desired value.
For more information about these two parameters, see <a href="/docs/3.2.x/reference-configuration/#broker">here</a>.</p></div></div><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics create-partitioned-topic </span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain">persistent</span><span class="token operator">|</span><span class="token plain">non-persistent</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain">://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-p</code>, <code>--partitions</code></td><td>The number of partitions for the topic</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-missed-partitions"><code>create-missed-partitions</code><a href="#create-missed-partitions" class="hash-link" aria-label="Direct link to create-missed-partitions" title="Direct link to create-missed-partitions"></a></h3><p>Try to create partitions for partitioned topic. The partitions of partition topic has to be created,
can be used by repair partitions when topic auto creation is disabled</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics create-missed-partitions persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-partitioned-topic"><code>delete-partitioned-topic</code><a href="#delete-partitioned-topic" class="hash-link" aria-label="Direct link to delete-partitioned-topic" title="Direct link to delete-partitioned-topic"></a></h3><p>Delete a partitioned topic. This will also delete all the partitions of the topic if they exist.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics delete-partitioned-topic </span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain">persistent</span><span class="token operator">|</span><span class="token plain">non-persistent</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-3"><code>create</code><a href="#create-3" class="hash-link" aria-label="Direct link to create-3" title="Direct link to create-3"></a></h3><p>Creates a non-partitioned topic. A non-partitioned topic must explicitly be created by the user if allowAutoTopicCreation or createIfMissing is disabled.</p><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>By default, after 60 seconds of creation, topics are considered inactive and deleted automatically to prevent from generating trash data.
To disable this feature, set <code>brokerDeleteInactiveTopicsEnabled</code> to <code>false</code>.
To change the frequency of checking inactive topics, set <code>brokerDeleteInactiveTopicsFrequencySeconds</code> to your desired value.
For more information about these two parameters, see <a href="/docs/3.2.x/reference-configuration/#broker">here</a>.</p></div></div><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics create </span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain">persistent</span><span class="token operator">|</span><span class="token plain">non-persistent</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain">://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-partitioned-topic-metadata"><code>get-partitioned-topic-metadata</code><a href="#get-partitioned-topic-metadata" class="hash-link" aria-label="Direct link to get-partitioned-topic-metadata" title="Direct link to get-partitioned-topic-metadata"></a></h3><p>Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, this will return an empty topic with zero partitions.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics get-partitioned-topic-metadata </span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain">persistent</span><span class="token operator">|</span><span class="token plain">non-persistent</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain">://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-partitioned-topic"><code>update-partitioned-topic</code><a href="#update-partitioned-topic" class="hash-link" aria-label="Direct link to update-partitioned-topic" title="Direct link to update-partitioned-topic"></a></h3><p>Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics update-partitioned-topic </span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain">persistent</span><span class="token operator">|</span><span class="token plain">non-persistent</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain">://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-p</code>, <code>--partitions</code></td><td>The number of partitions for the topic</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-partitioned-topics"><code>list-partitioned-topics</code><a href="#list-partitioned-topics" class="hash-link" aria-label="Direct link to list-partitioned-topics" title="Direct link to list-partitioned-topics"></a></h3><p>Get the list of partitioned topics under a namespace.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics list-partitioned-topics tenant/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-5"><code>list</code><a href="#list-5" class="hash-link" aria-label="Direct link to list-5" title="Direct link to list-5"></a></h3><p>Get the list of topics under a namespace</p><p>Usage</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics list tenant/cluster/namespace</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="terminate"><code>terminate</code><a href="#terminate" class="hash-link" aria-label="Direct link to terminate" title="Direct link to terminate"></a></h3><p>Terminate a persistent topic (disallow further messages from being published on the topic)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics terminate persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="partitioned-terminate"><code>partitioned-terminate</code><a href="#partitioned-terminate" class="hash-link" aria-label="Direct link to partitioned-terminate" title="Direct link to partitioned-terminate"></a></h3><p>Terminate a persistent topic (disallow further messages from being published on the topic)</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics partitioned-terminate persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="permissions-1"><code>permissions</code><a href="#permissions-1" class="hash-link" aria-label="Direct link to permissions-1" title="Direct link to permissions-1"></a></h3><p>Get the permissions on a topic. Retrieve the effective permissions for a destination. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permissions set on the topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics permissions topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="grant-permission-1"><code>grant-permission</code><a href="#grant-permission-1" class="hash-link" aria-label="Direct link to grant-permission-1" title="Direct link to grant-permission-1"></a></h3><p>Grant a new permission to a client role on a single topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics grant-permission </span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain">persistent</span><span class="token operator">|</span><span class="token plain">non-persistent</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain">://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--actions</code></td><td>Actions to be granted (<code>produce</code> or <code>consume</code>)</td><td></td></tr><tr><td><code>--role</code></td><td>The client role to which to grant the permissions</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="revoke-permission-1"><code>revoke-permission</code><a href="#revoke-permission-1" class="hash-link" aria-label="Direct link to revoke-permission-1" title="Direct link to revoke-permission-1"></a></h3><p>Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412).</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics revoke-permission topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="lookup"><code>lookup</code><a href="#lookup" class="hash-link" aria-label="Direct link to lookup" title="Direct link to lookup"></a></h3><p>Look up a topic from the current serving broker</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics lookup topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="bundle-range"><code>bundle-range</code><a href="#bundle-range" class="hash-link" aria-label="Direct link to bundle-range" title="Direct link to bundle-range"></a></h3><p>Get the namespace bundle which contains the given topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics bundle-range topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-4"><code>delete</code><a href="#delete-4" class="hash-link" aria-label="Direct link to delete-4" title="Direct link to delete-4"></a></h3><p>Delete a topic. The topic cannot be deleted if there are any active subscriptions or producers connected to the topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics delete topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="unload-1"><code>unload</code><a href="#unload-1" class="hash-link" aria-label="Direct link to unload-1" title="Direct link to unload-1"></a></h3><p>Unload a topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics unload topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-subscription"><code>create-subscription</code><a href="#create-subscription" class="hash-link" aria-label="Direct link to create-subscription" title="Direct link to create-subscription"></a></h3><p>Create a new subscription on a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics create-subscription </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token plain">options</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"> persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-m</code>, <code>--messageId</code></td><td>messageId where to create the subscription. It can be either &#x27;latest&#x27;, &#x27;earliest&#x27; or (ledgerId:entryId)</td><td>latest</td></tr><tr><td><code>-s</code>, <code>--subscription</code></td><td>Subscription to reset position on</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="subscriptions"><code>subscriptions</code><a href="#subscriptions" class="hash-link" aria-label="Direct link to subscriptions" title="Direct link to subscriptions"></a></h3><p>Get the list of subscriptions on the topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics subscriptions topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="unsubscribe-1"><code>unsubscribe</code><a href="#unsubscribe-1" class="hash-link" aria-label="Direct link to unsubscribe-1" title="Direct link to unsubscribe-1"></a></h3><p>Delete a durable subscriber from a topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics unsubscribe topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription to delete</td><td></td></tr><tr><td><code>-f</code>, <code>--force</code></td><td>Disconnect and close all consumers and delete subscription forcefully</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stats-1"><code>stats</code><a href="#stats-1" class="hash-link" aria-label="Direct link to stats-1" title="Direct link to stats-1"></a></h3><p>Get the stats for the topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics stats topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-etb</code>,<code>--get-earliest-time-in-backlog</code></td><td>Set to <code>true</code> to get the earliest time in backlog</td><td>false</td></tr><tr><td><code>-gpb</code>,<code>--get-precise-backlog</code></td><td>Set to <code>true</code> to get precise backlog</td><td>false</td></tr><tr><td><code>-sbs</code>,<code> --get-subscription-backlog-size</code></td><td>Set to <code>true</code> to get backlog size for each subscription, locking required</td><td>false</td></tr></tbody></table><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>The unit of <code>storageSize</code> and <code>averageMsgSize</code> is Byte.</p></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stats-internal"><code>stats-internal</code><a href="#stats-internal" class="hash-link" aria-label="Direct link to stats-internal" title="Direct link to stats-internal"></a></h3><p>Get the internal stats for the topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics stats-internal topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="info-internal"><code>info-internal</code><a href="#info-internal" class="hash-link" aria-label="Direct link to info-internal" title="Direct link to info-internal"></a></h3><p>Get the internal metadata info for the topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics info-internal topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="partitioned-stats"><code>partitioned-stats</code><a href="#partitioned-stats" class="hash-link" aria-label="Direct link to partitioned-stats" title="Direct link to partitioned-stats"></a></h3><p>Get the stats for the partitioned topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics partitioned-stats topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-gpb</code>,<code>--get-precise-backlog</code></td><td>Set to <code>true</code> to get precise backlog</td><td>false</td></tr><tr><td><code>-sbs</code>,<code> --get-subscription-backlog-size</code></td><td>Set to <code>true</code> to get backlog size for each subscription, locking required</td><td>false</td></tr><tr><td><code>--per-partition</code></td><td>Get per-partition stats</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="partitioned-stats-internal"><code>partitioned-stats-internal</code><a href="#partitioned-stats-internal" class="hash-link" aria-label="Direct link to partitioned-stats-internal" title="Direct link to partitioned-stats-internal"></a></h3><p>Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics partitioned-stats-internal topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="skip"><code>skip</code><a href="#skip" class="hash-link" aria-label="Direct link to skip" title="Direct link to skip"></a></h3><p>Skip some messages for the subscription</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics skip topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-n</code>, <code>--count</code></td><td>The number of messages to skip</td><td>0</td></tr><tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription on which to skip messages</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="clear-backlog-1"><code>clear-backlog</code><a href="#clear-backlog-1" class="hash-link" aria-label="Direct link to clear-backlog-1" title="Direct link to clear-backlog-1"></a></h3><p>Clear backlog (skip all the messages) for the subscription</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics clear-backlog topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription to clear</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="expire-messages"><code>expire-messages</code><a href="#expire-messages" class="hash-link" aria-label="Direct link to expire-messages" title="Direct link to expire-messages"></a></h3><p>Expire messages that are older than the given expiry time (in seconds) for the subscription.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics expire-messages topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--expireTime</code></td><td>Expire messages older than the time in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w)</td><td>0</td></tr><tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription to skip messages on</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="expire-messages-all-subscriptions"><code>expire-messages-all-subscriptions</code><a href="#expire-messages-all-subscriptions" class="hash-link" aria-label="Direct link to expire-messages-all-subscriptions" title="Direct link to expire-messages-all-subscriptions"></a></h3><p>Expire messages older than the given expiry time (in seconds) for all subscriptions</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics expire-messages-all-subscriptions topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--expireTime</code></td><td>Expire messages older than the time in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w)</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="peek-messages"><code>peek-messages</code><a href="#peek-messages" class="hash-link" aria-label="Direct link to peek-messages" title="Direct link to peek-messages"></a></h3><p>Peek some messages for the subscription.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics peek-messages topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-n</code>, <code>--count</code></td><td>The number of messages</td><td>0</td></tr><tr><td><code>-s</code>, <code>--subscription</code></td><td>Subscription to get messages from</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="reset-cursor"><code>reset-cursor</code><a href="#reset-cursor" class="hash-link" aria-label="Direct link to reset-cursor" title="Direct link to reset-cursor"></a></h3><p>Reset position for subscription to a position that is closest to timestamp or messageId.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics reset-cursor topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-s</code>, <code>--subscription</code></td><td>Subscription to reset position on</td><td></td></tr><tr><td><code>-t</code>, <code>--time</code></td><td>The time in minutes to reset back to (or minutes, hours, days, weeks, etc.). Examples: <code>100m</code>, <code>3h</code>, <code>2d</code>, <code>5w</code>.</td><td></td></tr><tr><td><code>-m</code>, <code>--messageId</code></td><td>The message ID to reset back to (<code>ledgerId:entryId</code> or earliest or latest).</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-message-by-id"><code>get-message-by-id</code><a href="#get-message-by-id" class="hash-link" aria-label="Direct link to get-message-by-id" title="Direct link to get-message-by-id"></a></h3><p>Get message by ledger id and entry id</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics get-message-by-id topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-l</code>, <code>--ledgerId</code></td><td>The ledger id</td><td>0</td></tr><tr><td><code>-e</code>, <code>--entryId</code></td><td>The entry id</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="last-message-id"><code>last-message-id</code><a href="#last-message-id" class="hash-link" aria-label="Direct link to last-message-id" title="Direct link to last-message-id"></a></h3><p>Get the last commit message ID of the topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics last-message-id persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-backlog-quotas-1"><code>get-backlog-quotas</code><a href="#get-backlog-quotas-1" class="hash-link" aria-label="Direct link to get-backlog-quotas-1" title="Direct link to get-backlog-quotas-1"></a></h3><p>Get the backlog quota policies for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics get-backlog-quotas tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-backlog-quota-1"><code>set-backlog-quota</code><a href="#set-backlog-quota-1" class="hash-link" aria-label="Direct link to set-backlog-quota-1" title="Direct link to set-backlog-quota-1"></a></h3><p>Set a backlog quota policy for a topic.</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-l</code>, <code>--limit</code></td><td>The backlog size limit (for example <code>10M</code> or <code>16G</code>)</td><td></td></tr><tr><td><code>-lt</code>, <code>--limitTime</code></td><td>Time limit in second (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), non-positive number for disabling time limit. (for example 3600 for 1 hour)</td><td></td></tr><tr><td><code>-p</code>, <code>--policy</code></td><td>The retention policy to enforce when the limit is reached. The valid options are: <code>producer_request_hold</code>, <code>producer_exception</code> or <code>consumer_backlog_eviction</code></td><td></td></tr><tr><td><code>-t</code>, <code>--type</code></td><td>Backlog quota type to set. The valid options are: <code>destination_storage</code>, <code>message_age</code></td><td>destination_storage</td></tr></tbody></table><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics set-backlog-quota tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Example</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-backlog-quota my-tenant/my-ns/my-topic </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">--limit 2G </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">--policy producer_request_hold</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin namespaces set-backlog-quota my-tenant/my-ns/my-topic </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">--limitTime </span><span class="token number">3600</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">--policy producer_request_hold </span><span class="token punctuation" style="color:rgb(248, 248, 242)">\</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">--type message_age</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-backlog-quota-1"><code>remove-backlog-quota</code><a href="#remove-backlog-quota-1" class="hash-link" aria-label="Direct link to remove-backlog-quota-1" title="Direct link to remove-backlog-quota-1"></a></h3><p>Remove a backlog quota policy from a topic.</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--type</code></td><td>Backlog quota type to remove. The valid options are: <code>destination_storage</code>, <code>message_age</code></td><td>destination_storage</td></tr></tbody></table><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics remove-backlog-quota tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-persistence-1"><code>get-persistence</code><a href="#get-persistence-1" class="hash-link" aria-label="Direct link to get-persistence-1" title="Direct link to get-persistence-1"></a></h3><p>Get the persistence policies for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics get-persistence tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-persistence-1"><code>set-persistence</code><a href="#set-persistence-1" class="hash-link" aria-label="Direct link to set-persistence-1" title="Direct link to set-persistence-1"></a></h3><p>Set the persistence policies for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics set-persistence tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-e</code>, <code>--bookkeeper-ensemble</code></td><td>Number of bookies to use for a topic</td><td>2</td></tr><tr><td><code>-w</code>, <code>--bookkeeper-write-quorum</code></td><td>How many writes to make of each entry</td><td>2</td></tr><tr><td><code>-a</code>, <code>--bookkeeper-ack-quorum</code></td><td>Number of acks (guaranteed copies) to wait for each entry</td><td>2</td></tr><tr><td><code>-r</code>, <code>--ml-mark-delete-max-rate</code></td><td>Throttling rate of mark-delete operation (0 means no throttle)</td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-persistence"><code>remove-persistence</code><a href="#remove-persistence" class="hash-link" aria-label="Direct link to remove-persistence" title="Direct link to remove-persistence"></a></h3><p>Remove the persistence policy for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics remove-persistence tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-message-ttl-1"><code>get-message-ttl</code><a href="#get-message-ttl-1" class="hash-link" aria-label="Direct link to get-message-ttl-1" title="Direct link to get-message-ttl-1"></a></h3><p>Get the message TTL for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics get-message-ttl tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-message-ttl-1"><code>set-message-ttl</code><a href="#set-message-ttl-1" class="hash-link" aria-label="Direct link to set-message-ttl-1" title="Direct link to set-message-ttl-1"></a></h3><p>Set the message TTL for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics set-message-ttl tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-t</code>, <code>--ttl</code></td><td>Message TTL for a topic in second (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), allowed range from 1 to <code>Integer.MAX_VALUE</code></td><td>0</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-message-ttl-1"><code>remove-message-ttl</code><a href="#remove-message-ttl-1" class="hash-link" aria-label="Direct link to remove-message-ttl-1" title="Direct link to remove-message-ttl-1"></a></h3><p>Remove the message TTL for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics remove-message-ttl tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--enable</code>, <code>-e</code></td><td>Enable message deduplication on the specified topic.</td><td>false</td></tr><tr><td><code>--disable</code>, <code>-d</code></td><td>Disable message deduplication on the specified topic.</td><td>false</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-deduplication"><code>get-deduplication</code><a href="#get-deduplication" class="hash-link" aria-label="Direct link to get-deduplication" title="Direct link to get-deduplication"></a></h3><p>Get a deduplication policy for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics get-deduplication tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-deduplication-1"><code>set-deduplication</code><a href="#set-deduplication-1" class="hash-link" aria-label="Direct link to set-deduplication-1" title="Direct link to set-deduplication-1"></a></h3><p>Set a deduplication policy for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics set-deduplication tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="remove-deduplication"><code>remove-deduplication</code><a href="#remove-deduplication" class="hash-link" aria-label="Direct link to remove-deduplication" title="Direct link to remove-deduplication"></a></h3><p>Remove a deduplication policy for a topic.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin topics remove-deduplication tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="tenants"><code>tenants</code><a href="#tenants" class="hash-link" aria-label="Direct link to tenants" title="Direct link to tenants"></a></h2><p>Operations for managing tenants</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin tenants subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>list</code></li><li><code>get</code></li><li><code>create</code></li><li><code>update</code></li><li><code>delete</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-6"><code>list</code><a href="#list-6" class="hash-link" aria-label="Direct link to list-6" title="Direct link to list-6"></a></h3><p>List the existing tenants</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin tenants list</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-3"><code>get</code><a href="#get-3" class="hash-link" aria-label="Direct link to get-3" title="Direct link to get-3"></a></h3><p>Gets the configuration of a tenant</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin tenants get tenant-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-4"><code>create</code><a href="#create-4" class="hash-link" aria-label="Direct link to create-4" title="Direct link to create-4"></a></h3><p>Creates a new tenant</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin tenants create tenant-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-r</code>, <code>--admin-roles</code></td><td>Comma-separated admin roles</td><td></td></tr><tr><td><code>-c</code>, <code>--allowed-clusters</code></td><td>Comma-separated allowed clusters</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-2"><code>update</code><a href="#update-2" class="hash-link" aria-label="Direct link to update-2" title="Direct link to update-2"></a></h3><p>Updates a tenant</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin tenants update tenant-name options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-r</code>, <code>--admin-roles</code></td><td>Comma-separated admin roles</td><td></td></tr><tr><td><code>-c</code>, <code>--allowed-clusters</code></td><td>Comma-separated allowed clusters</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-5"><code>delete</code><a href="#delete-5" class="hash-link" aria-label="Direct link to delete-5" title="Direct link to delete-5"></a></h3><p>Deletes an existing tenant</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin tenants delete tenant-name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-f</code>, <code>--force</code></td><td>Delete a tenant forcefully by deleting all namespaces under it.</td><td>false</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="resource-quotas"><code>resource-quotas</code><a href="#resource-quotas" class="hash-link" aria-label="Direct link to resource-quotas" title="Direct link to resource-quotas"></a></h2><p>Operations for managing resource quotas</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin resource-quotas subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>get</code></li><li><code>set</code></li><li><code>reset-namespace-bundle-quota</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-4"><code>get</code><a href="#get-4" class="hash-link" aria-label="Direct link to get-4" title="Direct link to get-4"></a></h3><p>Get the resource quota for a specified namespace bundle, or default quota if no namespace/bundle is specified.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin resource-quotas get options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundle</code></td><td>A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/--namespace.</td><td></td></tr><tr><td><code>-n</code>, <code>--namespace</code></td><td>The namespace</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-1"><code>set</code><a href="#set-1" class="hash-link" aria-label="Direct link to set-1" title="Direct link to set-1"></a></h3><p>Set the resource quota for the specified namespace bundle, or default quota if no namespace/bundle is specified.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin resource-quotas </span><span class="token builtin class-name" style="color:rgb(189, 147, 249)">set</span><span class="token plain"> options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-bi</code>, <code>--bandwidthIn</code></td><td>The expected inbound bandwidth (in bytes/second)</td><td>0</td></tr><tr><td><code>-bo</code>, <code>--bandwidthOut</code></td><td>Expected outbound bandwidth (in bytes/second)0</td><td></td></tr><tr><td><code>-b</code>, <code>--bundle</code></td><td>A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/--namespace.</td><td></td></tr><tr><td><code>-d</code>, <code>--dynamic</code></td><td>Allow to be dynamically re-calculated (or not)</td><td>false</td></tr><tr><td><code>-mem</code>, <code>--memory</code></td><td>Expectred memory usage (in megabytes)</td><td>0</td></tr><tr><td><code>-mi</code>, <code>--msgRateIn</code></td><td>Expected incoming messages per second</td><td>0</td></tr><tr><td><code>-mo</code>, <code>--msgRateOut</code></td><td>Expected outgoing messages per second</td><td>0</td></tr><tr><td><code>-n</code>, <code>--namespace</code></td><td>The namespace as tenant/namespace, for example my-tenant/my-ns. Must be specified together with -b/--bundle.</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="reset-namespace-bundle-quota"><code>reset-namespace-bundle-quota</code><a href="#reset-namespace-bundle-quota" class="hash-link" aria-label="Direct link to reset-namespace-bundle-quota" title="Direct link to reset-namespace-bundle-quota"></a></h3><p>Reset the specified namespace bundle&#x27;s resource quota to a default value.</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin resource-quotas reset-namespace-bundle-quota options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-b</code>, <code>--bundle</code></td><td>A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/--namespace.</td><td></td></tr><tr><td><code>-n</code>, <code>--namespace</code></td><td>The namespace</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="schemas"><code>schemas</code><a href="#schemas" class="hash-link" aria-label="Direct link to schemas" title="Direct link to schemas"></a></h2><p>Operations related to Schemas associated with Pulsar topics.</p><p>Usage</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin schemas subcommand</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands</p><ul><li><code>upload</code></li><li><code>delete</code></li><li><code>get</code></li><li><code>extract</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="upload"><code>upload</code><a href="#upload" class="hash-link" aria-label="Direct link to upload" title="Direct link to upload"></a></h3><p>Upload the schema definition for a topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin schemas upload persistent://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--filename</code></td><td>The path to the schema definition file. An example schema file is available under conf directory.</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-6"><code>delete</code><a href="#delete-6" class="hash-link" aria-label="Direct link to delete-6" title="Direct link to delete-6"></a></h3><p>Delete the schema definition associated with a topic</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin schemas delete persistent://tenant/namespace/topic</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-5"><code>get</code><a href="#get-5" class="hash-link" aria-label="Direct link to get-5" title="Direct link to get-5"></a></h3><p>Retrieve the schema definition associated with a topic (at a given version if version is supplied).</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin schemas get persistent://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--version</code></td><td>The version of the schema definition to retrieve for a topic.</td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="extract"><code>extract</code><a href="#extract" class="hash-link" aria-label="Direct link to extract" title="Direct link to extract"></a></h3><p>Provide the schema definition for a topic via Java class name contained in a JAR file</p><p>Usage</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin schemas extract persistent://tenant/namespace/topic options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Options</p><table><thead><tr><th>Flag</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>-c</code>, <code>--classname</code></td><td>The Java class name</td><td></td></tr><tr><td><code>-j</code>, <code>--jar</code></td><td>Absolute path to the JAR file which contains the above Java class</td><td></td></tr><tr><td><code>-t</code>, <code>--type</code></td><td>The type of the schema (avro or json)</td><td></td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/pulsar-site/edit/main/versioned_docs/version-3.2.x/reference-pulsar-admin.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"></nav></div></div><div class="col col--3"><div class="tableOfContents_jeP5 thin-scrollbar theme-doc-toc-desktop"><div class="border"><div style="color:var(--ifm-toc-link-color)">Was this helpful?</div><div style="border-width:1px;padding:3px;display:flex"><div style="justify-content:center;display:flex;border-radius:99999px;width:2.5rem;height:2.5rem;cursor:pointer;background:;color:"><svg style="width:initial;height:initial" width="12" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.086 1.594A1 1 0 0 1 11 1a4 4 0 0 1 4 4v3h4.655a3 3 0 0 1 2.994 3.45l-1.38 9A3.002 3.002 0 0 1 18.275 23H4a3 3 0 0 1-3-3v-7a3 3 0 0 1 3-3h2.35l3.736-8.406ZM8 11.212l3.608-8.117A2 2 0 0 1 13 5v4a1 1 0 0 0 1 1h5.671a1 1 0 0 1 1 1.15l-1.38 9a1 1 0 0 1-1 .85H8v-9.788ZM6 21v-9H4a1 1 0 0 0-1 1v7a1 1 0 0 0 1 1h2Z" fill="currentColor"></path></svg></div><div style="justify-content:center;display:flex;border-radius:99999px;width:2.5rem;height:2.5rem;cursor:pointer;background:;color:"><svg style="width:initial;height:initial" width="12" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M20.563 3.316A1.31 1.31 0 0 0 19.687 3h-1.688v9h1.688a1.31 1.31 0 0 0 1.312-1.077V4.077a1.31 1.31 0 0 0-.436-.761ZM16 12.788l-3.608 8.117A1.999 1.999 0 0 1 11 19v-4a1 1 0 0 0-1-1H4.328a1.002 1.002 0 0 1-1-1.15l1.38-9a1 1 0 0 1 1-.85h10.291v9.788ZM19.661 1a3.31 3.31 0 0 1 3.329 2.866c.006.044.01.09.01.134v7c0 .045-.004.09-.01.134A3.31 3.31 0 0 1 19.661 14h-2.012l-3.736 8.406a1 1 0 0 1-.914.594 4 4 0 0 1-4-4v-3H4.344a3 3 0 0 1-2.994-3.45l1.38-9A3.002 3.002 0 0 1 5.724 1h13.937Z" fill="currentColor"></path></svg></div></div><div class="Actions_uugI"><a target="_blank" class="Action_iBHd" href="https://github.com/apache/pulsar/issues/new?assignees=&amp;labels=doc-required&amp;projects=&amp;template=doc.yml&amp;title=%5BDoc%5D+">💡 Suggest changes</a><a target="_blank" class="Action_iBHd" href="https://github.com/apache/pulsar/discussions/new?category=q-a">🛟 Get support</a></div></div><ul class="table-of-contents table-of-contents__left-border"><li><a href="#broker-stats" class="table-of-contents__link toc-highlight"><code>broker-stats</code></a><ul><li><a href="#allocator-stats" class="table-of-contents__link toc-highlight"><code>allocator-stats</code></a></li><li><a href="#topicsdestinations" class="table-of-contents__link toc-highlight"><code>topics(destinations)</code></a></li><li><a href="#mbeans" class="table-of-contents__link toc-highlight"><code>mbeans</code></a></li><li><a href="#monitoring-metrics" class="table-of-contents__link toc-highlight"><code>monitoring-metrics</code></a></li><li><a href="#load-report" class="table-of-contents__link toc-highlight"><code>load-report</code></a></li></ul></li><li><a href="#brokers" class="table-of-contents__link toc-highlight"><code>brokers</code></a><ul><li><a href="#list" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#leader-broker" class="table-of-contents__link toc-highlight"><code>leader-broker</code></a></li><li><a href="#namespaces" class="table-of-contents__link toc-highlight"><code>namespaces</code></a></li><li><a href="#update-dynamic-config" class="table-of-contents__link toc-highlight"><code>update-dynamic-config</code></a></li><li><a href="#list-dynamic-config" class="table-of-contents__link toc-highlight"><code>list-dynamic-config</code></a></li><li><a href="#delete-dynamic-config" class="table-of-contents__link toc-highlight"><code>delete-dynamic-config</code></a></li><li><a href="#get-all-dynamic-config" class="table-of-contents__link toc-highlight"><code>get-all-dynamic-config</code></a></li><li><a href="#get-internal-config" class="table-of-contents__link toc-highlight"><code>get-internal-config</code></a></li><li><a href="#get-runtime-config" class="table-of-contents__link toc-highlight"><code>get-runtime-config</code></a></li><li><a href="#healthcheck" class="table-of-contents__link toc-highlight"><code>healthcheck</code></a></li></ul></li><li><a href="#clusters" class="table-of-contents__link toc-highlight"><code>clusters</code></a><ul><li><a href="#get" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#create" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#update" class="table-of-contents__link toc-highlight"><code>update</code></a></li><li><a href="#update-cluster-migration" class="table-of-contents__link toc-highlight"><code>update cluster migration</code></a></li><li><a href="#delete" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#list-1" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#update-peer-clusters" class="table-of-contents__link toc-highlight"><code>update-peer-clusters</code></a></li><li><a href="#get-peer-clusters" class="table-of-contents__link toc-highlight"><code>get-peer-clusters</code></a></li><li><a href="#get-failure-domain" class="table-of-contents__link toc-highlight"><code>get-failure-domain</code></a></li><li><a href="#create-failure-domain" class="table-of-contents__link toc-highlight"><code>create-failure-domain</code></a></li><li><a href="#update-failure-domain" class="table-of-contents__link toc-highlight"><code>update-failure-domain</code></a></li><li><a href="#delete-failure-domain" class="table-of-contents__link toc-highlight"><code>delete-failure-domain</code></a></li><li><a href="#list-failure-domains" class="table-of-contents__link toc-highlight"><code>list-failure-domains</code></a></li></ul></li><li><a href="#functions" class="table-of-contents__link toc-highlight"><code>functions</code></a><ul><li><a href="#localrun" class="table-of-contents__link toc-highlight"><code>localrun</code></a></li><li><a href="#create-1" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#delete-1" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#update-1" class="table-of-contents__link toc-highlight"><code>update</code></a></li><li><a href="#get-1" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#restart" class="table-of-contents__link toc-highlight"><code>restart</code></a></li><li><a href="#stop" class="table-of-contents__link toc-highlight"><code>stop</code></a></li><li><a href="#start" class="table-of-contents__link toc-highlight"><code>start</code></a></li><li><a href="#status" class="table-of-contents__link toc-highlight"><code>status</code></a></li><li><a href="#stats" class="table-of-contents__link toc-highlight"><code>stats</code></a></li><li><a href="#list-2" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#querystate" class="table-of-contents__link toc-highlight"><code>querystate</code></a></li><li><a href="#putstate" class="table-of-contents__link toc-highlight"><code>putstate</code></a></li><li><a href="#trigger" class="table-of-contents__link toc-highlight"><code>trigger</code></a></li></ul></li><li><a href="#functions-worker" class="table-of-contents__link toc-highlight"><code>functions-worker</code></a><ul><li><a href="#function-stats" class="table-of-contents__link toc-highlight"><code>function-stats</code></a></li><li><a href="#get-cluster" class="table-of-contents__link toc-highlight"><code>get-cluster</code></a></li><li><a href="#get-cluster-leader" class="table-of-contents__link toc-highlight"><code>get-cluster-leader</code></a></li><li><a href="#get-function-assignments" class="table-of-contents__link toc-highlight"><code>get-function-assignments</code></a></li><li><a href="#monitoring-metrics-1" class="table-of-contents__link toc-highlight"><code>monitoring-metrics</code></a></li></ul></li><li><a href="#namespaces-1" class="table-of-contents__link toc-highlight"><code>namespaces</code></a><ul><li><a href="#list-3" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#topics" class="table-of-contents__link toc-highlight"><code>topics</code></a></li><li><a href="#policies" class="table-of-contents__link toc-highlight"><code>policies</code></a></li><li><a href="#create-2" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#delete-2" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#set-deduplication" class="table-of-contents__link toc-highlight"><code>set-deduplication</code></a></li><li><a href="#set-auto-topic-creation" class="table-of-contents__link toc-highlight"><code>set-auto-topic-creation</code></a></li><li><a href="#remove-auto-topic-creation" class="table-of-contents__link toc-highlight"><code>remove-auto-topic-creation</code></a></li><li><a href="#set-auto-subscription-creation" class="table-of-contents__link toc-highlight"><code>set-auto-subscription-creation</code></a></li><li><a href="#remove-auto-subscription-creation" class="table-of-contents__link toc-highlight"><code>remove-auto-subscription-creation</code></a></li><li><a href="#permissions" class="table-of-contents__link toc-highlight"><code>permissions</code></a></li><li><a href="#grant-permission" class="table-of-contents__link toc-highlight"><code>grant-permission</code></a></li><li><a href="#revoke-permission" class="table-of-contents__link toc-highlight"><code>revoke-permission</code></a></li><li><a href="#grant-subscription-permission" class="table-of-contents__link toc-highlight"><code>grant-subscription-permission</code></a></li><li><a href="#revoke-subscription-permission" class="table-of-contents__link toc-highlight"><code>revoke-subscription-permission</code></a></li><li><a href="#set-clusters" class="table-of-contents__link toc-highlight"><code>set-clusters</code></a></li><li><a href="#get-clusters" class="table-of-contents__link toc-highlight"><code>get-clusters</code></a></li><li><a href="#get-backlog-quotas" class="table-of-contents__link toc-highlight"><code>get-backlog-quotas</code></a></li><li><a href="#set-backlog-quota" class="table-of-contents__link toc-highlight"><code>set-backlog-quota</code></a></li><li><a href="#remove-backlog-quota" class="table-of-contents__link toc-highlight"><code>remove-backlog-quota</code></a></li><li><a href="#get-persistence" class="table-of-contents__link toc-highlight"><code>get-persistence</code></a></li><li><a href="#set-persistence" class="table-of-contents__link toc-highlight"><code>set-persistence</code></a></li><li><a href="#get-message-ttl" class="table-of-contents__link toc-highlight"><code>get-message-ttl</code></a></li><li><a href="#set-message-ttl" class="table-of-contents__link toc-highlight"><code>set-message-ttl</code></a></li><li><a href="#remove-message-ttl" class="table-of-contents__link toc-highlight"><code>remove-message-ttl</code></a></li><li><a href="#get-anti-affinity-group" class="table-of-contents__link toc-highlight"><code>get-anti-affinity-group</code></a></li><li><a href="#set-anti-affinity-group" class="table-of-contents__link toc-highlight"><code>set-anti-affinity-group</code></a></li><li><a href="#get-anti-affinity-namespaces" class="table-of-contents__link toc-highlight"><code>get-anti-affinity-namespaces</code></a></li><li><a href="#delete-anti-affinity-group" class="table-of-contents__link toc-highlight"><code>delete-anti-affinity-group</code></a></li><li><a href="#get-retention" class="table-of-contents__link toc-highlight"><code>get-retention</code></a></li><li><a href="#set-retention" class="table-of-contents__link toc-highlight"><code>set-retention</code></a></li><li><a href="#unload" class="table-of-contents__link toc-highlight"><code>unload</code></a></li><li><a href="#split-bundle" class="table-of-contents__link toc-highlight"><code>split-bundle</code></a></li><li><a href="#set-dispatch-rate" class="table-of-contents__link toc-highlight"><code>set-dispatch-rate</code></a></li><li><a href="#get-dispatch-rate" class="table-of-contents__link toc-highlight"><code>get-dispatch-rate</code></a></li><li><a href="#set-replicator-dispatch-rate" class="table-of-contents__link toc-highlight"><code>set-replicator-dispatch-rate</code></a></li><li><a href="#get-replicator-dispatch-rate" class="table-of-contents__link toc-highlight"><code>get-replicator-dispatch-rate</code></a></li><li><a href="#set-subscribe-rate" class="table-of-contents__link toc-highlight"><code>set-subscribe-rate</code></a></li><li><a href="#get-subscribe-rate" class="table-of-contents__link toc-highlight"><code>get-subscribe-rate</code></a></li><li><a href="#set-subscription-dispatch-rate" class="table-of-contents__link toc-highlight"><code>set-subscription-dispatch-rate</code></a></li><li><a href="#get-subscription-dispatch-rate" class="table-of-contents__link toc-highlight"><code>get-subscription-dispatch-rate</code></a></li><li><a href="#clear-backlog" class="table-of-contents__link toc-highlight"><code>clear-backlog</code></a></li><li><a href="#unsubscribe" class="table-of-contents__link toc-highlight"><code>unsubscribe</code></a></li><li><a href="#set-encryption-required" class="table-of-contents__link toc-highlight"><code>set-encryption-required</code></a></li><li><a href="#set-delayed-delivery" class="table-of-contents__link toc-highlight"><code>set-delayed-delivery</code></a></li><li><a href="#get-delayed-delivery" class="table-of-contents__link toc-highlight"><code>get-delayed-delivery</code></a></li><li><a href="#set-subscription-auth-mode" class="table-of-contents__link toc-highlight"><code>set-subscription-auth-mode</code></a></li><li><a href="#get-max-producers-per-topic" class="table-of-contents__link toc-highlight"><code>get-max-producers-per-topic</code></a></li><li><a href="#set-max-producers-per-topic" class="table-of-contents__link toc-highlight"><code>set-max-producers-per-topic</code></a></li><li><a href="#get-max-consumers-per-topic" class="table-of-contents__link toc-highlight"><code>get-max-consumers-per-topic</code></a></li><li><a href="#set-max-consumers-per-topic" class="table-of-contents__link toc-highlight"><code>set-max-consumers-per-topic</code></a></li><li><a href="#get-max-consumers-per-subscription" class="table-of-contents__link toc-highlight"><code>get-max-consumers-per-subscription</code></a></li><li><a href="#set-max-consumers-per-subscription" class="table-of-contents__link toc-highlight"><code>set-max-consumers-per-subscription</code></a></li><li><a href="#get-max-unacked-messages-per-subscription" class="table-of-contents__link toc-highlight"><code>get-max-unacked-messages-per-subscription</code></a></li><li><a href="#set-max-unacked-messages-per-subscription" class="table-of-contents__link toc-highlight"><code>set-max-unacked-messages-per-subscription</code></a></li><li><a href="#get-max-unacked-messages-per-consumer" class="table-of-contents__link toc-highlight"><code>get-max-unacked-messages-per-consumer</code></a></li><li><a href="#set-max-unacked-messages-per-consumer" class="table-of-contents__link toc-highlight"><code>set-max-unacked-messages-per-consumer</code></a></li><li><a href="#get-compaction-threshold" class="table-of-contents__link toc-highlight"><code>get-compaction-threshold</code></a></li><li><a href="#set-compaction-threshold" class="table-of-contents__link toc-highlight"><code>set-compaction-threshold</code></a></li><li><a href="#get-offload-threshold" class="table-of-contents__link toc-highlight"><code>get-offload-threshold</code></a></li><li><a href="#set-offload-threshold" class="table-of-contents__link toc-highlight"><code>set-offload-threshold</code></a></li><li><a href="#get-offload-deletion-lag" class="table-of-contents__link toc-highlight"><code>get-offload-deletion-lag</code></a></li><li><a href="#set-offload-deletion-lag" class="table-of-contents__link toc-highlight"><code>set-offload-deletion-lag</code></a></li><li><a href="#clear-offload-deletion-lag" class="table-of-contents__link toc-highlight"><code>clear-offload-deletion-lag</code></a></li><li><a href="#get-schema-autoupdate-strategy" class="table-of-contents__link toc-highlight"><code>get-schema-autoupdate-strategy</code></a></li><li><a href="#set-schema-autoupdate-strategy" class="table-of-contents__link toc-highlight"><code>set-schema-autoupdate-strategy</code></a></li><li><a href="#get-publish-rate" class="table-of-contents__link toc-highlight"><code>get-publish-rate</code></a></li><li><a href="#set-publish-rate" class="table-of-contents__link toc-highlight"><code>set-publish-rate</code></a></li><li><a href="#set-offload-policies" class="table-of-contents__link toc-highlight"><code>set-offload-policies</code></a></li><li><a href="#get-offload-policies" class="table-of-contents__link toc-highlight"><code>get-offload-policies</code></a></li><li><a href="#set-max-subscriptions-per-topic" class="table-of-contents__link toc-highlight"><code>set-max-subscriptions-per-topic</code></a></li><li><a href="#get-max-subscriptions-per-topic" class="table-of-contents__link toc-highlight"><code>get-max-subscriptions-per-topic</code></a></li><li><a href="#remove-max-subscriptions-per-topic" class="table-of-contents__link toc-highlight"><code>remove-max-subscriptions-per-topic</code></a></li></ul></li><li><a href="#ns-isolation-policy" class="table-of-contents__link toc-highlight"><code>ns-isolation-policy</code></a><ul><li><a href="#set" class="table-of-contents__link toc-highlight"><code>set</code></a></li><li><a href="#get-2" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#list-4" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#delete-3" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#brokers-1" class="table-of-contents__link toc-highlight"><code>brokers</code></a></li><li><a href="#broker" class="table-of-contents__link toc-highlight"><code>broker</code></a></li></ul></li><li><a href="#topics-1" class="table-of-contents__link toc-highlight"><code>topics</code></a><ul><li><a href="#compact" class="table-of-contents__link toc-highlight"><code>compact</code></a></li><li><a href="#compaction-status" class="table-of-contents__link toc-highlight"><code>compaction-status</code></a></li><li><a href="#offload" class="table-of-contents__link toc-highlight"><code>offload</code></a></li><li><a href="#offload-status" class="table-of-contents__link toc-highlight"><code>offload-status</code></a></li><li><a href="#create-partitioned-topic" class="table-of-contents__link toc-highlight"><code>create-partitioned-topic</code></a></li><li><a href="#create-missed-partitions" class="table-of-contents__link toc-highlight"><code>create-missed-partitions</code></a></li><li><a href="#delete-partitioned-topic" class="table-of-contents__link toc-highlight"><code>delete-partitioned-topic</code></a></li><li><a href="#create-3" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#get-partitioned-topic-metadata" class="table-of-contents__link toc-highlight"><code>get-partitioned-topic-metadata</code></a></li><li><a href="#update-partitioned-topic" class="table-of-contents__link toc-highlight"><code>update-partitioned-topic</code></a></li><li><a href="#list-partitioned-topics" class="table-of-contents__link toc-highlight"><code>list-partitioned-topics</code></a></li><li><a href="#list-5" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#terminate" class="table-of-contents__link toc-highlight"><code>terminate</code></a></li><li><a href="#partitioned-terminate" class="table-of-contents__link toc-highlight"><code>partitioned-terminate</code></a></li><li><a href="#permissions-1" class="table-of-contents__link toc-highlight"><code>permissions</code></a></li><li><a href="#grant-permission-1" class="table-of-contents__link toc-highlight"><code>grant-permission</code></a></li><li><a href="#revoke-permission-1" class="table-of-contents__link toc-highlight"><code>revoke-permission</code></a></li><li><a href="#lookup" class="table-of-contents__link toc-highlight"><code>lookup</code></a></li><li><a href="#bundle-range" class="table-of-contents__link toc-highlight"><code>bundle-range</code></a></li><li><a href="#delete-4" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#unload-1" class="table-of-contents__link toc-highlight"><code>unload</code></a></li><li><a href="#create-subscription" class="table-of-contents__link toc-highlight"><code>create-subscription</code></a></li><li><a href="#subscriptions" class="table-of-contents__link toc-highlight"><code>subscriptions</code></a></li><li><a href="#unsubscribe-1" class="table-of-contents__link toc-highlight"><code>unsubscribe</code></a></li><li><a href="#stats-1" class="table-of-contents__link toc-highlight"><code>stats</code></a></li><li><a href="#stats-internal" class="table-of-contents__link toc-highlight"><code>stats-internal</code></a></li><li><a href="#info-internal" class="table-of-contents__link toc-highlight"><code>info-internal</code></a></li><li><a href="#partitioned-stats" class="table-of-contents__link toc-highlight"><code>partitioned-stats</code></a></li><li><a href="#partitioned-stats-internal" class="table-of-contents__link toc-highlight"><code>partitioned-stats-internal</code></a></li><li><a href="#skip" class="table-of-contents__link toc-highlight"><code>skip</code></a></li><li><a href="#clear-backlog-1" class="table-of-contents__link toc-highlight"><code>clear-backlog</code></a></li><li><a href="#expire-messages" class="table-of-contents__link toc-highlight"><code>expire-messages</code></a></li><li><a href="#expire-messages-all-subscriptions" class="table-of-contents__link toc-highlight"><code>expire-messages-all-subscriptions</code></a></li><li><a href="#peek-messages" class="table-of-contents__link toc-highlight"><code>peek-messages</code></a></li><li><a href="#reset-cursor" class="table-of-contents__link toc-highlight"><code>reset-cursor</code></a></li><li><a href="#get-message-by-id" class="table-of-contents__link toc-highlight"><code>get-message-by-id</code></a></li><li><a href="#last-message-id" class="table-of-contents__link toc-highlight"><code>last-message-id</code></a></li><li><a href="#get-backlog-quotas-1" class="table-of-contents__link toc-highlight"><code>get-backlog-quotas</code></a></li><li><a href="#set-backlog-quota-1" class="table-of-contents__link toc-highlight"><code>set-backlog-quota</code></a></li><li><a href="#remove-backlog-quota-1" class="table-of-contents__link toc-highlight"><code>remove-backlog-quota</code></a></li><li><a href="#get-persistence-1" class="table-of-contents__link toc-highlight"><code>get-persistence</code></a></li><li><a href="#set-persistence-1" class="table-of-contents__link toc-highlight"><code>set-persistence</code></a></li><li><a href="#remove-persistence" class="table-of-contents__link toc-highlight"><code>remove-persistence</code></a></li><li><a href="#get-message-ttl-1" class="table-of-contents__link toc-highlight"><code>get-message-ttl</code></a></li><li><a href="#set-message-ttl-1" class="table-of-contents__link toc-highlight"><code>set-message-ttl</code></a></li><li><a href="#remove-message-ttl-1" class="table-of-contents__link toc-highlight"><code>remove-message-ttl</code></a></li><li><a href="#get-deduplication" class="table-of-contents__link toc-highlight"><code>get-deduplication</code></a></li><li><a href="#set-deduplication-1" class="table-of-contents__link toc-highlight"><code>set-deduplication</code></a></li><li><a href="#remove-deduplication" class="table-of-contents__link toc-highlight"><code>remove-deduplication</code></a></li></ul></li><li><a href="#tenants" class="table-of-contents__link toc-highlight"><code>tenants</code></a><ul><li><a href="#list-6" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#get-3" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#create-4" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#update-2" class="table-of-contents__link toc-highlight"><code>update</code></a></li><li><a href="#delete-5" class="table-of-contents__link toc-highlight"><code>delete</code></a></li></ul></li><li><a href="#resource-quotas" class="table-of-contents__link toc-highlight"><code>resource-quotas</code></a><ul><li><a href="#get-4" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#set-1" class="table-of-contents__link toc-highlight"><code>set</code></a></li><li><a href="#reset-namespace-bundle-quota" class="table-of-contents__link toc-highlight"><code>reset-namespace-bundle-quota</code></a></li></ul></li><li><a href="#schemas" class="table-of-contents__link toc-highlight"><code>schemas</code></a><ul><li><a href="#upload" class="table-of-contents__link toc-highlight"><code>upload</code></a></li><li><a href="#delete-6" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#get-5" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#extract" class="table-of-contents__link toc-highlight"><code>extract</code></a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Foundation<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/events/current-event.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Events<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="footer__link-item">License<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/thanks" target="_blank" rel="noopener noreferrer" class="footer__link-item">Thanks<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/sponsorship" target="_blank" rel="noopener noreferrer" class="footer__link-item">Sponsorship<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/security/">Security</a></li><li class="footer__item"><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/contact/">Contact</a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item">
<div class="social-icons">
<a target="_blank" href="https://communityinviter.com/apps/apache-pulsar/apache-pulsar" aria-label="Join the Apache Pulsar Slack workspace">
<img alt="Slack logo" src="/img/slack-white.svg" width="26">
</a>
<a target="_blank" href="https://github.com/apache/pulsar/" aria-label="View the Apache Pulsar project on GitHub">
<img alt="GitHub logo" src="/img/github-white.svg" width="26">
</a>
</div>
</li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a class="footerLogoLink_BH7S" href="/"><img src="/img/pulsar-white.svg" alt="Pulsar Logo" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/pulsar-white.svg" alt="Pulsar Logo" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></a></div><div class="footer__copyright">
<div>
<img class="footer-apache-logo" src="/img/feather-logo-white.svg" alt="" width="20">
The Apache Software Foundation
</div>
<p>Apache Pulsar is available under the Apache License, version 2.0. Apache Pulsar is an open-source, distributed messaging and streaming platform built for the cloud.</p>
<p>Copyright © 2024 The Apache Software Foundation. All Rights Reserved. Apache, Pulsar, Apache Pulsar, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation.</p>
</div></div></div></footer></div>
<script src="/assets/js/runtime~main.1d0ed2a7.js"></script>
<script src="/assets/js/main.e07a0c68.js"></script>
</body>
</html>