The ansible.windows collection includes the core plugins supported by Ansible to help the management of Windows hosts.
-
Join the Ansible forum:
- Get Help: get help or help others.
- Posts tagged with 'windows': subscribe to participate in collection-related conversations.
- Social Spaces: gather and interact with fellow enthusiasts.
- News & Announcements: track project-wide announcements including social events.
-
The Ansible Bullhorn newsletter: used to announce releases and important changes.
For more information about communication, see the Ansible communication guide.
This collection has been tested against following Ansible versions: >=2.15.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.
Browsing the latest collection documentation will show docs for the latest version released in the Ansible package not the latest version of the collection released on Galaxy.
Browsing the devel collection documentation shows docs for the latest version released on Galaxy.
We also separately publish latest commit collection documentation which shows docs for the latest commit in the main branch.
If you use the Ansible package and don't update collections independently, use latest, if you install or update this collection directly from Galaxy, use devel. If you are looking to contribute, use latest commit.
Before using the Windows collection, you need to install it with the ansible-galaxy CLI:
ansible-galaxy collection install ansible.windows
You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:
collections:
- name: ansible.windowsWe welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Ansible Windows collection repository. See Contributing to Ansible-maintained collections for details.
See Developing modules for Windows for specifics on Windows modules.
See the Ansible Community Guide for details on contributing to Ansible.
This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.
The tests directory contains configuration for running sanity and integration tests using ansible-test.
You can run the collection's test suites with the commands:
ansible-test sanity --docker
ansible-test windows-integration --docker
The current process for publishing new versions of the Windows Core Collection is manual, and requires a user who has access to the ansible namespace on Ansible Galaxy and Automation Hub to publish the build artifact.
- Update
galaxy.ymlwith the new version for the collection. - Update the
CHANGELOG:- Make sure you have
antsibull-changeloginstalledpip install antsibull-changelog. - Make sure there are fragments for all known changes in
changelogs/fragments. - Add a new
release_summaryfragment:echo "release_summary: Release summary for v..." > changelogs/fragments/release-summary.yml - Run
antsibull-changelog release.
- Make sure you have
- Commit the changes and wait for CI to be green
- Create a release with the tag that matches the version number
- The tag is the version number itself, and should not start with anything
- This will trigger a build and publish the collection to AH and Galaxy
- The Zuul job progress will be listed here
After the version is published, verify it exists on the Windows Core Collection Galaxy page.
As a Red Hat Ansible Certified Content, this collection is entitled to support through Ansible Automation Platform (AAP).
If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there is community support available at no charge.
GNU General Public License v3.0 or later
See COPYING to see the full text.