Skip to main content

Essentials Ansible Modules

Ansible is a reliable configuration management tool. It is shipped with a lot of modules including those provided by the communities. Some modules are essential and come in very handy in everyday tasks.

Ansible is pushed-based and works by generating a Python script that will be run on the target server. It means the target server is required to have Python which is also commonly shipped in any Linux distros.


The module is used to manage packages in the target host. It is like running apt, yum, or aptitude. The following snippet is an example of its usage to install the Nginx package using the package manager.

  - name: Install Nginx
      name: nginx
      state: present
      update_cache: True


It is used to manage files, symlinks, links, or folders on the target host. These are the two examples.

  - name: Create a directory
      path: "/home/luki/mydir"
      state: directory
      mode: 0750
  - name: Copy a file
      src: "/home/luki/my.conf"
      dest: "/etc/my.conf"
      state: link


It is used to move files from Ansible (local) host to the target host. For example, we want to copy two files in a local directory to another directory in the remote host.

  - name: Copy files
      src: "files/{{ item }}"
      dest: "/home/luki/files"
      mode: 0644
      - "file1.txt"
      - "file2.txt"


It works very similarly to copy but it will generate the content of the file based on the specified template. The template is based on Jinja. It can be advantageous when we want to create configuration files whose contents depend on local or remote variables.

  - name: Copy homepage
      src: templates/index.html.j2
      dest: "{{ web_root }}/index.html"

The following snippet is an example of the index.html.j2 file. It passes two variables that are natively maintained by Ansible. The output file will have those variables replaced with the actual values.

  <h1>Server is configured by Ansible</h1>
    <li>Host IP: {{ ansible_host }}</li>
    <li>Host User: {{ ansible_user }}</li>


Having services or daemon programs that always run on a server is common. This module will be an abstraction for maintaining the services whatever service manager we use, systemd or systemctl.

  - name: Restart nginx
      name: nginx
      state: restarted


Rather than using curl tool available on Linux, it is recommended to use this module. The module can monitor the existence of the downloaded file and decide whether a download should be run based on some properties.

  - name: Download My File
      dest: ~/file.txt
      force: True


If there are actions that Ansible is not covered yet or we need to execute certain functions on the remote host, the shell module comes in handy. The module allows us to execute Linux shell commands. The following example shows a call to the curl CLI tool through a shell. The args section is an alternative way to pass shell module's supported arguments while we use a string as shell's value.

  - name: Install NVM
    shell: >
      curl -o- | bash
      creates: "{{ ansible_env.HOME }}/.nvm/"


This module is very similar to the package module. The difference is that it uses APT explicitly while the package module prefers to use aptitude. The supported arguments are also very similar.

  - name: Install Docker required packages
      force_apt_get: True
      force: True # allow_unauthenticated && allow_downgrade
        - ca-certificates
        - curl
        - gnupg
        - lsb-release
      state: latest
      update_cache: True


If we need to add items to the APT source list, we can utilize this module. It is safer than using a shell script to append items to the list because as we know Ansible call is idempotent so we don't need to validate if there is any duplication.

  - name: Add Docker's repository
      filename: docker 
      repo: "deb [arch={{ [ansible_architecture] | map('extract', deb_architectures) | first }} signed-by=/etc/apt/keyrings/docker.gpg] {{ ansible_distribution_release }} stable"
      state: present


It can be used to display any messages from previous tasks or other system processes. The following example shows an example of using it for displaying some host variables.

  - name: Debug environment variables
      msg: "{{ ansible_env }}"
  - name: Debug host information
      msg: "{{ item }}"
      - "{{ ansible_distribution }}"
      - "{{ ansible_distribution_version }}"
      - "{{ ansible_distribution_release }}" # same as command: lsb_release -cs
      - "{{ ansible_architecture }}"


Popular posts from this blog

Configuring Swap Memory on Ubuntu Using Ansible

If we maintain a Linux machine with a low memory capacity while we are required to run an application with high memory consumption, enabling swap memory is an option. Ansible can be utilized as a helper tool to automate the creation of swap memory. A swap file can be allocated in the available storage of the machine. The swap file then can be assigned as a swap memory. Firstly, we should prepare the inventory file. The following snippet is an example, you must provide your own configuration. [server] [server:vars] ansible_user=root ansible_ssh_private_key_file=~/.ssh/id_rsa Secondly, we need to prepare the task file that contains not only the tasks but also some variables and connection information. For instance, we set /swapfile  as the name of our swap file. We also set the swap memory size to 2GB and the swappiness level to 60. - hosts: server become: true vars: swap_vars: size: 2G swappiness: 60 For simplicity, we only check the exi

Rangkaian Sensor Infrared dengan Photo Dioda

Keunggulan photodioda dibandingkan LDR adalah photodioda lebih tidak rentan terhadap noise karena hanya menerima sinar infrared, sedangkan LDR menerima seluruh cahaya yang ada termasuk infrared. Rangkaian yang akan kita gunakan adalah seperti gambar di bawah ini. Pada saat intensitas Infrared yang diterima Photodiode besar maka tahanan Photodiode menjadi kecil, sedangkan jika intensitas Infrared yang diterima Photodiode kecil maka tahanan yang dimiliki photodiode besar. Jika  tahanan photodiode kecil  maka tegangan  V- akan kecil . Misal tahanan photodiode mengecil menjadi 10kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 10 / (10+10) x Vcc V- = (1/2) x 5 Volt V- = 2.5 Volt Sedangkan jika  tahanan photodiode besar  maka tegangan  V- akan besar  (mendekati nilai Vcc). Misal tahanan photodiode menjadi 150kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 150 / (150+10) x Vcc V- = (150/160) x 5

Installing VSCode Server Manually on Ubuntu

I've ever gotten stuck on updating the VSCode server on my remote server because of an unstable connection between my remote server and that host the updated server source codes. The download and update process failed over and over so I couldn't remotely access my remote files through VSCode. The solution is by downloading the server source codes through a host with a stable connection which in my case I downloaded from a cloud VPS server. Then I transfer the downloaded source codes as a compressed file to my remote server through SCP. Once the file had been on my remote sever, I extracted them and align the configuration. The more detailed steps are as follows. First, we should get the commit ID of our current VSCode application by clicking on the About option on the Help menu. The commit ID is a hexadecimal number like  92da9481c0904c6adfe372c12da3b7748d74bdcb . Then we can download the compressed server source codes as a single file from the host.

Resize VirtualBox LVM Storage

VirtualBox is a free solution to host virtual machines on your computer. It provides configuration options for many components on our machine such as memory, storage, networking, etc. It also allows us to resize our machine storage after its operating system is installed. LVM is a volume manager in a Linux platform that helps us to allocate partitions in the system and configure the storage size that will be utilized for a specific volume group. There are some points to be noticed when we work with LVM on VirtualBox to resize our storage. These are some steps that need to be performed. 1. Stop your machine before resizing the storage. 2. Set new storage size using GUI by selecting " File > Virtual Media Manager > Properties " then find the desired virtual hard disk name that will be resized. OR , by running a CLI program located in " Program Files\Oracle\VirtualBox\VBoxManage.exe ".  cd "/c/Program Files/Oracle/VirtualBox" ./VBoxManage.exe list

Managing MongoDB Records Using NestJS and Mongoose

NestJS is a framework for developing Node.js-based applications. It provides an additional abstraction layer on top of Express or other HTTP handlers and gives developers a stable foundation to build applications with structured procedures. Meanwhile, Mongoose is a schema modeling helper based on Node.js for MongoDB. There are several main steps to be performed for allowing our program to handle MongoDB records. First, we need to add the dependencies which are @nestjs/mongoose , mongoose , and @types/mongoose . Then, we need to define the connection configuration on the application module decorator. import { MongooseModule } from '@nestjs/mongoose'; @Module({ imports: [ MongooseModule.forRoot('mongodb://localhost:27017/mydb'), ], controllers: [AppController], providers: [AppService], }) Next, we create the schema definition using helpers provided by NestJS and Mongoose. The following snippet is an example with a declaration of index setting and an o

Generate API Documentation Using Swagger Module in NestJS

Swagger provides us a standard to generate API documentation based on the Open API specification. If we use NestJS for building our API providers, we can utilize a tool provided by NestJS in the  @nestjs/swagger  module to generate the documentation automatically in the built time. This module also requires the swagger-ui-express module if we use Express as the NestJS base HTTP handler. Set Swagger configuration First, we need to define Swagger options and instantiate the documentation provider on the main.ts file. import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; // sample application instance const app = await NestFactory.create(AppModule); // setup Swagger options const options = new DocumentBuilder() .setTitle('Coffee') .setVersion('1.0') .setDescription('Learn NestJS with coffee') .build(); // build the document const document = SwaggerModule.createDocument(app, options); // provide an endpoint