https://github.com/simeononsecurity/ansible_shodan
A collection of shodan modules for ansible
https://github.com/simeononsecurity/ansible_shodan
ansible ansible-collection ansible-galaxy ansible-modules ansible-playbook ansible-role ansible-roles shodan shodan-api shodan-cli shodan-python
Last synced: 4 months ago
JSON representation
A collection of shodan modules for ansible
- Host: GitHub
- URL: https://github.com/simeononsecurity/ansible_shodan
- Owner: simeononsecurity
- License: mit
- Created: 2023-08-17T01:50:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T23:02:23.000Z (over 1 year ago)
- Last Synced: 2025-03-24T18:11:25.247Z (7 months ago)
- Topics: ansible, ansible-collection, ansible-galaxy, ansible-modules, ansible-playbook, ansible-role, ansible-roles, shodan, shodan-api, shodan-cli, shodan-python
- Language: Python
- Homepage: https://simeononsecurity.com
- Size: 32.2 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ip-search-engines - Ansible Shodan
README
# Ansible Shodan Modules
[](https://github.com/sponsors/simeononsecurity)
This collection provides Ansible modules for interacting with the Shodan API. The modules allow you to perform various tasks related to Shodan, such as querying information, searching for hosts, and more.
## Modules
This collection includes the following modules:
- [`get_shodan_api_info`](https://github.com/simeononsecurity/ansible_shodan/blob/main/collections/ansible_collections/simeononsecurity/shodan/plugins/modules/get_shodan_api_info.py): Returns information about the API plan linked to the given API key.
- [`get_shodan_client_http_headers`](https://github.com/simeononsecurity/ansible_shodan/blob/main/collections/ansible_collections/simeononsecurity/shodan/plugins/modules/get_shodan_client_http_headers.py): Shows the HTTP headers that your client sends when connecting to a web server.
- [`get_shodan_client_ip`](https://github.com/simeononsecurity/ansible_shodan/blob/main/collections/ansible_collections/simeononsecurity/shodan/plugins/modules/get_shodan_client_ip.py): Get your current IP address as seen from the Internet.
- See more at the [modules directory..](https://github.com/simeononsecurity/ansible_shodan/tree/main/collections/ansible_collections/simeononsecurity/shodan/plugins/modules)
## Installation
You can install this collection using the following command:
```bash
ansible-galaxy collection install simeononsecurity.ansible_shodan
```
See the collection on the [Ansible Galaxy](https://galaxy.ansible.com/simeononsecurity/ansible_shodan) page.
## Usage
To use these modules, include them in your Ansible playbooks or roles and reference them using their respective names. Here's an example playbook using the `get_shodan_api_info` module:
```yml
---
- name: Get Shodan API Info
hosts: localhost
tasks:
- name: Get Shodan API Info
simeononsecurity.ansible_shodan.get_shodan_api_info:
api_key: your_shodan_api_key
register: shodan_api_info
- name: Display API Info
debug:
var: shodan_api_info
```
You can find [examples of all the `ansible shodan` modules used as playbooks](https://github.com/simeononsecurity/ansible_shodan/tree/main/collections/ansible_collections/simeononsecurity/shodan/playbooks).
## Contributing
Contributions to this collection are welcome! If you have improvements or new modules to add, please fork this repository, create a new branch, and submit a pull request.
## License
This project is licensed under the MIT License. See the [`LICENSE`](https://github.com/simeononsecurity/ansible_shodan/blob/main/LICENSE) file for details.
## Author
This Ansible Shodan Modules collection is authored by [SimeonOnSecurity](https://simeononsecurity.com/).
## Acknowledgments
Special thanks to the Shodan API for providing the capabilities to interact with their service using Ansible.
## Alternate Versions
### PowerShell
If you need a version in powershell, we have our [Shodan Powershell repo](https://github.com/simeononsecurity/Shodan_PS).
