category: IT Services
provider: Broadcom
sectionorder:
- Connect
- Collect
commonfields:
  id: VMware
  version: -1
configuration:
- name: url
  display: Server URL (i.e., 192.168.0.1:30022)
  required: true
  defaultvalue:
  type: 0
  additionalinfo: The server URL of the VCenter.
  section: Connect
- name: credentials
  display: Credentials
  required: true
  defaultvalue:
  type: 9
  additionalinfo: Username and password used to login into the system.
  displaypassword: ""
  section: Connect
- name: redirect_std_out
  display: Redirect stdout
  type: 8
  additionalinfo: Used for troubleshooting purposes.
  required: false
  section: Connect
- name: insecure
  display: Trust any certificate (not secure)
  type: 8
  additionalinfo:
  required: false
  section: Connect
- name: proxy
  display: Use system proxy settings
  defaultvalue: "false"
  type: 8
  additionalinfo:
  required: false
  section: Connect
description: VMware vCenter server is a centralized management application that lets you manage virtual machines and ESXi hosts centrally.
display: VMware
name: VMware
script:
  commands:
  - arguments:
    - name: ip
      description: A comma-separated list of IPs to filter VMs by.
      isArray: true
    - name: hostname
      description: Hostname to filter VMs by.
    - name: vm_name
      description: A comma-separated list of VM names to filter VMs by.
      isArray: true
    - name: uuid
      description: A comma-separated list of UUIDs to filter VMs by.
      isArray: true
    - description: Number of results to display.
      name: limit
    - description: Page number you would like to view. Each page contains page_size values. Must be used along with page_size.
      name: page
    - description: Number of results per page to display.
      name: page_size
    description: Returns all virtual machines on a system.
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.State
      description: VM State (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      related: ""
    name: vmware-get-vms
    outputs:
    - contextPath: VMWare.Name
      description: VM name.
      type: String
    - contextPath: VMWare.Template
      description: true if template, else false.
      type: bool
    - contextPath: VMWare.Path
      description: Path to VM.
      type: String
    - contextPath: VMWare.Guest
      description: Guest full name.
      type: String
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.IP
      description: VM IP address.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      type: String
    - contextPath: VMWare.HostName
      description: Host name of VM.
      type: String
    - contextPath: VMWare.MACAddress
      description: MAC address of VM.
      type: String
    - contextPath: VMWare.SnapshotCreateDate
      description: The date and time when the last snapshot was created.
      type: String
    - contextPath: VMWare.SnapshotUUID
      description: UUID of the last snapshot of the VM.
      type: String
    - contextPath: VMWare.Deleted
      description: If true, the VM was deleted.
      type: Boolean
  - arguments:
    - description: VM UUID of virtual machine to be powered on.
      name: vm-uuid
      required: true
    description: Powers on a powered-off or suspended virtual machine.
    execution: true
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      related: ""
    name: vmware-poweron
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      type: String
  - arguments:
    - description: VM UUID of virtual machine to be powered on.
      name: vm-uuid
      required: true
    description: Powers off a powered-on or suspended virtual machine.
    execution: true
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      related: ""
    name: vmware-poweroff
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      type: String
  - arguments:
    - description: VM UUID of virtual machine to reboot.
      name: vm-uuid
      required: true
    description: Reboots a powered-on virtual machine.
    execution: true
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      related: ""
    name: vmware-hard-reboot
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      type: String
  - arguments:
    - description: VM UUID of virtual machine to be suspended.
      name: vm-uuid
      required: true
    description: Suspends a powered-on virtual machine.
    execution: true
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      related: ""
    name: vmware-suspend
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e,. poweredOn, poweredOff, suspended, HardRebooted).
      type: String
  - arguments:
    - description: VM UUID of virtual machine to reboot.
      name: vm-uuid
      required: true
    description: Issues a command to the guest operating system asking it to perform a reboot.
    name: vmware-soft-reboot
    outputs: []
  - arguments:
    - description: VM UUID of virtual machine to take snapshot of.
      name: vm-uuid
      required: true
    - description: Snapshot name.
      name: name
    - description: Snapshot description.
      name: description
    - auto: PREDEFINED
      defaultValue: "true"
      description: Snapshot the virtual machine's memory. Default is "True".
      name: memory
      predefined:
      - "true"
      - "false"
    - auto: PREDEFINED
      defaultValue: "false"
      description: Quiesce guest file system (needs VMWare Tools installed). Default is "False".
      name: quiesce
      predefined:
      - "true"
      - "false"
    description: Creates VM snapshot.
    name: vmware-create-snapshot
    outputs: []
  - arguments:
    - description: Snapshot name to revert to.
      name: snapshot-name
      required: true
    - description: VM UUID of virtual machine to revert snapshot.
      name: vm-uuid
      required: true
    description: Reverts VM to snapshot.
    execution: true
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.Snapshot
      description: Name of the snapshot reverted to.
      related: ""
    name: vmware-revert-snapshot
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.Snapshot
      description: Name of the snapshot reverted to.
      type: String
  - arguments:
    - description: VM UUID of virtual machine to get events of.
      name: vm-uuid
      required: true
    - name: event-type
      description: Type of events to get, given in CSV (i.e.,  VmGuestRebootEvent,VmGuestShutdownEvent).
      defaultValue: VmGuestRebootEvent,VmGuestShutdownEvent,VmPoweredOnEvent,VmPoweredOffEvent,VmSuspendedEvent
    - name: start_date
      description: Date from which to start the event search.
    - name: end_date
      description: Date at which to stop the event search.
    - name: user
      description: If specified, only events triggered by the given user are retrieved.
    - description: Number of results to display.
      name: limit
    - description: The page number from which to start the search. Must be used along with page_size.
      name: page
    - description: The number of results per page to display.
      name: page_size
    description: Gets events of VM.
    name: vmware-get-events
    outputs:
    - contextPath: VMWareEvents.id
      description: The ID of the event.
      type: String
    - contextPath: VMWareEvents.Event
      description: Description of the event.
      type: String
    - contextPath: VMWareEvents.CreatedTime
      description: Creation time of the event.
      type: String
    - contextPath: VMWareEvents.UserName
      description: The user name of the user who triggered the event.
      type: Date
  - arguments:
    - description: VM UUID of virtual machine to change NIC state.
      name: vm-uuid
      required: true
    - auto: PREDEFINED
      description: New state of the NIC to be changed.
      name: nic-state
      predefined:
      - connect
      - disconnect
      - delete
      required: true
    - description: Number of the NIC to be changed.
      name: nic-number
      required: true
    description: Changes the state of a VM NIC.
    important:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      related: ""
    - contextPath: VMWare.NICState
      description: VM NIC state (i.e., connected, disconnected, delete).
      related: ""
    name: vmware-change-nic-state
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.NICState
      description: VM NIC state (i.e., connected, disconnected, delete).
      type: String
  - name: vmware-list-vms-by-tag
    description: Lists all virtual storage objects attached to the tag.
    arguments:
    - name: category
      description: The category to which the tag belongs.
      required: true
    - name: tag
      description: The tag to be queried.
      required: true
    outputs:
    - contextPath: VMWareTag.TagName
      description: The tag that was queried.
      type: String
    - contextPath: VMwareTag.Category
      description: The category to which the tag belongs.
      type: String
    - contextPath: VMwareTag.VM
      description: VM name to which the tag is attached.
      type: String
  - name: vmware-create-vm
    description: Creates a new virtual machine in the current folder and attaches it to the specified resource pool. This operation creates a virtual machine, rather than cloning an existing one.
    arguments:
    - name: name
      description: Display name of the virtual machine.
      required: true
    - name: cpu-num
      description: Number of virtual processors in a virtual machine.
      required: true
    - name: cpu-allocation
      description: Resource limits for CPU.
      required: true
    - name: memory
      description: Resource limits for memory.
      required: true
    - name: virtual-memory
      description: Size of a virtual machine's memory, in MB.
      required: true
    - name: guest_id
      description: Short guest operating system identifier.
    - name: host
      description: The target host on which the virtual machine will run.
      required: true
    - name: folder
      description: The target folder in which the virtual machine will be located.
      required: true
    outputs:
    - contextPath: VMWare.vName
      description: VM name.
      type: String
    - contextPath: VMWare.Template
      description: If true, then the VM is a template, false otherwise.
      type: Boolean
    - contextPath: VMWare.Path
      description: Path to VM.
      type: String
    - contextPath: VMWare.Guest
      description: Guest full name.
      type: String
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.IP
      description: VM IP address.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      type: String
    - contextPath: VMWare.HostName
      description: Host name of VM.
      type: String
    - contextPath: VMWare.MACAddress
      description: MAC address of VM.
      type: String
    - contextPath: VMWare.SnapshotCreateDate
      description: The date and time when the last snapshot was created.
      type: String
    - contextPath: VMWare.SnapshotUUID
      description: UUID of the last snapshot of the VM.
      type: String
    - contextPath: VMWare.Deleted
      description: If true, the VM was deleted.
      type: Boolean
  - name: vmware-clone-vm
    description: Creates a clone of this virtual machine. If the virtual machine is used as a template, this method corresponds to the deploy command.
    arguments:
    - name: uuid
      description: The UUID of the VM to clone.
      required: true
    - name: name
      description: The name of the new virtual machine.
      required: true
    - name: folder
      description: The location of the new virtual machine.
      required: true
    - name: template
      description: Specifies whether or not the new virtual machine should be marked as a template.
    - auto: PREDEFINED
      name: powerOn
      description: Specifies whether or not the new VirtualMachine should be powered on after creation.
      required: true
      defaultValue: "False"
      predefined:
      - "true"
      - "false"
    - name: datastore
      description: The datastore where the virtual machine should be located.
    - name: host
      description: The target host for the virtual machine.
    - name: pool
      description: The resource pool to which this virtual machine should be attached.
    outputs:
    - contextPath: VMWare.Name
      description: VM name.
      type: String
    - contextPath: VMWare.Template
      description: true if template, else false.
      type: Boolean
    - contextPath: VMWare.Path
      description: Path to VM.
      type: String
    - contextPath: VMWare.Guest
      description: Guest full name.
      type: String
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.IP
      description: VM IP address.
      type: String
    - contextPath: VMWare.State
      description: VM state (i.e., poweredOn, poweredOff, suspended, HardRebooted).
      type: String
    - contextPath: VMWare.HostName
      description: Host name of VM.
      type: String
    - contextPath: VMWare.MACAddress
      description: MAC address of VM.
      type: String
    - contextPath: VMWare.SnapshotCreateDate
      description: The date and time when the last snapshot was created.
      type: String
    - contextPath: VMWare.SnapshotUUID
      description: UUID of the last snapshot of the VM.
      type: String
    - contextPath: VMWare.Deleted
      description: If true, the VM was deleted.
      type: Boolean
  - name: vmware-relocate-vm
    description: Relocates a virtual machine to a specified location.
    arguments:
    - name: datastore
      description: The datastore where the virtual machine should be located. If not specified, the current datastore is used.
    - name: folder
      description: The folder where the virtual machine should be located.
      required: true
    - name: host
      description: The target host for the virtual machine.
    - name: pool
      description: The resource pool to which this virtual machine should be attached.
    - name: service
      description: The service endpoint of vCenter where the virtual machine should be located. If not specified, the current vCenter service is used.
    - name: profile
      description: Storage profile requirement for Virtual Machine's home directory.
    - auto: PREDEFINED
      name: priority
      description: The task priority.
      required: true
      predefined:
      - defaultPriority
      - highPriority
      - lowPriority
    - name: uuid
      description: The UUID of the VM to relocate.
      required: true
    outputs: []
  - name: vmware-delete-vm
    description: Destroys this object, deleting its contents and removing it from its parent folder (if any).
    arguments:
    - name: uuid
      description: The UUID of the VM to delete.
      required: true
    outputs:
    - contextPath: VMWare.UUID
      description: VM instance UUID.
      type: String
    - contextPath: VMWare.Deleted
      description: If true, the VM was deleted.
      type: String
  - name: vmware-register-vm
    description: Adds an existing virtual machine to the folder.
    arguments:
    - name: path
      description: A datastore path to the virtual machine.
      required: true
      isArray: true
    - name: name
      description: The name to be assigned to the virtual machine.
      required: true
    - name: host
      description: The target host on which the virtual machine will run.
      required: true
    - auto: PREDEFINED
      defaultValue: "False"
      name: as_template
      description: Specifies whether or not the virtual machine should be marked as a template.
      predefined:
      - "true"
      - "false"
    - name: folder
      description: Folder to register the VM to.
      required: true
    outputs: []
  - name: vmware-unregister-vm
    description: Removes this virtual machine from the inventory without removing any of the virtual machine's files on disk.
    arguments:
    - name: uuid
      description: The UUID of the VM to remove.
      required: true
      isArray: true
    outputs: []
  dockerimage: demisto/vmware:2.0.0.10133006
  script: ""
  subtype: python3
  type: python
fromversion: 5.0.0
tests:
- VMWare Test