inventory plugins: my_csv_plugin¶

Hostname,IP,Location,Type,OS
i_nginx01,10.1.1.1,IDC,Gateway,Ubuntu
i_web01,10.1.1.2,IDC,Service,Centos
i_web02,10.1.1.3,IDC,Service,Centos
a_nginx01,10.2.1.1,Aliyun,Gateway,Ubuntu
a_web01,10.2.1.2,Aliyun,Service,Centos
a_web02,10.2.1.3,Aliyun,Service,Centos

# Update the verify_file method

    def verify_file(self, path):
        '''Return true/false if this is a 
        valid file for this plugin to consume
        '''
        valid = False
        if super(InventoryModule, self).verify_file(path):
            #base class verifies that file exists 
            #and is readable by current user
            if path.endswith(('csv_inventory.yaml',
                              'csv_inventory.yml')):
                valid = True
        return valid

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

DOCUMENTATION = r'''
    name: my_csv_plugin
    plugin_type: inventory
    short_description: Returns Ansible inventory from CSV
    description: Returns Ansible inventory from CSV
    options:
      plugin:
          description: Name of the plugin
          required: true
          choices: ['my_csv_plugin']
      path_to_inventory:
        description: Directory location of the CSV inventory
        required: true
      csv_file:
        description: File name of the CSV inventory file
        required: true
'''



from ansible.plugins.inventory import BaseInventoryPlugin
from ansible.errors import AnsibleError, AnsibleParserError
import csv


class InventoryModule(BaseInventoryPlugin):
    NAME = 'my_csv_plugin'


    def verify_file(self, path):
        '''Return true/false if this is possibly a valid file for this plugin to
consume
        '''
        valid = False
        if super(InventoryModule, self).verify_file(path):
            # base class verifies that file exists and is readable by current
            # user
            if path.endswith(('csv_inventory.yaml',
                              'csv_inventory.yml')):
                valid = True
        return valid

    def _get_structured_inventory(self, inventory_file):

        #Initialize a dict
        inventory_data = {}
        #Read the CSV and add it to the dictionary
        try:
            with open(inventory_file, 'r') as fh:
                csvdict = csv.DictReader(fh)
                for rows in csvdict:
                    hostname = rows['Hostname']
                    inventory_data[hostname] = rows
        except Exception as e:
           raise AnsibleParserError(
              'Parsing file error: {}'.format(e))
        return inventory_data

    def _populate(self):
        '''Return the hosts and groups'''
        self.inventory_file = self.inv_dir + '/' + self.inv_file
        self.myinventory = self._get_structured_inventory(self.inventory_file)
        #Create the location, type and os groups
        locations = []
        types = []
        oss = []
        for data in self.myinventory.values():
            if not data['Location'] in locations:
                locations.append(data['Location'])
            if not data['Type'] in types:
                types.append(data['Type'])
            if not data['OS'] in oss:
                oss.append(data['OS'])
        for location in locations:
            self.inventory.add_group(location)
        for type in types:
            self.inventory.add_group(type)
        for os in oss:
            self.inventory.add_group(os)
        #Add the hosts to the groups
        for hostname,data in self.myinventory.items():
            self.inventory.add_host(host=hostname, group=data['Location'])
            self.inventory.add_host(host=hostname, group=data['Type'])
            self.inventory.add_host(host=hostname, group=data['OS'])
            self.inventory.set_variable(hostname, 'ansible_host', data['IP'])
            self.inventory.set_variable(hostname, 'ansible_os', data['OS'])


    def parse(self, inventory, loader, path, cache):
       '''Return dynamic inventory from source '''
       super(InventoryModule, self).parse(inventory, loader, path, cache)
       # Read the inventory YAML file
       self._read_config_data(path)
       try:
           # Store the options from the YAML file
           self.plugin = self.get_option('plugin')
           self.inv_dir = self.get_option('path_to_inventory')
           self.inv_file = self.get_option('csv_file')
       except Exception as e:
           raise AnsibleParserError(
               'All correct options required: {}'.format(e))
       # Call our internal helper to populate the dynamic inventory
       self._populate()

[defaults]
inventory_plugins  = /etc/ansible/plugins/inventory # 存储插件的目录

[inventory]
enable_plugins = host_list, script, yaml, ini, toml, my_csv_plugin  # 添加自定义的插件

# tree .
.
├── ansible.cfg
├── csv_inventory
│   └── myinventory.csv
├── hosts
├── plugins
│   └── inventory
│       └── my_csv_plugin.py
└── csv_inventory.yaml

# ansible-inventory -i csv_inventory.yaml --graph
@all:
  |--@Aliyun:
  |  |--a_nginx01
  |  |--a_web01
  |  |--a_web02
  |--@Centos:
  |  |--a_web01
  |  |--a_web02
  |  |--i_web01
  |  |--i_web02
  |--@Gateway:
  |  |--a_nginx01
  |  |--i_nginx01
  |--@IDC:
  |  |--i_nginx01
  |  |--i_web01
  |  |--i_web02
  |--@Service:
  |  |--a_web01
  |  |--a_web02
  |  |--i_web01
  |  |--i_web02
  |--@Ubuntu:
  |  |--a_nginx01
  |  |--i_nginx01
  |--@ungrouped:

# ansible-inventory -i csv_inventory.yaml --list
{
    "Aliyun": {
        "hosts": [
            "a_nginx01", 
            "a_web01", 
            "a_web02"
        ]
    }, 
    "Centos": {
        "hosts": [
            "a_web01", 
            "a_web02", 
            "i_web01", 
            "i_web02"
        ]
    }, 
    "Gateway": {
        "hosts": [
            "a_nginx01", 
            "i_nginx01"
        ]
    }, 
    "IDC": {
        "hosts": [
            "i_nginx01", 
            "i_web01", 
            "i_web02"
        ]
    }, 
    "Service": {
        "hosts": [
            "a_web01", 
            "a_web02", 
            "i_web01", 
            "i_web02"
        ]
    }, 
    "Ubuntu": {
        "hosts": [
            "a_nginx01", 
            "i_nginx01"
        ]
    }, 
    "_meta": {
        "hostvars": {
            "a_nginx01": {
                "ansible_host": "10.2.1.1", 
                "ansible_os": "Ubuntu"
            }, 
            "a_web01": {
                "ansible_host": "10.2.1.2", 
                "ansible_os": "Centos"
            }, 
            "a_web02": {
                "ansible_host": "10.2.1.3", 
                "ansible_os": "Centos"
            }, 
            "i_nginx01": {
                "ansible_host": "10.1.1.1", 
                "ansible_os": "Ubuntu"
            }, 
            "i_web01": {
                "ansible_host": "10.1.1.2", 
                "ansible_os": "Centos"
            }, 
            "i_web02": {
                "ansible_host": "10.1.1.3", 
                "ansible_os": "Centos"
            }
        }
    }, 
    "all": {
        "children": [
            "Aliyun", 
            "Centos", 
            "Gateway", 
            "IDC", 
            "Service", 
            "Ubuntu", 
            "ungrouped"
        ]
    }
}

# ansible -i csv_inventory.yaml all --list-hosts
  hosts (6):
    i_web01
    i_web02
    a_web01
    a_web02
    i_nginx01
    a_nginx01

# ansible -i csv_inventory.yaml all -m ping
i_web02 | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}
i_nginx01 | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}
i_web01 | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}
a_web02 | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}
a_web01 | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}
a_nginx01 | SUCCESS => {
    "changed": false, 
    "ping": "pong"
}

cat /etc/ansible/test.yml 
---

- hosts: all
  gather_facts: no
  tasks:
    - name: display var
      debug:
        msg: "The mgmt IP is {{ ansible_host }} and platorm is {{ ansible_os }}"


# ansible-playbook -i csv_inventory.yaml test.yml 

PLAY [all] *****************************************************************************************

TASK [display var] *****************************************************************************************
ok: [i_web01] => {
    "msg": "The mgmt IP is 10.1.1.2 and platorm is Centos"
}
ok: [i_web02] => {
    "msg": "The mgmt IP is 10.1.1.3 and platorm is Centos"
}
ok: [a_web01] => {
    "msg": "The mgmt IP is 10.2.1.2 and platorm is Centos"
}
ok: [a_web02] => {
    "msg": "The mgmt IP is 10.2.1.3 and platorm is Centos"
}
ok: [i_nginx01] => {
    "msg": "The mgmt IP is 10.1.1.1 and platorm is Ubuntu"
}
ok: [a_nginx01] => {
    "msg": "The mgmt IP is 10.2.1.1 and platorm is Ubuntu"
}

PLAY RECAP *****************************************************************************************
a_nginx01                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
a_web01                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
a_web02                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
i_nginx01                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
i_web01                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
i_web02                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0