How to start developing ansible module? ( The first step : create example module )

00_README.md

How to start developing ansible module? ( The first step : create example module )

Put example script

Put example.py to your local directory. ( e.g ./ansible_module/example.py )

Or you can git clone from this gist and get example.py.

git clone https://gist.github.com/YumaInaura/829b06cbf1c2ad5fa0a823ba24f8afbf/ ansible_module

In this case we use python script but actually modules can be written by any language.

Execute ansible command with specified module path

$ ansible localhost -m 'example' --module-path=./ansible_module

localhost | SUCCESS => {
    "changed": false,
    "some_key": "some value"
}

It works!

Versions

• ansible 2.6.1 ( installed by homebrew )

cf.

• Developing Modules — Ansible Documentation

Links

• In Japanese

example.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

from ansible.module_utils.basic import AnsibleModule

module = AnsibleModule(
    argument_spec=dict()
)

result = dict(
    some_key="some value",
)

module.exit_json(**result)