Skip to content

Commit

Permalink
[snmp] invert interactive logic (#9258) 2c16890
Browse files Browse the repository at this point in the history
  • Loading branch information
pducolin committed Apr 28, 2021
1 parent f56a50e commit 1592237
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion ddev/cli/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
</code></pre></div> Sometimes indexes are columns from another table, and we might want to use another column as it could have more human readable information - we might prefer to see the interface name vs its numerical table index. This can be achieved using metric_tag_aliases</p> <p>Return a list of SNMP metrics and copy its yaml dump to the clipboard Metric tags need to be added manually</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev meta snmp generate-profile-from-mibs [OPTIONS] [MIB_FILES]...
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>-f</code>, <code>--filters</code></td> <td>text</td> <td>Path to OIDs filter</td> <td><em>required</em></td> </tr> <tr> <td><code>-a</code>, <code>--aliases</code></td> <td>text</td> <td>Path to metric tag aliases</td> <td><em>required</em></td> </tr> <tr> <td><code>--debug</code>, <code>-d</code></td> <td>boolean</td> <td>Include debug output</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h4 id=ddev-meta-snmp-translate-profile>ddev meta snmp translate-profile<a class=headerlink href=#ddev-meta-snmp-translate-profile title="Permanent link">&para;</a></h4> <p>Do OID translation in a SNMP profile. This isn't a plain replacement, as it doesn't preserve comments and indent, but it should automate most of the work.</p> <p>You'll need to install pysnmp and pysnmp-mibs manually beforehand.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev meta snmp translate-profile [OPTIONS] PROFILE_PATH
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--mib_source_url</code></td> <td>text</td> <td>Source url to fetch missing MIBS</td> <td><code>https://raw.githubusercontent.com/projx/snmp-mibs/master/@mib@</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h4 id=ddev-meta-snmp-validate-mib-filenames>ddev meta snmp validate-mib-filenames<a class=headerlink href=#ddev-meta-snmp-validate-mib-filenames title="Permanent link">&para;</a></h4> <p>Validate MIB file names. Frameworks used to load mib files expect MIB file names to match MIB name.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev meta snmp validate-mib-filenames [OPTIONS] [MIB_FILES]...
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--fix-silent</code>, <code>-s</code></td> <td>text</td> <td>Rename all invalid MIB files without prompting to confirm</td> <td><em>required</em></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-release>ddev release<a class=headerlink href=#ddev-release title="Permanent link">&para;</a></h2> <p>Manage the release of checks</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release [OPTIONS] COMMAND [ARGS]...
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--interactive</code>, <code>-i</code></td> <td>boolean</td> <td>Prompt to confirm before renaming all invalid MIB files</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-release>ddev release<a class=headerlink href=#ddev-release title="Permanent link">&para;</a></h2> <p>Manage the release of checks</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release [OPTIONS] COMMAND [ARGS]...
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-release-build>ddev release build<a class=headerlink href=#ddev-release-build title="Permanent link">&para;</a></h3> <p>Build a wheel for a check as it is on the repo HEAD</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release build [OPTIONS] CHECK
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--sdist</code>, <code>-s</code></td> <td>boolean</td> <td>N/A</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-release-changelog>ddev release changelog<a class=headerlink href=#ddev-release-changelog title="Permanent link">&para;</a></h3> <p>Perform the operations needed to update the changelog.</p> <p>This method is supposed to be used by other tasks and not directly.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release changelog [OPTIONS] CHECK VERSION [OLD_VERSION]
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--initial</code></td> <td>boolean</td> <td>N/A</td> <td><code>False</code></td> </tr> <tr> <td><code>--organization</code>, <code>-r</code></td> <td>text</td> <td>N/A</td> <td><code>DataDog</code></td> </tr> <tr> <td><code>--quiet</code>, <code>-q</code></td> <td>boolean</td> <td>N/A</td> <td><code>False</code></td> </tr> <tr> <td><code>--dry-run</code>, <code>-n</code></td> <td>boolean</td> <td>N/A</td> <td><code>False</code></td> </tr> <tr> <td><code>--output-file</code>, <code>-o</code></td> <td>text</td> <td>N/A</td> <td><code>CHANGELOG.md</code></td> </tr> <tr> <td><code>--tag-prefix</code>, <code>-tp</code></td> <td>text</td> <td>N/A</td> <td><code>v</code></td> </tr> <tr> <td><code>--no-semver</code>, <code>-ns</code></td> <td>boolean</td> <td>N/A</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-release-make>ddev release make<a class=headerlink href=#ddev-release-make title="Permanent link">&para;</a></h3> <p>Perform a set of operations needed to release checks:</p> <ul> <li>update the version in <code>__about__.py</code></li> <li>update the changelog</li> <li>update the <code>requirements-agent-release.txt</code> file</li> <li>update in-toto metadata</li> <li>commit the above changes</li> </ul> <p>You can release everything at once by setting the check to <code>all</code>.</p> <p>If you run into issues signing:</p> <ul> <li>Ensure you did <code>gpg --import &lt;YOUR_KEY_ID&gt;.gpg.pub</code></li> </ul> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release make [OPTIONS] CHECKS...
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

0 comments on commit 1592237

Please sign in to comment.