VMware

VMware vCenter server is a centralized management application that lets you manage virtual machines and ESXi hosts centrally.
This integration was integrated and tested with version 7.03 of VMware

Configure VMware in Cortex

Use Cases

• Create and revert to snapshot.
• Get information regarding virtual machines.
• Power-on, power-off, suspend, reboot, clone, create, delete, relocate, resigster and unregister virtual machines.

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

vmware-get-vms

Returns all virtual machines on a system.

Base Command

vmware-get-vms

Input

Context Output

Command Example

!vmware-get-vms

Context Example

{
 "VMWare":[
   {
       "Guest": "Ubuntu Linux (64-bit)",
       "HostName": "ubuntu",
       "IP": "192.168.100.1",
       "MACAddress": "00:50:56:bc:86:ec",
       "Name": "UbuntuTest",
       "Path": "[datastore1] UbuntuTest/UbuntuTest.vmx",
       "State": "poweredOn",
       "Template": false,
       "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
 ]
}

Human Readable Output

vmware-poweron

Powers on a powered-off or suspended virtual machine.

Base Command

vmware-poweron

Input

Context Output

Command Example

!vmware-poweron vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19"

Context Example

{
 "VMWare": {
     "State": "poweredOn",
     "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
}

Human Readable Output

Virtual Machine was powered on successfully.

vmware-poweroff

Powers off a powered-on or suspended virtual machine.

Base Command

vmware-poweroff

Input

Context Output

Command Example

!vmware-poweroff vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19"

Context Example

{
 "VMWare": {
     "State": "poweredOff",
     "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
}

Human Readable Output

Virtual Machine was powered off successfully.

vmware-hard-reboot

Reboots a powered-on virtual machine.

Base Command

vmware-hard-reboot

Input

Context Output

Command Example

!vmware-hard-reboot vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19"

Context Example

{
 "VMWare": {
     "State": "HardRebooted",
     "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
}

Human Readable Output

Virtual Machine was rebooted successfully.

vmware-suspend

Suspends a powered-on virtual machine.

Base Command

vmware-suspend

Input

Context Output

Command Example

!vmware-suspend vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19"

Context Example

{
 "VMWare": {
     "State": "suspended",
     "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
}

Human Readable Output

Virtual Machine was suspended successfully.

vmware-soft-reboot

Issues a command to the guest operating system asking it to perform a reboot.

Base Command

vmware-soft-reboot

Input

Context Output

There is no context output for this command.

Command Example

!vmware-soft-reboot vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19"

Human Readable Output

A request to reboot the guest has been sent.

vmware-create-snapshot

Creates a VM snapshot.

Base Command

vmware-create-snapshot

Input

Context Output

There is no context output for this command.

Command Example

!vmware-create-snapshot vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19" name="SnapShotName" description="A daily snapshot of VM" memory=true quiesce=false

Human Readable Output

Snapshot SnapShotName completed.

vmware-revert-snapshot

Reverts VM to snapshot.

Base Command

vmware-revert-snapshot

Input

Context Output

Command Example

!vmware-revert-snapshot vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19" snapshot-name="SnapShotName"

Context Example

{
 "VMWare": {
     "Snapshot": "Reverted to SnapShotName",
     "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
}

Human Readable Output

Reverted to snapshot SnapShotName successfully.

vmware-get-events

Gets events of a VM.

Base Command

vmware-get-events

Input

Context Output

Command Example

!vmware-get-events vm-uuid=525306-77f9-ac98-77d3-63bb537ad7d2 start-date="2021-12-14T00:00:00" end-date="2021-12-16T00:00:00" user="VSPHERE.TEST"

Context Example

{
  "VMWareEvenet": [
        {
            "CreatedTime": "2021-12-15 09:38:46", 
            "UserName": "VSPHERE.TEST", 
            "Event": "Guest OS reboot for Datacenter", 
            "id": 99973
        }
    ]
}

Human Readable Output

vmware-change-nic-state

Changes the state of a VM NIC.

Base Command

vmware-change-nic-state

Input

Context Output

Command Example

!vmware-change-nic-state vm-uuid="503ca58b-0821-cf21-fb56-459e55df6d19" nic-state="disconnected" nic-number=1

Context Example

{
 "VMWare": {
     "NICState": "disconnected",
     "UUID": "503ca58b-0821-cf21-fb56-459e55df6d19"
   }
}

Human Readable Output

Virtual Machine’s NIC was disconnected successfully.

vmware-list-vms-by-tag

Lists all virtual storage objects attached to the tag.

Base Command

vmware-list-vms-by-tag

Input

Context Output

Command Example

!vmware-list-vms-by-tag category="Test Category" tag=test

Context Example

{
  "VMWareTag": [
        {
            "Category": "Test Category", 
            "VM": "CentOS7_VMware_Integration_Test", 
            "TagName": "test"
        }, 
        {
            "Category": "Test Category", 
            "VM": "enhancement test 2", 
            "TagName": "test"
        }, 
        {
            "Category": "Test Category", 
            "VM": "VMware_enhancement_test_vm", 
            "TagName": "test"
        }
    ]}

Human Readable Output

vmware-create-vm

Creates a new virtual machine in the current folder and attaches it to the specified resource pool. This operation creates a virtual machine, instead of cloning a virtual machine from an existing one.

Base Command

vmware-create-vm

Input

Context Output

Command Example

!vmware-create-vm cpu-allocation=1 cpu-num=1 guest-os-familiy=Windows guest-os-version="Microsoft Windows Server 2019 (64-bit)" host=11.11.1.111 memory=32 name="test_vm_ui" virtual-memory=32 folder="vm"

Context Example

{
  "VMWare": [
        {
           "MACAddress": "", 
            "Name": "test_vm_ui", 
            "Deleted": false, 
            "IP": " ", 
            "HostName": " ", 
            "SnapshotCreateDate": "", 
            "UUID": "503d-11bc-834e-51a8-51b19a1b6924", 
            "State": "poweredOff", 
            "Snapshot": " ", 
            "Template": false, 
            "SnapshotUUID": "", 
            "Path": "[datastore1] test_vm_ui/test_vm_ui.vmx", 
            "Guest": "Other (32-bit)"
        }
    ]
}

Human Readable Output

vmware-clone-vm

Creates a clone of this virtual machine. If the virtual machine is used as a template, this method corresponds to the deploy command.

Base Command

vmware-clone-vm

Input

Context Output

Command Example

!vmware-clone-vm folder=vm name=cloned_vm powerOn=false uuid=603e-65d9-0fea7b29b9a7

Context Example

{
  "VMWare": [
        {
            "MACAddress": "", 
            "Name": "cloned_vm", 
            "Deleted": false, 
            "IP": " ", 
            "HostName": " ", 
            "SnapshotCreateDate": "", 
            "UUID": "e5aa-8fe8-a3faf1191395", 
            "State": "poweredOff", 
            "Template": false, 
            "SnapshotUUID": "", 
            "Path": "[datastore1] cloned_vm/cloned_vm.vmx", 
            "Guest": "Other (32-bit)"
        }
    ]
}

Human Readable Output

vmware-relocate-vm

Relocates a virtual machine to a specified location.

Base Command

vmware-relocate-vm

Input

Context Output

There is no context output for this command.

Command Example

!vmware-relocate-vm folder=enhancement_check priority=defaultPriority uuid=e5aa-8fe8-a3faf1191395

Human Readable Output

Virtual Machine was relocated successfully.

vmware-delete-vm

Destroys this object, deleting its contents and removing it from its parent folder (if any).

Base Command

vmware-delete-vm

Input

Context Output

Command Example

!vmware-delete-vm uuid=503d537f-a8d0-e5aa-8fe8-a3faf1191395

Human Readable Output

Virtual Machine was deleted successfully.

vmware-register-vm

Adds an existing virtual machine to the folder.

Base Command

vmware-register-vm

Input

Context Output

There is no context output for this command.

Command Example

!vmware-register-vm path="[datastore1] test_vm_ui/test_vm_ui.vmx" folder=vm host=192.168.1.140 name=rgistered_vm asTemplate=false

Human Readable Output

Virtual Machine was registered successfully.

vmware-unregister-vm

emoves this virtual machine from the inventory without removing any of the virtual machine’s files on disk.

Base Command

vmware-unregister-vm

Input

Context Output

There is no context output for this command.

Command Example

!vmware-unregister-vm uuid=503d9bc9-5c5a-603e-65d9-0fea7b29b9a7

Human Readable Output

Virtual Machine was unregistered successfully.