Community
Questions Library
Docs
Blog
Events
Swag
Github
Slack
JupiterOne
Discussions
Release Notes
Contact Us
VMware vSphere - AskJ1 Community
<main> <article class="userContent"> <h2 data-id="vmware-vsphere-jupiterone-integration-benefits">VMware vSphere + JupiterOne Integration Benefits</h2> <ul><li><p>Visualize VMware vSphere data centers, clusters, hosts and more in the<br> JupiterOne graph.</p></li> <li><p>Monitor changes to VMware vSphere resources using JupiterOne alerts.</p></li> </ul><h2 data-id="how-it-works">How it Works</h2> <ul><li><p>JupiterOne periodically fetches data centers, clusters, hosts and more from<br> VMware vSphere to update the graph.</p></li> <li><p>Write JupiterOne queries to review and monitor updates to the graph, or<br> leverage existing queries.</p></li> <li><p>Configure alerts to take action when JupiterOne graph changes, or leverage<br> existing alerts.</p></li> </ul><h2 data-id="requirements">Requirements</h2> <ul><li><p>JupiterOne requires a vSphere vCenter username and password. You need to have<br> VMware vSphere configured.</p></li> <li><p>You must have permission in JupiterOne to install new integrations.</p></li> </ul><h2 data-id="support">Support</h2> <p>If you need help with this integration, please contact<br><a rel="nofollow" href="https://support.jupiterone.io">JupiterOne Support</a>.</p> <h2 data-id="docker-walkthrough">Docker Walkthrough</h2> <p>This integration also has an image published on<br><a rel="nofollow" href="https://hub.docker.com/r/jupiterone/graph-vsphere">Docker Hub</a>. It will perform<br> a<br><a rel="nofollow" href="https://github.com/JupiterOne/sdk/blob/main/docs/integrations/development.md#command-j1-integration-run">j1-integration run</a><br> command when ran. When running, you must set the following environment<br> variables:</p> <ul><li><p>JUPITERONE_API_KEY: api-key for integration instance you would like to sync<br> with</p></li> <li><p>JUPITERONE_ACCOUNT: account id</p></li> <li><p>INTEGRATION_INSTANCE_ID: id of the integration instance you would like to sync<br> with</p></li> <li><p>DOMAIN: your vCenter path in the vSphere Client</p></li> <li>LOGIN: login for vSphere</li> <li>PASSWORD: password for vSphere</li> </ul><h2 data-id="integration-walkthrough">Integration Walkthrough</h2> <h3 data-id="in-vmware-vsphere">In VMware vSphere</h3> <ol><li>Have SDDC set up in VMware inventory.</li> <li>Make sure you're able to access SDDC's vCenter.</li> <li>Note down the vCenter credentials (login and password).</li> <li>Note down the vCenter path in the vSphere Client<br> (vcenter.sddc-X-YY-ZZ-F.vmwarevmc.com).</li> </ol><h3 data-id="in-jupiterone">In JupiterOne</h3> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>VMware vSphere</strong> integration tile and click it.</li> <li>Click the <strong>Add Configuration</strong> button and configure the following settings:</li> </ol><ul><li><p>Enter the <strong>Account Name</strong> by which you'd like to identify this VMware vSphere<br> account in JupiterOne. Ingested entities will have this value stored in<br><code class="code codeInline" spellcheck="false" tabindex="0">tag.AccountName</code> when <strong>Tag with Account Name</strong> is checked.</p></li> <li><p>Enter a <strong>Description</strong> that will further assist your team when identifying<br> the integration instance.</p></li> <li><p>Select a <strong>Polling Interval</strong> that you feel is sufficient for your monitoring<br> needs. You may leave this as <code class="code codeInline" spellcheck="false" tabindex="0">DISABLED</code> and manually execute the integration.</p></li> <li><p>Enter the <strong>VMware vSphere</strong> domain, login and password generated for use by<br> JupiterOne.</p></li> </ul><ol start="4"><li>Click <strong>Create Configuration</strong> once all values are provided.</li> </ol><h1 data-id="how-to-uninstall">How to Uninstall</h1> <ol><li>From the top navigation of the J1 Search homepage, select <strong>Integrations</strong>.</li> <li>Scroll to the <strong>VMware vSphere</strong> integration tile and click it.</li> <li>Identify and click the <strong>integration to delete</strong>.</li> <li>Click the <strong>trash can</strong> icon.</li> <li>Click the <strong>Remove</strong> button to delete the integration.</li> </ol><p><br></p> <h2 data-id="data-model">Data Model</h2> <h3 data-id="entities">Entities</h3> <p>The following entities are created:</p> <table><thead><tr><th>Resources</th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Entity <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> </tr></thead><tbody><tr><td>Account</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_client</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Application</code></td> </tr><tr><td>Cluster</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_cluster</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Cluster</code></td> </tr><tr><td>Data Center</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_data_center</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Group</code></td> </tr><tr><td>Datastore</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_datastore</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">DataStore</code></td> </tr><tr><td>Distributed Switch</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_distributed_switch</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Configuration</code></td> </tr><tr><td>Host</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_host</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Host</code></td> </tr><tr><td>Namespace</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_namespace</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Group</code></td> </tr><tr><td>Network</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_network</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Network</code></td> </tr><tr><td>Virtual Machine</td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_vm</code></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">Workload</code></td> </tr></tbody></table><h3 data-id="relationships">Relationships</h3> <p>The following relationships are created:</p> <table><thead><tr><th>Source Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> <th>Relationship <code class="code codeInline" spellcheck="false" tabindex="0">_class</code></th> <th>Target Entity <code class="code codeInline" spellcheck="false" tabindex="0">_type</code></th> </tr></thead><tbody><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_client</code></td> <td><strong>MANAGES</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_data_center</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_cluster</code></td> <td><strong>USES</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_distributed_switch</code></td> </tr><tr><td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_vm</code></td> <td><strong>USES</strong></td> <td><code class="code codeInline" spellcheck="false" tabindex="0">vsphere_network</code></td> </tr></tbody></table><p><br></p> </article> </main>
.png)