Automatiser le déploiement d'appliances virtuelles avec VMware et Ansible

L'exemple suivant montre comment configurer un playbook et une bibliothèque de tâches pour déployer le fichier OVA pour une VM de capteur. Le fichier OVA doit être téléchargé sur la machine où Ansible est exécuté.

1. Créez des entrées pour les appliances virtuelles dans votre fichier d'inventaire Ansible, comme dans l'exemple suivant :

   vms:
     hosts:
       exampleTestEDA:
         app_type: EDA
         datacenter: "Example Datacenter"
         folder: "VM Folder"
         esxi: esxi1.example.com
         datastore: DATA
         ova: ../firmware_images/extrahop-eda-1100v-vmware-7.9.0.2924.ova
         add_disk: 250
     vars:
       vcenter: vcenter.example.com
       user: extrahop@vsphere.local
       password: !vault |
             $ANSIBLE_VAULT;1.1;AES256
             32313761623336326566303039613131373465663363326130336435326432666335333739643539
             6266386436363563653363306137653839633334666466630a643032303035376137363839656330
             63396465323039666531353437663934343735663638303166316534316134633739626231386662
             3234363063636563650a326336343334393638336433303063623636376231643934323961393338
             6133
   

   Copier

   Les entrées d'inventaire ci-dessus définissent les variables de configuration suivantes :

   exempleEDA

   Le nom de la VM.

   app_type

   Le type d'appliance virtuelle.

   datacenter

   Le centre de données qui contient l'hôte ESX/ESXi.

   folder

   Le dossier des VM dans le centre de données.

   esxi

   Le nom de l'hôte ESX/ESXi sur lequel les VM sont déployées.

   datastore

   Le nom du datastore qui contiendra la VM.

   ova

   Le chemin relatif du fichier OVA ExtraHop.

   vcenter

   Le nom d'hôte du serveur vCenter.

   user

   Le nom d'un compte utilisateur sur le serveur vCenter.

   password (mot de passe)

   Le mot de passe du compte utilisateur.

2. Créez une entrée de tâche dans un playbook .yml, similaire à l'exemple suivant :

       - name: Deploy ExtraHop OVA to vSphere
         eh_vsphere_deploy:
           appliance: "{{ inventory_hostname }}"
           app_type: "{{ app_type }}"
           datacenter: "{{ datacenter }}"
           folder: "{{ folder }}"
           esxi: "{{ esxi }}"
           datastore: "{{ datastore }}"
           ova: "{{ ova }}"
           vcenter: "{{ vcenter }}"
           user: "{{ user }}"
           password: "{{ password }}"

   Copier
3. Ajoutez un script Python à votre répertoire de bibliothèque et ouvrez le fichier dans un éditeur de texte.
   Dans cet exemple, le script s'appelle /library/eh_vsphere_deploy.py.
4. Importez tous les modules Python dont le script a besoin.
   Le code suivant importe les modules requis pour le reste de la procédure :

   from ansible.module_utils.basic import AnsibleModule
   import subprocess
   import urllib

   Copier
5. Créez un objet AnsibleModule et importez les variables du fichier .yml :

   module = AnsibleModule(
       argument_spec = dict(
           appliance = dict(required=True),
           app_type = dict(required=True),
           datacenter = dict(required=True),
           folder = dict(required=True),
           esxi = dict(required=True),
           ova = dict(required=True),
           datastore = dict(required=True),
           vcenter = dict(required=True),
           user = dict(required=True),
           password = dict(required=True, no_log=True)
       ),
       supports_check_mode=False
   )
   
   appliance = module.params['appliance']
   app_type = module.params['app_type']
   datastore = module.params['datastore']
   ova = module.params['ova']
   attrs = {
       'vcenter': module.params['vcenter'],
       'user': module.params['user'],
       'password': module.params['password'],
       'datacenter': module.params['datacenter'],
       'folder': module.params['folder'],
       'esxi': module.params['esxi']
   }

   Copier
6. Créez la chaîne d'hôte qui spécifie l'emplacement de l'hôte ESX/ESXi dans vCenter :

               attrs = dict((k, urllib.quote(v)) for k, v in attrs.items())
   host_str = 'vi://{user}:{password}@{vcenter}/{datacenter}/host/{folder}/{esxi}'.format(**attrs)
   

   Copier

   Pour plus d'informations sur la création d'une chaîne d'hôte, voir la documentation de l'outil OVF sur le site de VMware :https://vdc-download.vmware.com/vmwb-repository/dcr-public/bb505ca7-88b5-4b11-aff4-f59125ab27bc/f3d05149-23e9-4ac2-8f99-0c851a8a5231/ovftool-430-userguide.pdf

7. Créez un tableau pour définir la commande ovtool:

   cmd = ['ovftool',
           '--disableVerification',
           '--noSSLVerify',
           '-ds=%s' % datastore,
           '-dm=%s' % 'thick',
           '-n=%s' % eda,
           '--net:VM Network=VM Network',
           '--X:logFile=ovflogs.log',
           '--X:logLevel=verbose',
           ova,
           host_str]
   
   if app_type == 'EDA' or app_type == 'ETA':
       cmd.insert(7, '--net:Remote Port Mirror=Remote Port Mirror')

   Copier

   Remarque :

   Ce code définit deux mappages de réseau pour les capteurs et les magasins de paquets. VM Network correspond au réseau de gestion de la VM sur l'hôte ESX/ESXi. Remote Port Mirror correspond au réseau qui reflète les données de fil. Les noms des réseaux cibles doivent correspondre aux réseaux de votre hôte ESX/ESXi. Par exemple, si vous avez configuré un réseau nommé Local Port Mirror pour refléter le trafic intra-VM, indiquez : --net:Remote Port Mirror=Local Port Mirror Pour les appliances EDA 6100v, vous pouvez ajouter des mappages de réseau supplémentaires au tableau ci-dessus pour Remote Port Mirror 2 et Remote Port Mirror 3, par exemple : Copier --net:Remote Port Mirror2=Remote Port Mirror2 Copier

8. Exécutez la commande ovftool avec la classe subprocess.Popen:

   proc = subprocess.Popen(cmd)
   proc.communicate()
   if proc.returncode != 0:
       module.fail_json(msg='Unable to deploy OVA')
   else:
       module.exit_json(changed=True, msg="Deployed OVA")

   Copier

Pour les capteurs sous licence pour la capture de paquets et tous les EXA, vous devez configurer un disque supplémentaire pour l'appliance virtuelle.

1. Créez des entrées pour les appliances virtuelles dans votre fichier d'inventaire Ansible, comme dans l'exemple suivant :

   vms:
     hosts:
      exampleEXA:
         add_disk: 150
         app_type: EXA
         datacenter: "Example Datacenter"
         folder: "VM Folder"
         esxi: esxi1.example.com
         ova: ../firmware_images/extrahop-exa-5100v-xs-vmware-7.9.0.2924.ova
     vars:
       vcenter: vcenter.example.com
       user: extrahop@vsphere.local
       password: !vault |
             $ANSIBLE_VAULT;1.1;AES256
             32313761623336326566303039613131373465663363326130336435326432666335333739643539
             6266386436363563653363306137653839633334666466630a643032303035376137363839656330
             63396465323039666531353437663934343735663638303166316534316134633739626231386662
             3234363063636563650a326336343334393638336433303063623636376231643934323961393338
             6133

   Copier

   Les entrées d'inventaire ci-dessus définissent les variables de configuration suivantes :

   exempleEXA

   Le nom de la VM.

   add_disk

   La taille en Go du disque à ajouter. Les valeurs suivantes sont valables :

   Appareil virtuel	Taille
   EDA 1100v	250
   EDA 6100v	500
   EXA-XS	250 ou moins
   EXA-S	500 ou moins
   EXA-M	1000 ou moins
   EXA-L	2000 ou moins

   app_type

   Le type d'appliance virtuelle.

   centre de données

   Le centre de données qui contient l'hôte ESX/ESXi.

   folder

   Le dossier des VM dans le centre de données.

   esxi

   Le nom de l'hôte ESX/ESXi sur lequel la VM est déployée.

   datastore

   Le nom du datastore qui contiendra la VM.

   ova

   Le chemin relatif du fichier OVA ExtraHop.

   vcenter

   Le nom d'hôte du serveur vCenter.

   user

   Le nom d'un compte utilisateur sur le serveur vCenter.

   password (mot de passe)

   Le mot de passe du compte utilisateur.

2. Créez une entrée de tâche dans un playbook .yml similaire à l'exemple suivant :

       - name: Add a disk
         when: add_disk is defined
         eh_vsphere_add_disk:
           vm_name: "{{ inventory_hostname }}"
           add_disk: "{{ add_disk }}"
           vcenter: "{{ vcenter }}"
           user: "{{ user }}"
           password: "{{ password }}"

   Copier
3. Ajoutez un script Python à votre répertoire de bibliothèque et ouvrez le fichier dans un éditeur de texte.
   Dans cet exemple, le script s'appelle /library/eh_vsphere_add_disk.py.
4. Importez tous les modules Python dont le script a besoin.
   Le code suivant importe les modules requis pour le reste de la procédure :

   from ansible.module_utils.basic import AnsibleModule
   from pyVim import connect
   from pyVmomi import vim
   import ssl

   Copier
5. Créez un objet AnsibleModule et importez les variables du fichier .yml :

   module = AnsibleModule(
       argument_spec = dict(
           vm_name = dict(required=True),
           add_disk = dict(required=True),
           vcenter = dict(required=True),
           user = dict(required=True),
           password = dict(required=True, no_log=True)
       ),
       supports_check_mode=False
   )
   
   vm_name = module.params['vm_name']
   add_disk = module.params['add_disk']
   vcenter = module.params['vcenter']
   user = module.params['user']
   password = module.params['password']

   Copier
6. Traduisez la taille du disque PCAP de GB en KB :

               add_disk = int(add_disk) * 1024 * 1024
             

   Copier
7. Établir une connexion au serveur vCenter :

   context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
   try:
       si = connect.SmartConnect(host=vcenter,
                                   user=user,
                                   pwd=password,
                                   sslContext=context)
   except:
       module.fail_json(msg='Could not connect to vcenter.')

   Copier
8. Récupérer un objet qui représente la VM à laquelle vous ajoutez le disque.

   content = si.RetrieveContent()
   object_view = content.viewManager.CreateContainerView(content.rootFolder,
                                                           [], True)
   for obj in object_view.view:
       if isinstance(obj, vim.VirtualMachine):
           if obj.name.lower() == vm_name.lower():
               object_view.Destroy()
               return obj
   object_view.Destroy()

   Copier
9. Le numéro d'unité du disque doit être le numéro d'unité du dernier disque virtuel sur le périphérique plus un. Récupérez également l'objet qui représente le contrôleur iSCSI de la VM :

   for dev in vm.config.hardware.device:
       if isinstance(dev, vim.vm.device.VirtualDisk):
           unit_number = int(dev.unitNumber) + 1
           if unit_number == 7:
               unit_number += 1
           if unit_number >= 16:
               module.fail_json(msg="Number of disks not supported")
       if isinstance(dev, vim.vm.device.VirtualSCSIController):
           controller = dev

   Copier
10. Configurez les spécifications du disque :

    dev_changes = []
    diskSpec = vim.vm.device.VirtualDeviceSpec()
    diskSpec.fileOperation = "create"
    diskSpec.operation = vim.vm.device.VirtualDeviceSpec.Operation.add
    diskSpec.device = vim.vm.device.VirtualDisk()
    diskSpec.device.backing = vim.vm.device.VirtualDisk.FlatVer2BackingInfo()
    diskSpec.device.backing.thinProvisioned = False
    diskSpec.device.backing.diskMode = 'persistent'
    diskSpec.device.unitNumber = unit_number
    diskSpec.device.capacityInKB = add_disk
    diskSpec.device.controllerKey = controller.key
    dev_changes.append(diskSpec)
    vm_spec = vim.vm.ConfigSpec()
    vm_spec.deviceChange = dev_changes

    Copier
11. Ajouter le disque :

    vm.ReconfigVM_Task(spec=vm_spec)

    Copier

L'exemple suivant montre comment augmenter la capacité du disque packetstore sur une appliance ETA 1150v.

1. Créez des entrées pour les appliances virtuelles dans votre fichier d'inventaire Ansible, comme dans l'exemple suivant :

   vms : hosts : exampleETA : app_type : ETA datacenter : "Example Datacenter" folder : "VM Folder" esxi : esxi1.example.com datastore : DATA ova : ../firmware_images/extrahop-eta-1150v-vmware-7.9.0.2924.ova increase_disk : 2000 vars : vcenter : vcenter.example.com user : extrahop@vsphere.local password : !vault | $ANSIBLE_VAULT;1.1 ;AES256323137616233363265663030396131373465663363326130336435326432666335333739643539 6266386436356365336330613765383963333466630a6430323035376137363839656330
             63396465323039666531353437663934343735663638303166316534316134633739626231386662 3234363063636563650a326336343334393638336433303063623636376231643934323961393338 6133

   Copier
2. Créez une entrée de tâche dans un fichier playbook .yml similaire à l'exemple suivant :

      - name : Increase an ETA packetstore when : increase_disk is defined eh_vsphere_increase_disk : vm_name : "{{ inventory_hostname }}" increase_disk : "{{ increase_disk }}" datacenter : "{{ datacenter }}" vcenter : "{{ vcenter }}" user : "{{ user }}" password : "{{ password }}"

   Copier
3. Ajoutez un script Python au répertoire de votre bibliothèque et ouvrez le fichier dans un éditeur de texte.
   Dans cet exemple, le script s'appelle library/eh_vsphere_increase_disk.py.
4. Importez tous les modules Python dont le script a besoin.
   Le code suivant importe les modules requis pour le reste de la procédure

   :from ansible.module_utils.basic import AnsibleModule from pyVim import connect from pyVmomi import vim import ssl

   Copier
5. Créer un objet AnsibleModule et importer les variables du fichier .yml :

   module = AnsibleModule( argument_spec = dict( vm_name = dict(required=True), increase_disk = dict(required=True), datacenter = dict(required=True), vcenter = dict(required=True), user = dict(required=True), password = dict(required=True, no_log=True) ), supports_check_mode=False ) vm_name = module.params['vm_name'] increase_disk = module.params['increase_disk'] datacenter = module.params['datacenter'] vcenter = module.params['vcenter'] user = module.params['user'] password = module.params['password']

   Copier
6. Traduisez la taille du disque de GB en KB :

   increase_disk = int(increase_disk) * 1024 * 1024

   Copier
7. Établir une connexion avec le serveur vCenter :

   context = ssl.SSLContext(ssl.PROTOCOL_SSLv23) try : si = connect.SmartConnect(host=vcenter, user=user, pwd=password, sslContext=context) except : module.fail_json(msg='Could not connect to vcenter.')

   Copier
8. Récupérer un objet qui représente la VM de l'ETA :

   content = si.RetrieveContent() object_view = content.viewManager.CreateContainerView(content.rootFolder, [], True) for obj in object_view.view : if isinstance(obj, vim.VirtualMachine) : if obj.name.lower() == vm_name.lower() : object_view.Destroy() vm = obj object_view.Destroy()

   Copier
9. Récupérer le chemin du fichier qui sauvegarde le disque que vous voulez redimensionner :

   for dev in vm.config.hardware.device : if isinstance(dev, vim.vm.device.VirtualDisk) and dev.deviceInfo.label == 'Hard disk 2' : disk = dev path = disk.backing.fileName

   Copier
10. Récupérer un objet qui représente le centre de données sur lequel se trouve la VM :

    datacenter_list = si.content.rootFolder.childEntity for d in datacenter_list : if d.name == dcName : datacenter_obj = d

    Copier
11. Augmenter la taille du disque :

    virtualDiskManager = si.content.virtualDiskManager virtualDiskManager.ExtendVirtualDisk(path, datacenter_obj, increase_disk, False)

    Copier