Documentation

vmware_vmkernel_ip_config - Configure the VMkernel IP Address

New in version 2.0.

Synopsis

Configure the VMkernel IP Address

Requirements (on host that executes module)

  • python >= 2.6
  • PyVmomi

Options

parameter required default choices comments
hostname
yes
    The hostname or IP address of the vSphere vCenter
    ip_address
    yes
      IP address to assign to VMkernel interface
      password
      yes
        The password of the vSphere vCenter

        aliases: pass, pwd
        subnet_mask
        yes
          Subnet Mask to assign to VMkernel interface
          username
          yes
            The username of the vSphere vCenter

            aliases: user, admin
            vmk_name
            yes
              VMkernel interface name

              Examples

              # Example command from Ansible Playbook
              
              - name: Configure IP address on ESX host
                local_action:
                  module: vmware_vmkernel_ip_config
                  hostname: esxi_hostname
                  username: esxi_username
                  password: esxi_password
                  vmk_name: vmk0
                  ip_address: 10.0.0.10
                  subnet_mask: 255.255.255.0
              

              Notes

              Note

              Tested on vSphere 5.5

              This is an Extras Module

              For more information on what this means please read Extras Modules

              For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.