mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
283 lines
11 KiB
Python
283 lines
11 KiB
Python
#!/usr/bin/env python
|
|
|
|
"""
|
|
* *******************************************************
|
|
* Copyright (c) VMware, Inc. 2016-2018. All Rights Reserved.
|
|
* SPDX-License-Identifier: MIT
|
|
* *******************************************************
|
|
*
|
|
* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
|
|
* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
|
|
* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
|
|
* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
"""
|
|
|
|
__author__ = 'VMware, Inc.'
|
|
__vcenter_version__ = '6.5+'
|
|
|
|
from vmware.vapi.vsphere.client import create_vsphere_client
|
|
|
|
from com.vmware.vcenter.vm.hardware_client import Ethernet
|
|
from com.vmware.vcenter_client import Network
|
|
|
|
from samples.vsphere.common.sample_util import parse_cli_args_vm
|
|
from samples.vsphere.common.sample_util import pp
|
|
from samples.vsphere.vcenter.helper import network_helper
|
|
from samples.vsphere.vcenter.setup import testbed
|
|
from samples.vsphere.vcenter.helper.vm_helper import get_vm
|
|
from samples.vsphere.common.ssl_helper import get_unverified_session
|
|
|
|
"""
|
|
Demonstrates how to configure virtual ethernet adapters of a virtual machine.
|
|
|
|
Sample Prerequisites:
|
|
The sample needs an existing VM.
|
|
"""
|
|
|
|
vm = None
|
|
vm_name = None
|
|
client = None
|
|
cleardata = False
|
|
nics_to_delete = []
|
|
orig_nic_summaries = None
|
|
|
|
|
|
def setup(context=None):
|
|
global vm, vm_name, client, cleardata
|
|
if context:
|
|
# Run sample suite via setup script
|
|
client = context.client
|
|
vm_name = testbed.config['VM_NAME_DEFAULT']
|
|
else:
|
|
# Run sample in standalone mode
|
|
server, username, password, cleardata, skip_verification, vm_name = \
|
|
parse_cli_args_vm(testbed.config['VM_NAME_DEFAULT'])
|
|
session = get_unverified_session() if skip_verification else None
|
|
|
|
# Connect to vSphere client
|
|
client = create_vsphere_client(server=server,
|
|
username=username,
|
|
password=password,
|
|
session=session)
|
|
|
|
|
|
def run():
|
|
global vm
|
|
vm = get_vm(client, vm_name)
|
|
if not vm:
|
|
raise Exception('Sample requires an existing vm with name ({}). '
|
|
'Please create the vm first.'.format(vm_name))
|
|
print("Using VM '{}' ({}) for Disk Sample".format(vm_name, vm))
|
|
|
|
# Get standard portgroup to use as backing for sample
|
|
standard_network = network_helper.get_network_backing(
|
|
client,
|
|
testbed.config['STDPORTGROUP_NAME'],
|
|
testbed.config['VM_DATACENTER_NAME'],
|
|
Network.Type.STANDARD_PORTGROUP)
|
|
|
|
# Get distributed portgroup to use as backing for sample
|
|
distributed_network = network_helper.get_network_backing(
|
|
client,
|
|
testbed.config['VDPORTGROUP1_NAME'],
|
|
testbed.config['VM_DATACENTER_NAME'],
|
|
Network.Type.DISTRIBUTED_PORTGROUP)
|
|
|
|
# Get opaque portgroup to use as backing for sample
|
|
opaque_network = None
|
|
if testbed.config['OPAQUEPORTGROUP1_NAME']:
|
|
opaque_network = network_helper.get_network_backing(
|
|
client,
|
|
testbed.config['OPAQUEPORTGROUP1_NAME'],
|
|
testbed.config['VM_DATACENTER_NAME'],
|
|
Network.Type.OPAQUE_NETWORK)
|
|
|
|
print('\n# Example: List all Ethernet adapters for a VM')
|
|
nic_summaries = client.vcenter.vm.hardware.Ethernet.list(vm=vm)
|
|
print('vm.hardware.Ethernet.list({}) -> {}'.format(vm, nic_summaries))
|
|
|
|
# Save current list of Ethernet adapters to verify that we have cleaned
|
|
# up properly
|
|
global orig_nic_summaries
|
|
orig_nic_summaries = nic_summaries
|
|
|
|
# Get information for each Ethernet on the VM
|
|
for nic_summary in nic_summaries:
|
|
nic = nic_summary.nic
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm=vm, nic=nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, nic_info))
|
|
|
|
global nics_to_delete
|
|
|
|
print('\n# Example: Create Ethernet Nic using STANDARD_PORTGROUP with '
|
|
'default settings')
|
|
nic_create_spec = Ethernet.CreateSpec(
|
|
backing=Ethernet.BackingSpec(
|
|
type=Ethernet.BackingType.STANDARD_PORTGROUP,
|
|
network=standard_network))
|
|
nic = client.vcenter.vm.hardware.Ethernet.create(vm, nic_create_spec)
|
|
print('vm.hardware.Ethernet.create({}, {}) -> {}'.
|
|
format(vm, nic_create_spec, nic))
|
|
nics_to_delete.append(nic)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Example: Create Ethernet Nic using DISTRIBUTED_PORTGROUP '
|
|
'with defaults')
|
|
nic_create_spec = Ethernet.CreateSpec(
|
|
backing=Ethernet.BackingSpec(
|
|
type=Ethernet.BackingType.DISTRIBUTED_PORTGROUP,
|
|
network=distributed_network))
|
|
nic = client.vcenter.vm.hardware.Ethernet.create(vm, nic_create_spec)
|
|
print('vm.hardware.Ethernet.create({}, {}) -> {}'.
|
|
format(vm, nic_create_spec, nic))
|
|
nics_to_delete.append(nic)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Example: Create Ethernet Nic using STANDARD_'
|
|
'PORTGROUP specifying')
|
|
print('# start_connected=True, allow_guest_control=True,')
|
|
print('# mac_type, mac_Address, wake_on_lan_enabled')
|
|
nic_create_spec = Ethernet.CreateSpec(
|
|
start_connected=True,
|
|
allow_guest_control=True,
|
|
mac_type=Ethernet.MacAddressType.MANUAL,
|
|
mac_address='01:23:45:67:89:10',
|
|
wake_on_lan_enabled=True,
|
|
backing=Ethernet.BackingSpec(
|
|
type=Ethernet.BackingType.STANDARD_PORTGROUP,
|
|
network=standard_network))
|
|
nic = client.vcenter.vm.hardware.Ethernet.create(vm, nic_create_spec)
|
|
print('vm.hardware.Ethernet.create({}, {}) -> {}'.
|
|
format(vm, nic_create_spec, nic))
|
|
nics_to_delete.append(nic)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Example: Create Ethernet Nic using DISTRIBUTED_PORTGROUP '
|
|
'specifying')
|
|
print('# start_connected=True, allow_guest_control=True,')
|
|
print('# mac_type, mac_Address, wake_on_lan_enabled')
|
|
nic_create_spec = Ethernet.CreateSpec(
|
|
start_connected=True,
|
|
allow_guest_control=True,
|
|
mac_type=Ethernet.MacAddressType.MANUAL,
|
|
mac_address='24:68:10:12:14:16',
|
|
wake_on_lan_enabled=True,
|
|
backing=Ethernet.BackingSpec(
|
|
type=Ethernet.BackingType.DISTRIBUTED_PORTGROUP,
|
|
network=distributed_network))
|
|
nic = client.vcenter.vm.hardware.Ethernet.create(vm, nic_create_spec)
|
|
print('vm.hardware.Ethernet.create({}, {}) -> {}'.
|
|
format(vm, nic_create_spec, nic))
|
|
nics_to_delete.append(nic)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
if opaque_network:
|
|
print('\n# Example: Create Ethernet Nic using OPAQUE PORTGROUP with '
|
|
'default settings')
|
|
nic_create_spec = Ethernet.CreateSpec(
|
|
backing=Ethernet.BackingSpec(
|
|
type=Ethernet.BackingType.OPAQUE_NETWORK,
|
|
network=opaque_network))
|
|
nic = client.vcenter.vm.hardware.Ethernet.create(vm, nic_create_spec)
|
|
print('vm.hardware.Ethernet.create({}, {}) -> {}'.
|
|
format(vm, nic_create_spec, nic))
|
|
nics_to_delete.append(nic)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
# Change the last nic that was created
|
|
print('\n# Example: Update Ethernet Nic with different backing')
|
|
nic_update_spec = Ethernet.UpdateSpec(
|
|
backing=Ethernet.BackingSpec(
|
|
type=Ethernet.BackingType.STANDARD_PORTGROUP,
|
|
network=standard_network))
|
|
print('vm.hardware.Ethernet.update({}, {}, {})'.
|
|
format(vm, nic, nic_update_spec))
|
|
client.vcenter.vm.hardware.Ethernet.update(vm, nic, nic_update_spec)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Example: Update Ethernet Nic wake_on_lan_enabled=False')
|
|
print('# mac_type=GENERATED,')
|
|
print('# start_connected=False,')
|
|
print('# allow_guest_control=False')
|
|
nic_update_spec = Ethernet.UpdateSpec(
|
|
wake_on_lan_enabled=False,
|
|
mac_type=Ethernet.MacAddressType.GENERATED,
|
|
start_connected=False,
|
|
allow_guest_control=False)
|
|
print('vm.hardware.Ethernet.update({}, {}, {})'.
|
|
format(vm, nic, nic_update_spec))
|
|
client.vcenter.vm.hardware.Ethernet.update(vm, nic, nic_update_spec)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Starting VM to run connect/disconnect sample')
|
|
print('vm.Power.start({})'.format(vm))
|
|
client.vcenter.vm.Power.start(vm)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Example: Connect Ethernet Nic after powering on VM')
|
|
client.vcenter.vm.hardware.Ethernet.connect(vm, nic)
|
|
print('vm.hardware.Ethernet.connect({}, {})'.format(vm, nic))
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Example: Disconnect Ethernet Nic while VM is powered on')
|
|
client.vcenter.vm.hardware.Ethernet.disconnect(vm, nic)
|
|
print('vm.hardware.Ethernet.disconnect({}, {})'.format(vm, nic))
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
print('\n# Stopping VM after connect/disconnect sample')
|
|
print('vm.Power.start({})'.format(vm))
|
|
client.vcenter.vm.Power.stop(vm)
|
|
nic_info = client.vcenter.vm.hardware.Ethernet.get(vm, nic)
|
|
print('vm.hardware.Ethernet.get({}, {}) -> {}'.
|
|
format(vm, nic, pp(nic_info)))
|
|
|
|
# List all Nics for a VM
|
|
nic_summaries = client.vcenter.vm.hardware.Ethernet.list(vm=vm)
|
|
print('vm.hardware.Ethernet.list({}) -> {}'.format(vm, nic_summaries))
|
|
|
|
|
|
def cleanup():
|
|
print('\n# Cleanup: Delete VM Nics that were added')
|
|
for nic in nics_to_delete:
|
|
client.vcenter.vm.hardware.Ethernet.delete(vm, nic)
|
|
print('vm.hardware.Ethernet.delete({}, {})'.format(vm, nic))
|
|
|
|
nic_summaries = client.vcenter.vm.hardware.Ethernet.list(vm)
|
|
print('vm.hardware.Ethernet.list({}) -> {}'.format(vm, nic_summaries))
|
|
if set(orig_nic_summaries) != set(nic_summaries):
|
|
print('vm.hardware.Ethernet WARNING: '
|
|
'Final Nic info does not match original')
|
|
|
|
|
|
def main():
|
|
setup()
|
|
run()
|
|
if cleardata:
|
|
cleanup()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|