Ansible Reference: Module Utilities<span id="ansible.module_utils"></span>

This page documents utilities intended to be helpful when writing Ansible modules in Python.

AnsibleModule

To use this functionality, include from ansible.module_utils.basic import AnsibleModule in your module.

ansible.module_utils.basic.AnsibleModule

Basic

To use this functionality, include import ansible.module_utils.basic in your module.

ansible.module_utils.basic

Argument Spec

Classes and functions for validating parameters against an argument spec.

ArgumentSpecValidator

ansible.module_utils.common.arg_spec.ArgumentSpecValidator

ValidationResult

ansible.module_utils.common.arg_spec.ValidationResult

Parameters

ansible.module_utils.common.parameters

dict of type names, such as 'str', and the default function used to check that type, ~ansible.module_utils.common.validation.check_type_str in this case.

Validation

Standalone functions for validating various parameter types.

ansible.module_utils.common.validation

Secrets

Functions for registering secrets so they are masked in Ansible output, and for masking strings manually. See developing_secret_masking for usage.

ansible.module_utils.secrets

Errors

ansible.module_utils.errors

这篇文档对你有帮助吗？

Indexes of all modules and plugins

Downloading collections

Collections index

Installing collections

Listing collections

Using collections in a playbook<span id="using_collections"></span>

Verifying collections

Using Ansible collections<span id="collections_index"></span>

Ansible CLI cheatsheet

Working with command line tools

Using Ansible command line tools

Introduction to ad hoc commands

Advanced Contributor Guide

Ansible Community Policy for AI-Assisted Contributions

Community Code of Conduct

Understanding integration tests

Creating new integration tests

Running integration tests

Adding integration tests to a collection

Adding to an existing integration test

Ansible Community Package Collections Removal Process

Releasing collections with release branches

Releasing collections without release branches

Releasing collections<span id="releasing_collections"></span>

Ansible community package collections requirements

Review checklist for collection PRs

How to test a collection PR

Add unit tests to a collection

Testing Collection Contributions

The Ansible Collections Development Cycle

Committers Guidelines

Communicating with the Ansible community

Contributing to Ansible-maintained Collections

ansible-core Contributors Guide

Ansible Collections Contributor Guide

Contributor path

Creating your first collection pull request

Developer Certificate Of Origin

The Ansible Development Cycle

Contributing to the Ansible Documentation

Ansible Ecosystem Project Development Resources

Getting started

GitHub Admins

How can I help?

Ansible Community Guide

Guidelines for collection maintainers

Maintainer responsibilities

Ansible Collection Maintenance and Workflow

Other Tools and Programs

Reporting bugs and requesting features

Requesting changes to a collection

Secure development practices

Ansible security policy

Steering Committee mission and responsibilities

Community topics workflow

Steering Committee membership guidelines

Steering Committee past members

Ansible Community Steering Committee

Ansible vulnerability management and incident response policy

Developer Guide

Ansible markup

`ansible-core` project branches and tags

Developer Guide

Debugging modules

Python API

Developing collections

Generating changelogs and porting guide entries in a collection

Contributing to collections

Creating collections

Distributing collections

Documenting collections

Migrating Ansible content to a different collection

Ansible collection creator path

Resource reporting

Using shared resources in collections

Collection structure

Testing collections

Developing `ansible-core`

Developing dynamic inventory

Adding modules and plugins locally<span id="using_local_modules_and_plugins"></span>