django-ansible 0.1

Django app which provide an APIs to integrate Ansible with Django projects

dj_ansible is a Django app which provide an APIs to integrate Ansible with Django projects

Quick start

1. Add “dj_ansible” to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...
       'dj_ansible',
   ]

2. Run python manage.py migrate to create the needed models.

3. add your inventory data to two tables

   • ansible_network_groups (model: AnsibleNetworkGroups)

   • ansible_inventory_hosts (model: AnsibleHosts)

Example

1. create play-book dictionary:

   my_play = dict(
             name="Ansible Play",
             hosts='cisco_firewalls',
             become='yes',
             become_method='enable',
             gather_facts='no',
             tasks=[
                 dict(action=dict(module='asa_command', commands=['show version','show ip'])),
                 dict(action=dict(module='asa_config', lines=['network-object host 10.1.0.1'])
             ]
         )

2. run my_play using the executor:

   result = execute(my_play)
   
   # print the stats
   print(json.dumps(result.stats, indent=4))
   # print execution results
   print(json.dumps(result.results, indent=4))

stats json looks like this:

{
"all_ok": false,
"total_hosts": 3,
"has_changed": false,
"duration": 12.400323867797852,
"hosts_stats": {
    "ok_hosts": {
        "count": 2,
        "hosts": [
            "fw2",
            "fw1"
        ]
    },
    "failed_hosts": {
        "count": 1,
        "hosts": [
            "ios_switch1"
        ]
    },
    "processed_hosts": {
        "count": 3,
        "hosts": [
            "fw2",
            "fw1",
            "ios_switch1"
        ]
    },
    "changed_hosts": {
        "count": 0,
        "hosts": []
    }
},
"hosts": [
    {
        "host": "fw2",
        "status": "ok",
        "changed": false
    },
    {
        "host": "fw1",
        "status": "ok",
        "changed": false
    },
    {
        "host": "ios_switch1",
        "status": "failed",
        "changed": false
    }
]}

resulst json looks like this:

{
"failed": [
    {
        "host": "ios_switch1",
        "tasks": [
            {
                "name": "asa_command",
                "result": {
                    "msg": "timed out",
                    "_ansible_no_log": false
                }
            }
        ]
    }
],
"success": [
    {
        "host": "fw2",
        "tasks": [
            {
                "name": "asa_command",
                "result": {
                    "invocation": {
                        "module_args": {
                            "username": null,
                            "authorize": null,
                            "password": null,
                            "passwords": null,
                            "context": null,
                            "retries": 10,
                            "auth_pass": null,
                            "interval": 1,
                            "commands": [
                                "show version"
                            ],
                            "host": null,
                            "ssh_keyfile": null,
                            "timeout": null,
                            "provider": null,
                            "wait_for": null,
                            "port": null,
                            "match": "all"
                        }
                    },
                    "stdout_lines": [
                        [
                            "Cisco Adaptive Security Appliance Software Version 9.5(3)6 ",
                            "Device Manager Version 7.1(3)",
                            ....
                            "Configuration last modified by enable_15 at 12:55:31.479 EDT Sun Apr 7 2019"
                        ]
                    ],
                    "changed": false,
                    "stdout": [
                        "Cisco Adaptive Security Appliance Software Version 9.5(3)6 \nDevice Manager Version 7.1(3)\n\n... ],
                    "_ansible_parsed": true,
                    "_ansible_no_log": false
                }
            }
        ]
    },
    {
        "host": "fw1",
        "tasks": [
            {
                "name": "asa_command",
                "result": {
                    "invocation": {
                        "module_args": {
                            "username": null,
                            "authorize": null,
                            "password": null,
                            "passwords": null,
                            "context": null,
                            "retries": 10,
                            "auth_pass": null,
                            "interval": 1,
                            "commands": [
                                "show version"
                            ],
                            "host": null,
                            "ssh_keyfile": null,
                            "timeout": null,
                            "provider": null,
                            "wait_for": null,
                            "port": null,
                            "match": "all"
                        }
                    },
                    "stdout_lines": [
                        [
                            "Cisco Adaptive Security Appliance Software Version 9.1(7)16 ",
                            "",
                            "Compiled on Thu 30-Mar-17 17:39 by builders",
                            "System image file is \"disk0:/asa917-16-k8.bin\"",
                            "Config file at boot was \"startup-config\"",
                            "",
                            ....
                            "Configuration register is 0x1",
                            "Configuration last modified by admin at 16:25:49.318 UTC Sat Apr 6 2019"
                        ]
                    ],
                    "changed": false,
                    "stdout": [
                        "Cisco Adaptive Security Appliance Software Version 9.1(7)16 \n\n.... ],
                    "_ansible_parsed": true,
                    "_ansible_no_log": false
                }
            }
        ]
    }
]}