This integration enables the management of VMware vCenter and ESXi hosts directly from XSOAR using Ansible modules. The Ansible engine is self-contained and pre-configured as part of this pack onto your XSOAR server, all you need to do is provide credentials you are ready to use the feature rich commands. This integration functions without any agents or additional software installed on the hosts by utilising VMware APIs.

Requirements

• vCenter or ESXi Server 6.5 and above
• Paid License on vCenter or ESXi Server. Free vSphere Hypervistor will be read-only

Networking

By default, TCP port 443 will be used to initiate a REST API connection to the vSphere host.

The connection will be initiated from the XSOAR engine/server specified in the instance settings.

Configure Ansible VMware in Cortex

Idempotence

The action commands in this integration are idempotent. This means that the result of performing it once is exactly the same as the result of performing it repeatedly without any intervening actions.

State Arguement

Some of the commands in this integration take a state argument. These define the desired end state of the object being managed. As a result these commands are able to perform multiple management operations depending on the desired state value. Common state values are:

Complex Command Inputs

Some commands may require structured input arguments such as lists or dictionary, these can be provided in standard JSON notation wrapped in double curly braces. For example a argument called dns_servers that accepts a list of server IPs 8.8.8.8 and 8.8.4.4 would be entered as dns_servers="{{ ['8.8.8.8', '8.8.4.4'] }}".

Other more advanced data manipulation tools such as Ansible/Jinja2 filters can also be used in-line. For example to get a random number between 0 and 60 you can use {{ 60 | random }}.

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-about-info

Provides information about VMware server to which user is connecting to
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_about_info_module.html

Base Command

vmware-about-info

Input

| Argument Name | Description | Required |
| — | — | — |

Context Output

Command Example

#### Context Example

```json
{
    "VMware": {
        "VmwareAboutInfo": [
            {
                "about_info": {
                    "api_type": "VirtualCenter",
                    "api_version": "6.5",
                    "build": "8024368",
                    "instance_uuid": "a2ed9f62-9d30-4ee8-90d0-0f8f830448b4",
                    "license_product_name": "VMware VirtualCenter Server",
                    "license_product_version": "6.0",
                    "locale_build": "000",
                    "locale_version": "INTL",
                    "os_type": "linux-x64",
                    "product_full_name": "VMware vCenter Server 6.5.0 build-8024368",
                    "product_line_id": "vpx",
                    "product_name": "VMware vCenter Server",
                    "vendor": "VMware, Inc.",
                    "version": "6.5.0"
                },
                "changed": false,
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• About_Info

  • api_type: VirtualCenter
  • api_version: 6.5
  • build: 8024368
  • instance_uuid: a2ed9f62-9d30-4ee8-90d0-0f8f830448b4
  • license_product_name: VMware VirtualCenter Server
  • license_product_version: 6.0
  • locale_build: 000
  • locale_version: INTL
  • os_type: linux-x64
  • product_full_name: VMware vCenter Server 6.5.0 build-8024368
  • product_line_id: vpx
  • product_name: VMware vCenter Server
  • vendor: VMware, Inc.
  • version: 6.5.0

vmware-category

Manage VMware categories
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_category_module.html

Base Command

vmware-category

Input

Context Output

vmware-category-info

Gather info about VMware tag categories
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_category_info_module.html

Base Command

vmware-category-info

Input

Context Output

vmware-cfg-backup

Backup / Restore / Reset ESXi host configuration
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_cfg_backup_module.html

Base Command

vmware-cfg-backup

Input

Context Output

Command Example

!vmware-cfg-backup state="saved" dest="/tmp/" esxi_hostname="esxi01"

Context Example

{
    "VMware": {
        "VmwareCfgBackup": [
            {
                "changed": true,
                "dest_file": "/tmp/configBundle-esxi01.tgz",
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True
• dest_file: /tmp/configBundle-esxi01.tgz

vmware-cluster

Manage VMware vSphere clusters
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_module.html

Base Command

vmware-cluster

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!vmware-cluster datacenter="DC1" cluster_name="cluster" enable_ha="False" enable_drs="False" enable_vsan="False"

Context Example

{
    "VMware": {
        "VmwareCluster": [
            {
                "changed": false,
                "result": null,
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False
• result: None

vmware-cluster-drs

Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_drs_module.html

Base Command

vmware-cluster-drs

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!vmware-cluster-drs datacenter="DC1" cluster_name="cluster" enable_drs="False"

Context Example

{
    "VMware": {
        "VmwareClusterDrs": [
            {
                "changed": false,
                "result": null,
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False
• result: None

vmware-cluster-ha

Manage High Availability (HA) on VMware vSphere clusters
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_ha_module.html

Base Command

vmware-cluster-ha

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!vmware-cluster-ha datacenter="DC1" cluster_name="cluster" enable_ha="False"

Context Example

{
    "VMware": {
        "VmwareClusterHa": [
            {
                "changed": false,
                "result": null,
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False
• result: None

vmware-cluster-info

Gather info about clusters available in given vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_info_module.html

Base Command

vmware-cluster-info

Input

Context Output

Command Example

!vmware-cluster-info datacenter="DC1"

Context Example

{
    "VMware": {
        "VmwareClusterInfo": [
            {
                "changed": false,
                "clusters": {
                    "cluster": {
                        "datacenter": "DC1",
                        "drs_default_vm_behavior": "fullyAutomated",
                        "drs_enable_vm_behavior_overrides": true,
                        "drs_vmotion_rate": 3,
                        "enable_ha": false,
                        "enabled_drs": false,
                        "enabled_vsan": false,
                        "ha_admission_control_enabled": true,
                        "ha_failover_level": 2,
                        "ha_host_monitoring": "enabled",
                        "ha_restart_priority": [
                            "medium"
                        ],
                        "ha_vm_failure_interval": [
                            30
                        ],
                        "ha_vm_max_failure_window": [
                            -1
                        ],
                        "ha_vm_max_failures": [
                            3
                        ],
                        "ha_vm_min_up_time": [
                            120
                        ],
                        "ha_vm_monitoring": "vmMonitoringDisabled",
                        "ha_vm_tools_monitoring": [
                            "vmMonitoringDisabled"
                        ],
                        "hosts": [
                            {
                                "folder": "/DC1/host/cluster",
                                "name": "esxi01"
                            }
                        ],
                        "moid": "domain-c7",
                        "resource_summary": {
                            "cpuCapacityMHz": 5330,
                            "cpuUsedMHz": 32,
                            "memCapacityMB": 6143,
                            "memUsedMB": 1487,
                            "pMemAvailableMB": null,
                            "pMemCapacityMB": null,
                            "storageCapacityMB": 7936,
                            "storageUsedMB": 1439
                        },
                        "tags": [],
                        "vsan_auto_claim_storage": false
                    }
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Clusters

  • Cluster

    • datacenter: DC1
    • drs_default_vm_behavior: fullyAutomated
    • drs_enable_vm_behavior_overrides: True
    • drs_vmotion_rate: 3
    • enable_ha: False
    • enabled_drs: False
    • enabled_vsan: False
    • ha_admission_control_enabled: True
    • ha_failover_level: 2
    • ha_host_monitoring: enabled
    • ha_vm_monitoring: vmMonitoringDisabled
    • moid: domain-c7

    • vsan_auto_claim_storage: False

    • Ha_Restart_Priority

      • 0: medium

    • Ha_Vm_Failure_Interval

      • 0: 30

    • Ha_Vm_Max_Failure_Window

      • 0: -1

    • Ha_Vm_Max_Failures

      • 0: 3

    • Ha_Vm_Min_Up_Time

      • 0: 120

    • Ha_Vm_Tools_Monitoring

      • 0: vmMonitoringDisabled

    • Hosts

    • esxi01

      • folder: /DC1/host/cluster
      • name: esxi01

    • Resource_Summary

      • cpuCapacityMHz: 5330
      • cpuUsedMHz: 32
      • memCapacityMB: 6143
      • memUsedMB: 1487
      • pMemAvailableMB: None
      • pMemCapacityMB: None
      • storageCapacityMB: 7936
      • storageUsedMB: 1439

    • Tags

vmware-cluster-vsan

Manages virtual storage area network (vSAN) configuration on VMware vSphere clusters
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_vsan_module.html

Base Command

vmware-cluster-vsan

Input

Context Output

| Path | Type | Description |
| — | — | — |

vmware-content-deploy-template

Deploy Virtual Machine from template stored in content library.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_content_deploy_template_module.html

Base Command

vmware-content-deploy-template

Input

Context Output

vmware-content-library-info

Gather information about VMware Content Library
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_content_library_info_module.html

Base Command

vmware-content-library-info

Input

Context Output

vmware-content-library-manager

Create, update and delete VMware content library
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_content_library_manager_module.html

Base Command

vmware-content-library-manager

Input

Context Output

vmware-datacenter

Manage VMware vSphere Datacenters
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_datacenter_module.html

Base Command

vmware-datacenter

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!vmware-datacenter datacenter_name="DC1" state="present"

Context Example

{
    "VMware": {
        "VmwareDatacenter": [
            {
                "changed": false,
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

vmware-datastore-cluster

Manage VMware vSphere datastore clusters
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_datastore_cluster_module.html

Base Command

vmware-datastore-cluster

Input

Context Output

Command Example

!vmware-datastore-cluster datacenter_name="DC1" datastore_cluster_name="Storage_Cluster" state="present"

Context Example

{
    "VMware": {
        "VmwareDatastoreCluster": [
            {
                "changed": true,
                "result": "Datastore cluster 'Storage_Cluster' created successfully.",
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True
• result: Datastore cluster ‘Storage_Cluster’ created successfully.

vmware-datastore-info

Gather info about datastores available in given vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_datastore_info_module.html

Base Command

vmware-datastore-info

Input

Context Output

Command Example

!vmware-datastore-info datacenter_name="DC1"

Context Example

{
    "VMware": {
        "VmwareDatastoreInfo": [
            {
                "changed": false,
                "datastores": [
                    {
                        "accessible": true,
                        "capacity": 8321499136,
                        "datastore_cluster": "N/A",
                        "freeSpace": 6812598272,
                        "maintenanceMode": "normal",
                        "multipleHostAccess": false,
                        "name": "datastore1",
                        "provisioned": 1508900864,
                        "type": "VMFS",
                        "uncommitted": 0,
                        "url": "ds:///vmfs/volumes/60eafb85-4b6578d0-c0a8-000c29d92704/"
                    }
                ],
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Datastores

• Datastore1

  • accessible: True
  • capacity: 8321499136
  • datastore_cluster: N/A
  • freeSpace: 6812598272
  • maintenanceMode: normal
  • multipleHostAccess: False
  • name: datastore1
  • provisioned: 1508900864
  • type: VMFS
  • uncommitted: 0
  • url: ds:///vmfs/volumes/60eafb85-4b6578d0-c0a8-000c29d92704/

vmware-datastore-maintenancemode

Place a datastore into maintenance mode
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_datastore_maintenancemode_module.html

Base Command

vmware-datastore-maintenancemode

Input

Context Output

Command Example

!vmware-datastore-maintenancemode datastore="datastore1" state="present"

Context Example

{
    "VMware": {
        "VmwareDatastoreMaintenancemode": [
            {
                "changed": true,
                "datastore_status": {
                    "datastore1": "Datastore 'datastore1' entered in maintenance mode."
                },
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True

• Datastore_Status

  • datastore1: Datastore ‘datastore1’ entered in maintenance mode.

vmware-dns-config

Manage VMware ESXi DNS Configuration
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dns_config_module.html

Base Command

vmware-dns-config

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!vmware-dns-config change_hostname_to="esxi01" domainname="foo.org" dns_servers="{{ ['8.8.8.8', '8.8.4.4'] }}"

Context Example

{
    "VMware": {
        "VmwareDnsConfig": [
            {
                "changed": false,
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

vmware-drs-group

Creates vm/host group in a given cluster.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_drs_group_module.html

Base Command

vmware-drs-group

Input

Context Output

Command Example

!vmware-drs-group cluster_name="cluster" datacenter_name="DC1" group_name="TEST_VM_01" vms="Sample_VM" state="present"

Context Example

{
    "VMware": {
        "VmwareDrsGroup": [
            {
                "changed": false,
                "msg": "Updated vm group TEST_VM_01 successfully",
                "result": {
                    "cluster": [
                        {
                            "group_name": "TEST_VM_01",
                            "type": "vm",
                            "vms": [
                                "Sample_VM"
                            ]
                        }
                    ]
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• msg: Updated vm group TEST_VM_01 successfully

• Result

  • Cluster

  • Test_Vm_01

    • group_name: TEST_VM_01

    • type: vm

    • Vms

      • 0: Sample_VM

vmware-drs-group-info

Gathers info about DRS VM/Host groups on the given cluster
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_drs_group_info_module.html

Base Command

vmware-drs-group-info

Input

Context Output

Command Example

!vmware-drs-group-info datacenter="DC1"

Context Example

{
    "VMware": {
        "VmwareDrsGroupInfo": [
            {
                "changed": false,
                "drs_group_info": {
                    "cluster": [
                        {
                            "group_name": "TEST_VM_01",
                            "type": "vm",
                            "vms": [
                                "Sample_VM"
                            ]
                        }
                    ]
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Drs_Group_Info

  • Cluster

  • Test_Vm_01

    • group_name: TEST_VM_01

    • type: vm

    • Vms

      • 0: Sample_VM

vmware-drs-rule-info

Gathers info about DRS rule on the given cluster
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_drs_rule_info_module.html

Base Command

vmware-drs-rule-info

Input

Context Output

Command Example

!vmware-drs-rule-info cluster_name="cluster"

Context Example

{
    "VMware": {
        "VmwareDrsRuleInfo": [
            {
                "changed": false,
                "drs_rule_info": {
                    "cluster": []
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Drs_Rule_Info

  • Cluster

vmware-dvs-host

Add or remove a host from distributed virtual switch
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvs_host_module.html

Base Command

vmware-dvs-host

Input

Context Output

| Path | Type | Description |
| — | — | — |

vmware-dvs-portgroup

Create or remove a Distributed vSwitch portgroup.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvs_portgroup_module.html

Base Command

vmware-dvs-portgroup

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!vmware-dvs-portgroup portgroup_name="vlan-123-portrgoup" switch_name="dvSwitch" vlan_id="123" num_ports="120" portgroup_type="earlyBinding" state="present"

Context Example

{
    "VMware": {
        "VmwareDvsPortgroup": [
            {
                "changed": true,
                "result": "None",
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True
• result: None

vmware-dvs-portgroup-find

Find portgroup(s) in a VMware environment
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvs_portgroup_find_module.html

Base Command

vmware-dvs-portgroup-find

Input

Context Output

Command Example

!vmware-dvs-portgroup-find dvswitch="dvSwitch"

Context Example

{
    "VMware": {
        "VmwareDvsPortgroupFind": [
            {
                "changed": false,
                "dvs_portgroups": [
                    {
                        "dvswitch": "dvSwitch",
                        "name": "vlan-123-portrgoup",
                        "pvlan": false,
                        "trunk": false,
                        "vlan_id": "123"
                    },
                    {
                        "dvswitch": "dvSwitch",
                        "name": "dvSwitch-DVUplinks-23",
                        "pvlan": false,
                        "trunk": true,
                        "vlan_id": "0-4094"
                    }
                ],
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Dvs_Portgroups

• Vlan-123-Portrgoup

  • dvswitch: dvSwitch
  • name: vlan-123-portrgoup
  • pvlan: False
  • trunk: False
  • vlan_id: 123

• Dvswitch-Dvuplinks-23

  • dvswitch: dvSwitch
  • name: dvSwitch-DVUplinks-23
  • pvlan: False
  • trunk: True
  • vlan_id: 0-4094

vmware-dvs-portgroup-info

Gathers info DVS portgroup configurations
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvs_portgroup_info_module.html

Base Command

vmware-dvs-portgroup-info

Input

Context Output

Command Example

!vmware-dvs-portgroup-info datacenter="DC1"

Context Example

{
    "VMware": {
        "VmwareDvsPortgroupInfo": [
            {
                "changed": false,
                "dvs_portgroup_info": {
                    "dvSwitch": [
                        {
                            "description": null,
                            "dvswitch_name": "dvSwitch",
                            "key": "dvportgroup-25",
                            "network_policy": {
                                "forged_transmits": false,
                                "mac_changes": false,
                                "promiscuous": false
                            },
                            "num_ports": 120,
                            "port_policy": {
                                "block_override": true,
                                "ipfix_override": false,
                                "live_port_move": false,
                                "network_rp_override": false,
                                "port_config_reset_at_disconnect": true,
                                "security_override": false,
                                "shaping_override": false,
                                "traffic_filter_override": false,
                                "uplink_teaming_override": false,
                                "vendor_config_override": false,
                                "vlan_override": false
                            },
                            "portgroup_name": "vlan-123-portrgoup",
                            "teaming_policy": {
                                "inbound_policy": false,
                                "notify_switches": true,
                                "policy": "loadbalance_srcid",
                                "rolling_order": false
                            },
                            "type": "earlyBinding",
                            "vlan_info": {}
                        },
                        {
                            "description": null,
                            "dvswitch_name": "dvSwitch",
                            "key": "dvportgroup-24",
                            "network_policy": {
                                "forged_transmits": true,
                                "mac_changes": false,
                                "promiscuous": false
                            },
                            "num_ports": 0,
                            "port_policy": {
                                "block_override": true,
                                "ipfix_override": false,
                                "live_port_move": false,
                                "network_rp_override": false,
                                "port_config_reset_at_disconnect": true,
                                "security_override": false,
                                "shaping_override": false,
                                "traffic_filter_override": false,
                                "uplink_teaming_override": false,
                                "vendor_config_override": false,
                                "vlan_override": false
                            },
                            "portgroup_name": "dvSwitch-DVUplinks-23",
                            "teaming_policy": {
                                "inbound_policy": true,
                                "notify_switches": true,
                                "policy": "loadbalance_srcid",
                                "rolling_order": false
                            },
                            "type": "earlyBinding",
                            "vlan_info": {}
                        }
                    ]
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Dvs_Portgroup_Info

  • Dvswitch

  • Dvswitch

    • description: None
    • dvswitch_name: dvSwitch
    • key: dvportgroup-25
    • num_ports: 120
    • portgroup_name: vlan-123-portrgoup

    • type: earlyBinding

    • Network_Policy

      • forged_transmits: False
      • mac_changes: False
      • promiscuous: False

    • Port_Policy

      • block_override: True
      • ipfix_override: False
      • live_port_move: False
      • network_rp_override: False
      • port_config_reset_at_disconnect: True
      • security_override: False
      • shaping_override: False
      • traffic_filter_override: False
      • uplink_teaming_override: False
      • vendor_config_override: False
      • vlan_override: False

    • Teaming_Policy

      • inbound_policy: False
      • notify_switches: True
      • policy: loadbalance_srcid
      • rolling_order: False

    • Vlan_Info

  • Dvswitch

    • description: None
    • dvswitch_name: dvSwitch
    • key: dvportgroup-24
    • num_ports: 0
    • portgroup_name: dvSwitch-DVUplinks-23

    • type: earlyBinding

    • Network_Policy

      • forged_transmits: True
      • mac_changes: False
      • promiscuous: False

    • Port_Policy

      • block_override: True
      • ipfix_override: False
      • live_port_move: False
      • network_rp_override: False
      • port_config_reset_at_disconnect: True
      • security_override: False
      • shaping_override: False
      • traffic_filter_override: False
      • uplink_teaming_override: False
      • vendor_config_override: False
      • vlan_override: False

    • Teaming_Policy

      • inbound_policy: True
      • notify_switches: True
      • policy: loadbalance_srcid
      • rolling_order: False

    • Vlan_Info

vmware-dvswitch

Create or remove a Distributed Switch
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvswitch_module.html

Base Command

vmware-dvswitch

Input

Context Output

Command Example

!vmware-dvswitch datacenter="DC1" switch_name="dvSwitch" version="6.0.0" mtu="9000" uplink_quantity="2" discovery_protocol="lldp" discovery_operation="both" state="present" datacenter_name="DC1"

Context Example

{
    "VMware": {
        "VmwareDvswitch": [
            {
                "changed": true,
                "result": "DVS created",
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True
• result: DVS created

vmware-dvswitch-lacp

Manage LACP configuration on a Distributed Switch
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvswitch_lacp_module.html

Base Command

vmware-dvswitch-lacp

Input

Context Output

Command Example

!vmware-dvswitch-lacp switch="dvSwitch" support_mode="enhanced"

Context Example

{
    "VMware": {
        "VmwareDvswitchLacp": [
            {
                "changed": true,
                "dvswitch": "dvSwitch",
                "link_aggregation_groups": [],
                "result": "support mode changed",
                "status": "CHANGED",
                "support_mode": "enhanced",
                "support_mode_previous": "basic"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True
• dvswitch: dvSwitch
• result: support mode changed
• support_mode: enhanced

• support_mode_previous: basic

• Link_Aggregation_Groups

vmware-dvswitch-nioc

Manage distributed switch Network IO Control
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvswitch_nioc_module.html

Base Command

vmware-dvswitch-nioc

Input

Context Output

Command Example

!vmware-dvswitch-nioc switch="dvSwitch" version="version3" resources="{{ [{'name': 'vmotion', 'limit': -1, 'reservation': 128, 'shares_level': 'normal'}, {'name': 'vsan', 'limit': -1, 'shares_level': 'custom', 'shares': 99, 'reservation': 256}] }}" state="present"

Context Example

{
    "VMware": {
        "VmwareDvswitchNioc": [
            {
                "changed": true,
                "dvswitch_nioc_status": "Enabled NIOC with version version3",
                "resources_changed": [
                    "vmotion",
                    "vsan"
                ],
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True

• dvswitch_nioc_status: Enabled NIOC with version version3

• Resources_Changed

  • 0: vmotion
  • 1: vsan

vmware-dvswitch-pvlans

Manage Private VLAN configuration of a Distributed Switch
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvswitch_pvlans_module.html

Base Command

vmware-dvswitch-pvlans

Input

Context Output

vmware-dvswitch-uplink-pg

Manage uplink portproup configuration of a Distributed Switch
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_dvswitch_uplink_pg_module.html

Base Command

vmware-dvswitch-uplink-pg

Input

Context Output

Command Example

!vmware-dvswitch-uplink-pg switch="dvSwitch" name="dvSwitch-DVUplinks" advanced="{{ {'port_config_reset_at_disconnect': True, 'block_override': True, 'vendor_config_override': False, 'vlan_override': False, 'netflow_override': False, 'traffic_filter_override': False} }}" vlan_trunk_range="0-4094" netflow_enabled="False" block_all_ports="False"

Context Example

{
    "VMware": {
        "VmwareDvswitchUplinkPg": [
            {
                "adv_block_ports": true,
                "adv_netflow": false,
                "adv_reset_at_disconnect": true,
                "adv_traffic_filtering": false,
                "adv_vendor_conf": false,
                "adv_vlan": false,
                "block_all_ports": false,
                "changed": true,
                "description": null,
                "dvswitch": "dvSwitch",
                "name": "dvSwitch-DVUplinks",
                "name_previous": "dvSwitch-DVUplinks-23",
                "netflow_enabled": false,
                "result": "name changed",
                "status": "CHANGED",
                "vlan_trunk_range": [
                    "0-4094"
                ]
            }
        ]
    }
}

Human Readable Output

CHANGED

• adv_block_ports: True
• adv_netflow: False
• adv_reset_at_disconnect: True
• adv_traffic_filtering: False
• adv_vendor_conf: False
• adv_vlan: False
• block_all_ports: False
• changed: True
• description: None
• dvswitch: dvSwitch
• name: dvSwitch-DVUplinks
• name_previous: dvSwitch-DVUplinks-23
• netflow_enabled: False

• result: name changed

• Vlan_Trunk_Range

  • 0: 0-4094

vmware-evc-mode

Enable/Disable EVC mode on vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_evc_mode_module.html

Base Command

vmware-evc-mode

Input

Context Output

Command Example

!vmware-evc-mode datacenter_name="DC1" cluster_name="cluster" evc_mode="intel-merom" state="present"

Context Example

{
    "VMware": {
        "VmwareEvcMode": [
            {
                "changed": false,
                "msg": "EVC Mode is already set to 'intel-merom' on 'cluster'.",
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False
• msg: EVC Mode is already set to ‘intel-merom’ on ‘cluster’.

vmware-folder-info

Provides information about folders in a datacenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_folder_info_module.html

Base Command

vmware-folder-info

Input

Context Output

Command Example

!vmware-folder-info datacenter="DC1"

Context Example

{
    "VMware": {
        "VmwareFolderInfo": [
            {
                "changed": false,
                "flat_folder_info": [
                    {
                        "moid": "group-v3",
                        "path": "/DC1/vm"
                    }
                ],
                "folder_info": {
                    "datastoreFolders": {
                        "moid": "group-s5",
                        "path": "/DC1/datastore",
                        "subfolders": {
                            "Storage_Cluster": {
                                "moid": "group-p13",
                                "path": "/DC1/datastore/Storage_Cluster",
                                "subfolders": {}
                            }
                        }
                    },
                    "hostFolders": {
                        "moid": "group-h4",
                        "path": "/DC1/host",
                        "subfolders": {}
                    },
                    "networkFolders": {
                        "moid": "group-n6",
                        "path": "/DC1/network",
                        "subfolders": {}
                    },
                    "vmFolders": {
                        "moid": "group-v3",
                        "path": "/DC1/vm",
                        "subfolders": {
                            "Discovered virtual machine": {
                                "moid": "group-v9",
                                "path": "/DC1/vm/Discovered virtual machine",
                                "subfolders": {}
                            }
                        }
                    }
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Flat_Folder_Info

• Group-V3

  • moid: group-v3
  • path: /DC1/vm

• Folder_Info

  • Datastorefolders

    • moid: group-s5

    • path: /DC1/datastore

    • Subfolders

      • Storage_Cluster

        • moid: group-p13

        • path: /DC1/datastore/Storage_Cluster

        • Subfolders

  • Hostfolders

    • moid: group-h4

    • path: /DC1/host

    • Subfolders

  • Networkfolders

    • moid: group-n6

    • path: /DC1/network

    • Subfolders

  • Vmfolders

    • moid: group-v3

    • path: /DC1/vm

    • Subfolders

      • Discovered Virtual Machine

        • moid: group-v9

        • path: /DC1/vm/Discovered virtual machine

        • Subfolders

vmware-guest

Manages virtual machines in vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_module.html

Base Command

vmware-guest

Input

Context Output

vmware-guest-boot-info

Gather info about boot options for the given virtual machine
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_boot_info_module.html

Base Command

vmware-guest-boot-info

Input

Context Output

vmware-guest-boot-manager

Manage boot options for the given virtual machine
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_boot_manager_module.html

Base Command

vmware-guest-boot-manager

Input

Context Output

vmware-guest-custom-attribute-defs

Manage custom attributes definitions for virtual machine from VMware
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_custom_attribute_defs_module.html

Base Command

vmware-guest-custom-attribute-defs

Input

Context Output

Command Example

!vmware-guest-custom-attribute-defs state="present" attribute_key="custom_attr_def_1"

Context Example

{
    "VMware": {
        "VmwareGuestCustomAttributeDefs": [
            {
                "changed": true,
                "custom_attribute_defs": [
                    "AutoDeploy.MachineIdentity",
                    "com.vmware.vcIntegrity.customField.scheduledTask.action",
                    "com.vmware.vcIntegrity.customField.scheduledTask.signature",
                    "com.vmware.vcIntegrity.customField.scheduledTask.target",
                    "custom_attr_def_1"
                ],
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True

• Custom_Attribute_Defs

  • 0: AutoDeploy.MachineIdentity
  • 1: com.vmware.vcIntegrity.customField.scheduledTask.action
  • 2: com.vmware.vcIntegrity.customField.scheduledTask.signature
  • 3: com.vmware.vcIntegrity.customField.scheduledTask.target
  • 4: custom_attr_def_1

vmware-guest-custom-attributes

Manage custom attributes from VMware for the given virtual machine
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_custom_attributes_module.html

Base Command

vmware-guest-custom-attributes

Input

Context Output

vmware-guest-customization-info

Gather info about VM customization specifications
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_customization_info_module.html

Base Command

vmware-guest-customization-info

Input

Context Output

Command Example

#### Context Example

```json
{
    "VMware": {
        "VmwareGuestCustomizationInfo": [
            {
                "changed": false,
                "custom_spec_info": {},
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Custom_Spec_Info

vmware-guest-disk

Manage disks related to virtual machine in given vCenter infrastructure
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_disk_module.html

Base Command

vmware-guest-disk

Input

Context Output

vmware-guest-disk-info

Gather info about disks of given virtual machine
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_disk_info_module.html

Base Command

vmware-guest-disk-info

Input

Context Output

Command Example

!vmware-guest-disk-info datacenter="DC1" name="test_vm_0001"

Context Example

{
    "VMware": {
        "VmwareGuestDiskInfo": [
            {
                "changed": false,
                "guest_disk_info": {
                    "0": {
                        "backing_datastore": "datastore1",
                        "backing_disk_mode": "persistent",
                        "backing_diskmode": "persistent",
                        "backing_eagerlyscrub": false,
                        "backing_filename": "[datastore1] test_vm_0001/test_vm_0001.vmdk",
                        "backing_thinprovisioned": true,
                        "backing_type": "FlatVer2",
                        "backing_uuid": "6000C294-3cd2-f966-9fb7-556870ae6bdf",
                        "backing_writethrough": false,
                        "capacity_in_bytes": 1073741824,
                        "capacity_in_kb": 1048576,
                        "controller_bus_number": 0,
                        "controller_key": 1000,
                        "controller_type": "paravirtual",
                        "key": 2000,
                        "label": "Hard disk 1",
                        "summary": "1,048,576 KB",
                        "unit_number": 0
                    }
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Guest_Disk_Info

  • 0

    • backing_datastore: datastore1
    • backing_disk_mode: persistent
    • backing_diskmode: persistent
    • backing_eagerlyscrub: False
    • backing_filename: [datastore1] test_vm_0001/test_vm_0001.vmdk
    • backing_thinprovisioned: True
    • backing_type: FlatVer2
    • backing_uuid: 6000C294-3cd2-f966-9fb7-556870ae6bdf
    • backing_writethrough: False
    • capacity_in_bytes: 1073741824
    • capacity_in_kb: 1048576
    • controller_bus_number: 0
    • controller_key: 1000
    • controller_type: paravirtual
    • key: 2000
    • label: Hard disk 1
    • summary: 1,048,576 KB
    • unit_number: 0

vmware-guest-find

Find the folder path(s) for a virtual machine by name or UUID
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_find_module.html

Base Command

vmware-guest-find

Input

Context Output

Command Example

!vmware-guest-find name="test_vm_0001"

Context Example

{
    "VMware": {
        "VmwareGuestFind": [
            {
                "changed": false,
                "folders": [
                    "/DC1/vm"
                ],
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Folders

  • 0: /DC1/vm

vmware-guest-info

Gather info about a single VM
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_info_module.html

Base Command

vmware-guest-info

Input

Context Output

Command Example

!vmware-guest-info datacenter="DC1" name="test_vm_0001"

Context Example

{
    "VMware": {
        "VmwareGuestInfo": [
            {
                "changed": false,
                "instance": {
                    "annotation": "",
                    "current_snapshot": null,
                    "customvalues": {},
                    "guest_consolidation_needed": false,
                    "guest_question": null,
                    "guest_tools_status": "guestToolsNotRunning",
                    "guest_tools_version": "0",
                    "hw_cluster": "cluster",
                    "hw_cores_per_socket": 1,
                    "hw_datastores": [
                        "datastore1"
                    ],
                    "hw_esxi_host": "esxi01",
                    "hw_eth0": {
                        "addresstype": "manual",
                        "ipaddresses": null,
                        "label": "Network adapter 1",
                        "macaddress": "aa:bb:dd:aa:00:14",
                        "macaddress_dash": "aa-bb-dd-aa-00-14",
                        "portgroup_key": null,
                        "portgroup_portkey": null,
                        "summary": "VM Network"
                    },
                    "hw_files": [
                        "[datastore1] test_vm_0001/test_vm_0001.vmx",
                        "[datastore1] test_vm_0001/test_vm_0001.vmsd",
                        "[datastore1] test_vm_0001/test_vm_0001.vmdk"
                    ],
                    "hw_folder": "/DC1/vm",
                    "hw_guest_full_name": null,
                    "hw_guest_ha_state": null,
                    "hw_guest_id": null,
                    "hw_interfaces": [
                        "eth0"
                    ],
                    "hw_is_template": false,
                    "hw_memtotal_mb": 512,
                    "hw_name": "test_vm_0001",
                    "hw_power_status": "poweredOff",
                    "hw_processor_count": 4,
                    "hw_product_uuid": "42166c31-2bd1-6ac0-1ebb-a6db907f529e",
                    "hw_version": "vmx-13",
                    "instance_uuid": "5016ea58-ccce-5688-f16b-82ca0b25e513",
                    "ipv4": null,
                    "ipv6": null,
                    "module_hw": true,
                    "moid": "vm-21",
                    "snapshots": [],
                    "vimref": "vim.VirtualMachine:vm-21",
                    "vnc": {}
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Instance

  • annotation:
  • current_snapshot: None
  • guest_consolidation_needed: False
  • guest_question: None
  • guest_tools_status: guestToolsNotRunning
  • guest_tools_version: 0
  • hw_cluster: cluster
  • hw_cores_per_socket: 1
  • hw_esxi_host: esxi01
  • hw_folder: /DC1/vm
  • hw_guest_full_name: None
  • hw_guest_ha_state: None
  • hw_guest_id: None
  • hw_is_template: False
  • hw_memtotal_mb: 512
  • hw_name: test_vm_0001
  • hw_power_status: poweredOff
  • hw_processor_count: 4
  • hw_product_uuid: 42166c31-2bd1-6ac0-1ebb-a6db907f529e
  • hw_version: vmx-13
  • instance_uuid: 5016ea58-ccce-5688-f16b-82ca0b25e513
  • ipv4: None
  • ipv6: None
  • module_hw: True
  • moid: vm-21

  • vimref: vim.VirtualMachine:vm-21

  • Customvalues

  • Hw_Datastores

    • 0: datastore1

  • Hw_Eth0

    • addresstype: manual
    • ipaddresses: None
    • label: Network adapter 1
    • macaddress: aa:bb:dd:aa:00:14
    • macaddress_dash: aa-bb-dd-aa-00-14
    • portgroup_key: None
    • portgroup_portkey: None
    • summary: VM Network

  • Hw_Files

    • 0: [datastore1] test_vm_0001/test_vm_0001.vmx
    • 1: [datastore1] test_vm_0001/test_vm_0001.vmsd
    • 2: [datastore1] test_vm_0001/test_vm_0001.vmdk

  • Hw_Interfaces

    • 0: eth0

  • Snapshots

  • Vnc

vmware-guest-move

Moves virtual machines in vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_move_module.html

Base Command

vmware-guest-move

Input

Context Output

Command Example

!vmware-guest-move datacenter="DC1" name="test_vm_0001" dest_folder="/DC1/vm"

Context Example

{
    "VMware": {
        "VmwareGuestMove": [
            {
                "changed": false,
                "instance": {
                    "annotation": "",
                    "current_snapshot": null,
                    "customvalues": {},
                    "guest_consolidation_needed": false,
                    "guest_question": null,
                    "guest_tools_status": "guestToolsNotRunning",
                    "guest_tools_version": "0",
                    "hw_cluster": "cluster",
                    "hw_cores_per_socket": 1,
                    "hw_datastores": [
                        "datastore1"
                    ],
                    "hw_esxi_host": "esxi01",
                    "hw_eth0": {
                        "addresstype": "manual",
                        "ipaddresses": null,
                        "label": "Network adapter 1",
                        "macaddress": "aa:bb:dd:aa:00:14",
                        "macaddress_dash": "aa-bb-dd-aa-00-14",
                        "portgroup_key": null,
                        "portgroup_portkey": null,
                        "summary": "VM Network"
                    },
                    "hw_files": [
                        "[datastore1] test_vm_0001/test_vm_0001.vmx",
                        "[datastore1] test_vm_0001/test_vm_0001.vmsd",
                        "[datastore1] test_vm_0001/test_vm_0001.vmdk"
                    ],
                    "hw_folder": "/DC1/vm",
                    "hw_guest_full_name": null,
                    "hw_guest_ha_state": null,
                    "hw_guest_id": null,
                    "hw_interfaces": [
                        "eth0"
                    ],
                    "hw_is_template": false,
                    "hw_memtotal_mb": 512,
                    "hw_name": "test_vm_0001",
                    "hw_power_status": "poweredOff",
                    "hw_processor_count": 4,
                    "hw_product_uuid": "42166c31-2bd1-6ac0-1ebb-a6db907f529e",
                    "hw_version": "vmx-13",
                    "instance_uuid": "5016ea58-ccce-5688-f16b-82ca0b25e513",
                    "ipv4": null,
                    "ipv6": null,
                    "module_hw": true,
                    "moid": "vm-21",
                    "snapshots": [],
                    "vimref": "vim.VirtualMachine:vm-21",
                    "vnc": {}
                },
                "status": "SUCCESS"
            }
        ]
    }
}

Human Readable Output

SUCCESS

• changed: False

• Instance

  • annotation:
  • current_snapshot: None
  • guest_consolidation_needed: False
  • guest_question: None
  • guest_tools_status: guestToolsNotRunning
  • guest_tools_version: 0
  • hw_cluster: cluster
  • hw_cores_per_socket: 1
  • hw_esxi_host: esxi01
  • hw_folder: /DC1/vm
  • hw_guest_full_name: None
  • hw_guest_ha_state: None
  • hw_guest_id: None
  • hw_is_template: False
  • hw_memtotal_mb: 512
  • hw_name: test_vm_0001
  • hw_power_status: poweredOff
  • hw_processor_count: 4
  • hw_product_uuid: 42166c31-2bd1-6ac0-1ebb-a6db907f529e
  • hw_version: vmx-13
  • instance_uuid: 5016ea58-ccce-5688-f16b-82ca0b25e513
  • ipv4: None
  • ipv6: None
  • module_hw: True
  • moid: vm-21

  • vimref: vim.VirtualMachine:vm-21

  • Customvalues

  • Hw_Datastores

    • 0: datastore1

  • Hw_Eth0

    • addresstype: manual
    • ipaddresses: None
    • label: Network adapter 1
    • macaddress: aa:bb:dd:aa:00:14
    • macaddress_dash: aa-bb-dd-aa-00-14
    • portgroup_key: None
    • portgroup_portkey: None
    • summary: VM Network

  • Hw_Files

    • 0: [datastore1] test_vm_0001/test_vm_0001.vmx
    • 1: [datastore1] test_vm_0001/test_vm_0001.vmsd
    • 2: [datastore1] test_vm_0001/test_vm_0001.vmdk

  • Hw_Interfaces

    • 0: eth0

  • Snapshots

  • Vnc

vmware-guest-network

Manage network adapters of specified virtual machine in given vCenter infrastructure
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_network_module.html

Base Command

vmware-guest-network

Input

Context Output

vmware-guest-powerstate

Manages power states of virtual machines in vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_powerstate_module.html

Base Command

vmware-guest-powerstate

Input

Context Output

| Path | Type | Description |
| — | — | — |

vmware-guest-screenshot

Create a screenshot of the Virtual Machine console.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_screenshot_module.html

Base Command

vmware-guest-screenshot

Input

Context Output

vmware-guest-sendkey

Send USB HID codes to the Virtual Machine’s keyboard.
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_sendkey_module.html

Base Command

vmware-guest-sendkey

Input

Context Output

vmware-guest-snapshot

Manages virtual machines snapshots in vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_snapshot_module.html

Base Command

vmware-guest-snapshot

Input

Context Output

Command Example

!vmware-guest-snapshot datacenter="DC1" folder="/DC1/vm/" name="test_vm_0001" state="present" snapshot_name="snap1" description="snap1_description"

Context Example

{
    "VMware": {
        "VmwareGuestSnapshot": [
            {
                "changed": true,
                "snapshot_results": {
                    "current_snapshot": {
                        "creation_time": "2021-07-11T17:02:28.131433+00:00",
                        "description": "snap1_description",
                        "id": 1,
                        "name": "snap1",
                        "state": "poweredOff"
                    },
                    "snapshots": [
                        {
                            "creation_time": "2021-07-11T17:02:28.131433+00:00",
                            "description": "snap1_description",
                            "id": 1,
                            "name": "snap1",
                            "state": "poweredOff"
                        }
                    ]
                },
                "status": "CHANGED"
            }
        ]
    }
}

Human Readable Output

CHANGED

• changed: True

• Snapshot_Results

  • Current_Snapshot

    • creation_time: 2021-07-11T17:02:28.131433+00:00
    • description: snap1_description
    • id: 1
    • name: snap1
    • state: poweredOff

  • Snapshots

  • Snap1

    • creation_time: 2021-07-11T17:02:28.131433+00:00
    • description: snap1_description
    • id: 1
    • name: snap1
    • state: poweredOff

vmware-guest-snapshot-info

Gather info about virtual machine’s snapshots in vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_snapshot_info_module.html

Base Command

vmware-guest-snapshot-info

Input

Context Output

vmware-guest-tools-upgrade

Module to upgrade VMTools
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_tools_upgrade_module.html

Base Command

vmware-guest-tools-upgrade

Input

Context Output

| Path | Type | Description |
| — | — | — |

vmware-guest-tools-wait

Wait for VMware tools to become available
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_tools_wait_module.html

Base Command

vmware-guest-tools-wait

Input

Context Output

vmware-guest-video

Modify video card configurations of specified virtual machine in given vCenter infrastructure
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_video_module.html

Base Command

vmware-guest-video

Input

Context Output

vmware-guest-vnc

Manages VNC remote display on virtual machines in vCenter
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/vmware_guest_vnc_module.html

Base Command

vmware-guest-vnc

Input

Context Output

Command Example

!vmware-guest-vnc folder="/DC1/vm" name="test_vm_0001" vnc_port="5990" vnc_password="vNc5ecr3t" datacenter="DC1" state="present"

Context Example

{
    "VMware": {
        "VmwareGuestVnc": [
            {
                "changed": true,
                "instance": {
                    "annotation": "",
                    "current_snapshot": {
                        "creation_time": "2021-07-11T17:02:28.131433+00:00",
                        "description": "snap1_description",
                        "id": 1,
                        "name": "snap1",
                        "state": "poweredOff"
                    },
                    "customvalues": {},
                    "guest_consolidation_needed": false,
                    "guest_question": null,
                    "guest_tools_status": "guestToolsNotRunning",
                    "guest_tools_version": "0",
                    "hw_cluster": "cluster",
                    "hw_cores_per_socket": 1,
                    "hw_datastores": [
                        "datastore1"
                    ],
                    "hw_esxi_host": "esxi01",
                    "hw_eth0": {
                        "addresstype": "manual",
                        "ipaddresses": null,
                        "label": "Network adapter 1",
                        "macaddress": "aa:bb:dd:aa:00:14",
                        "macaddress_dash": "aa-bb-dd-aa-00-14",
                        "portgroup_key": null,
                        "portgroup_portkey": null,
                        "summary": "VM Network"
                    },
                    "hw_files": [
                        "[datastore1] test_vm_0001/test_vm_0001.vmx",
                        "[datastore1] test_vm_0001/test_vm_0001-Snapshot1.vmsn",
                        "[datastore1] test_vm_0001/test_vm_0001.vmsd",
                        "[datastore1] test_vm_0001/test_vm_0001.vmdk",
                        "[datastore1] test_vm_0001/test_vm_0001-000001.vmdk"
                    ],
                    "hw_folder": "/DC1/vm",
                    "hw_guest_full_name": null,
                    "hw_guest_ha_state": null,
                    "hw_guest_id": null,
                    "hw_interfaces": [
                        "eth0"
                    ],
                    "hw_is_template": false,
                    "hw_memtotal_mb": 512,
                    "hw_name": "test_vm_0001",
                    "hw_power_status": "poweredOff",
                    "hw_processor_count": 4,
                    "hw_product_uuid": "42166c31-2bd1-6ac0-1ebb-a6db907f529e",
                    "hw_version": "vmx-13",
                    "instance_uuid": "5016ea58-ccce-5688-f16b-82ca0b25e513",
                    "ipv4": null,
                    "ipv6": null,
                    "module_hw": true,
                    "moid": "vm-21",
                    "snapshots": [
                        {
                            "creation_time": "2021-07-11T17:02:28.131433+00:00",
                            "description": "snap1_description",
                            "id": 1,
                            "name": "snap1",
                            "state": "poweredOff"
                        }
                    ],
                    "vimref": "vim.VirtualMachine:vm-21",
                    "vnc": {
                        "enabled": "TRUE",
                        "ip": "0.0.0.0",
                        "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                        "port": "5990"
                    }
                },
                "status": "CHANGED"
            }
        ]
    }
}