vSphere

Integration version: 5.0

Note: This integration uses one or more open source components.You can download a copy of the full source code of this integration from thestorage bucket.

Network

Access from Google Security Operations to vSphere Allow traffic over ports 443(HTTPS) and 8443 (API over SSL), or as configured in your environment.

Configure vSphere integration in Google SecOps

For detailed instructions on how to configure an integration inGoogle SecOps, seeConfigureintegrations.

Actions

Get System Info

Description

Get information about a VM.

Parameters

ParameterTypeDefault ValueDescription
Vm NameStringN/ATarget VM name.

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False
JSON Result
{"Guest":"Microsoft Windows 7 (64-bit)","Bios UUID":"423503ea-af3c-58a8-188c-f6285cec98e5","VMware Tools":"toolsNotInstalled","Ip Address":"1.1.1.1","State":"poweredOn","Template":false,"Path":"[DataStore] vm/vn.vmx","Name":"vm","Instance UUID":"50359be7-424b-e53d-5133-3f98f0e705ef"}

Get VM by IP

Description

Get VM name by the IP address.

Parameters

N/A

Run On

This action run on the IP Address entity.

Action Results

Entity Enrichment
Enrichment Field NameLogic - When to apply
GuestReturns if it exists in JSON result
Bios UUIDReturns if it exists in JSON result
VMware ToolsReturns if it exists in JSON result
Ip AddressReturns if it exists in JSON result
StateReturns if it exists in JSON result
TemplateReturns if it exists in JSON result
PathReturns if it exists in JSON result
Instance UUIDReturns if it exists in JSON result
NameReturns if it exists in JSON result
Insights

N/A

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False
JSON Result
[{"EntityResult":{"Guest":"Microsoft Windows 7 (64-bit)","Bios UUID":"423503ea-af3c-58a8-188c-f6285cec98e5","VMware Tools":"toolsNotInstalled","Ip Address":"1.1.1.1","State":"poweredOn","Template":false,"Path":"[DataStore] vm/vn.vmx","Instance UUID":"50359be7-424b-e53d-5133-3f98f0e705ef","Name":"vm"},"Entity":"1.1.1.1"}]

List VMs

Description

Get a list of all VMs that are registered.

Parameters

N/A

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False
JSON Result
[{"Guest":"Microsoft Windows 7 (64-bit)","Bios UUID":"423503ea-af3c-58a8-188c-f6285cec98e5","VMware Tools":"toolsNotInstalled","Ip Address":"1.1.1.1","State":"poweredOn","Template":false,"Path":"[DataStore] vm/vn.vmx","Name":"vm","Instance UUID":"50359be7-424b-e53d-5133-3f98f0e705ef"}]

Ping

Description

Verify that the user has a connection to VMWare vSphere via the user's device.

Parameters

N/A

Run On

This action runs on all entities.

Action Results

Entity Enrichment

N/A

Insights

N/A

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False
JSON Result
N/A

Power Off

Description

Power off a VM.

Parameters

ParameterTypeDefault ValueDescription
VM NameStringN/ATarget VM name.

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False

Power On

Description

Power on a VM.

Parameters

ParameterTypeDefault ValueDescription
VM NameStringN/AN/A

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falseisuccess:False

Reset

Description

Reset a VM.

Parameters

ParameterTypeDefault ValueDescription
VM NameStringN/AThe name of the target VM.

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False

Revert to Snapshot

Description

Revert a VM settings to a state recorded in a snapshot.

Parameters

ParameterTypeDefault ValueDescription
VM NameStringN/AThe name of the target VM.
Snapshot NameStringN/AThe name of the target snapshot.

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False

Suspend

Description

Suspend a VM.

Parameters

ParameterTypeDefault ValueDescription
VM NameStringN/AThe name of the target VM.

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False

Take Snapshot

Description

Take a VM state snapshot.

Parameters

ParameterTypeDefault ValueDescription
VM NameStringN/AThe name of the target VM.
Snapshot NameStringN/AThe name of the target snapshot.
Snapshot DescriptionStringN/ASnapshot description value.

Run On

This action runs on all entities.

Action Results

Script Result
Script Result NameValue OptionsExample
successTrue/Falsesuccess:False

Need more help?Get answers from Community members and Google SecOps professionals.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.