Check if a directory exists on Windows-like systems - Ansible module win_stat
How to automate the checking of the "example" directory/folder in the Desktop of the user on the Windows system and display a message or execute a task accordingly with Ansible Playbook.


How to check if a directory/folder exists on Windows-like systems with Ansible?
I’m going to show you a live demo and some simple Ansible code. I’m Luca Berton and welcome to today’s episode of Ansible Pilot
Ansible check directory exists on Windows-like systems
ansible.windows.win_stat
- Get information about Windows files
Let’s talk about the Ansible module win_stat
.
The full name is ansible.windows.win_stat
, which means that is part of the collection of modules specialized to interact with Windows target host.
It’s a module pretty stable and out for years.
It works in Windows and Windows Server operating systems.
It gets information about Windows files.
For Linux target use the ansible.builtin.stat
module instead.
Parameters & Return Values
Mandatory Parameters
- path string
Main Return Values
- stat complex - isdir
The only mandatory parameter is “path” which is the filesystem full path of the object to check. The module returns a complex object, the property that is interesting for us is “isdir”. This attribute is “true” if the object is a directory
Links
The Best Resources For Ansible
Certifications
Video Course
Printed Book
eBooks
Ansible by Examples: 200+ Automation Examples For Linux and Windows System Administrator and DevOps
Ansible Cookbook: A Comprehensive Guide to Unleashing the Power of Ansible via Best Practices, Troubleshooting, and Linting Rules with Luca Berton
Ansible For Windows By Examples: 50+ Automation Examples For Windows System Administrator And DevOps
Ansible For Linux by Examples: 100+ Automation Examples For Linux System Administrator and DevOps
Ansible Linux Filesystem By Examples: 40+ Automation Examples on Linux File and Directory Operation for Modern IT Infrastructure
Ansible For Security by Examples: 100+ Automation Examples to Automate Security and Verify Compliance for IT Modern Infrastructure
Ansible Tips and Tricks: 10+ Ansible Examples to Save Time and Automate More Tasks
Ansible Linux Users & Groups By Examples: 20+ Automation Examples on Linux Users and Groups Operation for Modern IT Infrastructure
Ansible For PostgreSQL by Examples: 10+ Examples To Automate Your PostgreSQL database
Ansible For Amazon Web Services AWS By Examples: 10+ Examples To Automate Your AWS Modern Infrastructure
Ansible Automation Platform By Example: A step-by-step guide for the most common user scenarios
demo
How to check if the “example” directory/folder exists on the Desktop of the user on Windows-like systems with Ansible Playbook.
code
---
- name: check if is a directory
hosts: all
vars:
directory: 'C:\Users\vagrant\Desktop\example'
tasks:
- name: Check the directory
ansible.windows.win_stat:
path: "{{ directory }}"
register: dir_data
- name: Directory found
ansible.builtin.debug:
msg: "Directory {{ directory }} present"
when: dir_data.stat.isdir is defined and dir_data.stat.isdir
directory doesn’t exist execution
ansible-pilot $ ansible-playbook -i virtualmachines/win/inventory check\ directory\ exists/directory_exists_windows.yml
PLAY [check if is a directory] ********************************************************************
TASK [Gathering Facts] ****************************************************************************
ok: [WindowsServer]
TASK [Check the directory] ************************************************************************
ok: [WindowsServer]
TASK [Directory found] ****************************************************************************
skipping: [WindowsServer]
PLAY RECAP ****************************************************************************************
WindowsServer : ok=2 changed=0 unreachable=0 failed=0 skipped=1 rescued=0 ignored=0
ansible-pilot $
directory exist execution
ansible-pilot $ ansible-playbook -i virtualmachines/win/inventory check\ directory\ exists/directory_exists_windows.yml
PLAY [check if is a directory] ********************************************************************
TASK [Gathering Facts] ****************************************************************************
ok: [WindowsServer]
TASK [Check the directory] ************************************************************************
ok: [WindowsServer]
TASK [Directory found] ****************************************************************************
ok: [WindowsServer] => {
"msg": "Directory C:\\Users\\vagrant\\Desktop\\example present"
}
PLAY RECAP ****************************************************************************************
WindowsServer : ok=3 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
ansible-pilot $
Recap
Now you know how to check if a directory exists on Windows-like systems with Ansible. Subscribe to the YouTube channel, Medium, Website, Twitter, and Substack to not miss the next episode of the Ansible Pilot.
Academy
Learn the Ansible automation technology with some real-life examples in my
My book Ansible By Examples: 200+ Automation Examples For Linux and Windows System Administrator and DevOps
Donate
Want to keep this project going? Please donate