sdkagent

ansible API reference

400 public APIs from ansible (ansible/ansible) — 197 classes, 104 functions, 99 methods. Signatures extracted by static analysis of the actual source.

Repository: ansible/ansible

KindCount
Classes197
Functions104
Methods99

API list

funchacking.azp.download.download_run(args)
Download a run.
funchacking.azp.download.main()
Main program body.
funchacking.azp.download.parse_args()
Parse and return args.
funchacking.azp.incidental.incidental_report(args)
Generate incidental coverage report.
funchacking.azp.incidental.main()
Main program body.
funchacking.azp.incidental.parse_args()
Parse and return args.
funchacking.azp.run.main()
Main program body.
funchacking.azp.run.parse_args()
Parse and return args.
funchacking.azp.run.start_run(args, key)
Start a new CI run.
funchacking.backport.backport_of_line_adder.search_backport(pr, g, ansible_ansible)
Do magic.
classlib.ansible._internal._ansiballz._builder.ExtensionManager
AnsiballZ extension manager.
methodlib.ansible._internal._ansiballz._builder.ExtensionManager.create(task_vars:dict[str, object]) -> t.Self
Create an instance using the provided task vars.
classlib.ansible._internal._collection_proxy.SequenceProxy
A read-only sequence proxy.
classlib.ansible._internal._datatag._tags.SourceWasEncrypted
For internal use only.
funclib.ansible._internal._display_utils.get_deprecation_message_with_plugin_info(*msg:str, *version:str | None, *removed:bool=False, *date:str | None, *deprecator:_messages.PluginInfo | None) -> str
Internal use only.
funclib.ansible._internal._display_utils.join_sentences(first:str | None, second:str | None) -> str
Join two sentences together.
classlib.ansible._internal._errors._alarm_timeout.AnsibleTimeoutError
A general purpose timeout.
classlib.ansible._internal._errors._handler.ErrorAction
Action to take when an error is encountered.
classlib.ansible._internal._errors._task_timeout.TaskTimeoutError
A task-specific timeout.
funclib.ansible._internal._event_formatting.format_event(event:_messages.Event, include_traceback:bool) -> str
Format an event into a verbose message and traceback.
funclib.ansible._internal._event_formatting.format_event_traceback(event:_messages.Event) -> str
Format an event into a traceback.
funclib.ansible._internal._event_formatting.format_event_verbose_message(event:_messages.Event) -> str
Format an event into a verbose message.
classlib.ansible._internal._json.HasCurrent
Utility protocol for mixin type safety.
funclib.ansible._internal._json.json_dumps_formatted(value:object) -> str
Return a JSON dump of `value` with formatting and keys sorted.
classlib.ansible._internal._plugins._strategy.StrategyContext
Expose active strategy and TQM instances.
funclib.ansible._internal._powershell._clixml.replace_stderr_clixml(stderr:bytes) -> bytes
Replace CLIXML with stderr data.
funclib.ansible._internal._powershell._script.build_pwsh_cmd_statement(command:str, args:list[str] | None=None) -> str
Builds a PowerShell command statement.
funclib.ansible._internal._powershell._script.parse_encoded_cmdline(cmd:str) -> tuple[str, list[str]] | None
Parses a PowerShell encoded command line string.
funclib.ansible._internal._powershell._script.quote_pwsh_argument(value:str, *force_quote:bool=False) -> str
Quotes a value for use as a PowerShell argument.
classlib.ansible._internal._rpc_host.LocalContext
Minimal Context impl to support in-proc LocalManager.
classlib.ansible._internal._rpc_host.LocalManager
Customized BaseManager for in-proc usage.
methodlib.ansible._internal._rpc_host.LocalManager.shared_instance() -> t.Self
Access a lazily-created LocalManager singleton.
classlib.ansible._internal._rpc_host.LocalServer
Customized Server for in-proc LocalManager.
classlib.ansible._internal._ssh._ssh_agent.SshAgentFailure
Server failure or unexpected response.
classlib.ansible._internal._task.TaskContext
Ambient context that wraps task execution on workers.
classlib.ansible._internal._task.VariableLayer
Variable layer at which variables are registered.
funclib.ansible._internal._templating._transform.plugin_info(value:_messages.PluginInfo) -> dict[str, str]
Render PluginInfo as a dictionary.
funclib.ansible._internal._templating._transform.plugin_type(value:_messages.PluginType) -> str
Render PluginType as a string.
classlib.ansible.cli.CLI
code behind bin/ansible* programs
methodlib.ansible.cli.CLI.pager(text)
find reasonable way to display text
methodlib.ansible.cli.CLI.pager_pipe(text, pager=None)
pipe text through a pager
methodlib.ansible.cli.CLI.validate_conflicts(op, runas_opts=False, fork_opts=False)
check for conflicting options
methodlib.ansible.cli.CLI.version_info(gitinfo=False)
return full ansible version info
funclib.ansible.cli.arguments.option_helpers.add_verbosity_options(parser)
Add options for verbosity
funclib.ansible.cli.arguments.option_helpers.version(prog=None)
return ansible version
classlib.ansible.cli.config.ConfigCLI
Config command line class
methodlib.ansible.cli.config.ConfigCLI.execute_init()
Create initial configuration
methodlib.ansible.cli.config.ConfigCLI.execute_list()
list and output available configs
methodlib.ansible.cli.config.ConfigCLI.execute_view()
Displays the current config file
classlib.ansible.cli.doc.DocCLI
displays information on modules installed in Ansible libraries.
classlib.ansible.cli.galaxy.GalaxyCLI
Command to manage Ansible roles and collections.
methodlib.ansible.cli.galaxy.GalaxyCLI.execute_delete()
Delete a role from Ansible Galaxy.
methodlib.ansible.cli.galaxy.GalaxyCLI.execute_list()
List installed collections or roles
classlib.ansible.cli.vault.VaultCLI
can encrypt any structured data file used by Ansible.
methodlib.ansible.config.manager.ConfigManager.get_config_value(config:str, cfile:str | None=None, plugin_type:str | None=None, plugin_name:str | None=None, keys=None, variables=None, direct=None, *templar:Templar | None=None) -> t.Any
wrapper
funclib.ansible.config.manager.resolve_path(path:str, basedir:str | None=None) -> str
resolve relative or 'variable' paths
classlib.ansible.errors.AnsibleAction
Base Exception for Action plugin flow control.
classlib.ansible.errors.AnsibleActionFail
An action runtime failure.
classlib.ansible.errors.AnsibleActionSkip
An action runtime skip.
classlib.ansible.errors.AnsibleAssertionError
Invalid assertion.
classlib.ansible.errors.AnsibleAuthenticationFailure
Invalid username/password/key.
classlib.ansible.errors.AnsibleBrokenConditionalError
A broken conditional with non-boolean result was used.
classlib.ansible.errors.AnsibleCallbackError
A callback failure.
classlib.ansible.errors.AnsibleConnectionFailure
The transport / connection_plugin had a fatal error.
classlib.ansible.errors.AnsibleFieldAttributeError
Errors caused during field attribute processing.
classlib.ansible.errors.AnsibleFileNotFound
A file missing failure.
classlib.ansible.errors.AnsibleModuleError
A module failed somehow.
classlib.ansible.errors.AnsibleOptionsError
Invalid options were passed.
classlib.ansible.errors.AnsibleParserError
A playbook or data file could not be parsed.
classlib.ansible.errors.AnsiblePluginCircularRedirect
A cycle was detected in plugin redirection.
classlib.ansible.errors.AnsiblePluginNotFound
Indicates we did not find an Ansible plugin.
classlib.ansible.errors.AnsiblePluginRemovedError
A requested plugin has been removed.
classlib.ansible.errors.AnsiblePromptInterrupt
User interrupt.
classlib.ansible.errors.AnsiblePromptNoninteractive
Unable to get user input.
classlib.ansible.errors.AnsibleRequiredOptionError
Bad or incomplete options passed.
classlib.ansible.errors.AnsibleRuntimeError
Ansible had a problem while running a playbook.
classlib.ansible.errors.AnsibleTemplateError
A template related error.
classlib.ansible.errors.AnsibleTemplateTransformLimitError
The internal template transform limit was exceeded.
classlib.ansible.errors.AnsibleTypeError
Ansible-augmented TypeError subclass.
classlib.ansible.errors.AnsibleUndefinedConfigEntry
The requested config entry is not defined.
classlib.ansible.executor.process.worker.WorkerQueue
Queue that raises AnsibleError items on get().
classlib.ansible.executor.stats.AggregateStats
holds stats about per-host activity during playbook runs
methodlib.ansible.executor.stats.AggregateStats.set_custom_stats(which, what, host=None)
allow setting of a custom stat
classlib.ansible.galaxy.Galaxy
Keeps global galaxy info
classlib.ansible.galaxy.api.GalaxyError
Error for bad Galaxy server responses.
classlib.ansible.galaxy.collection.concrete_artifact_manager.ConcreteArtifactsManager
Manager for on-disk collection artifacts.
classlib.ansible.galaxy.collection.gpg.GpgBadArmor
The ASCII armor is corrupted.
classlib.ansible.galaxy.collection.gpg.GpgBadPassphrase
The supplied passphrase was wrong or not given.
classlib.ansible.galaxy.collection.gpg.GpgBadSig
The signature with the keyid has not been verified okay.
classlib.ansible.galaxy.collection.gpg.GpgErrSig
"It was not possible to check the signature.
classlib.ansible.galaxy.collection.gpg.GpgKeyExpired
The key has expired.
classlib.ansible.galaxy.collection.gpg.GpgKeyRevoked
The used key has been revoked by its owner.
classlib.ansible.galaxy.collection.gpg.GpgMissingPassPhrase
No passphrase was supplied.
classlib.ansible.galaxy.collection.gpg.GpgNoData
No data has been found.
classlib.ansible.galaxy.collection.gpg.GpgNoPubkey
The public key is not available.
classlib.ansible.galaxy.collection.gpg.GpgNoSecKey
The secret key is not available.
classlib.ansible.galaxy.collection.gpg.GpgUnexpected
No data has been found.
classlib.ansible.galaxy.dependency_resolution.dataclasses.Requirement
An abstract requirement request.
funclib.ansible.galaxy.dependency_resolution.versioning.is_pre_release(version:str) -> bool
Figure out if a given version is a pre-release.
classlib.ansible.galaxy.token.GalaxyToken
Class to storing and retrieving local galaxy token
classlib.ansible.galaxy.token.KeycloakToken
A token granted by a Keycloak server.
classlib.ansible.inventory.data.InventoryData
Holds inventory data (host and group objects).
methodlib.ansible.inventory.data.InventoryData.add_child(group:str, child:str) -> bool
Add host or group to group.
methodlib.ansible.inventory.data.InventoryData.get_host(hostname:str) -> Host | None
Fetch host object using name deal with implicit localhost.
methodlib.ansible.inventory.data.InventoryData.reconcile_inventory() -> None
Ensure inventory basic rules, run after updates.
methodlib.ansible.inventory.data.InventoryData.set_variable(entity:str, varname:str, value:t.Any) -> None
Sets a variable for an inventory object.
classlib.ansible.inventory.group.Group
A group of ansible hosts.
funclib.ansible.inventory.helpers.remove_trust(value:str) -> str
Remove trust from strings which should not be trusted.
classlib.ansible.inventory.host.Host
A single ansible host.
classlib.ansible.inventory.manager.InventoryManager
Creates and manages inventory
methodlib.ansible.inventory.manager.InventoryManager.clear_caches()
clear all caches
methodlib.ansible.inventory.manager.InventoryManager.refresh_inventory()
recalculate inventory
funclib.ansible.module_utils._embed.dnf.list_items(config, command)
List packages based on command.
classlib.ansible.module_utils._internal._ansiballz._extensions._coverage.Options
Code coverage options.
classlib.ansible.module_utils._internal._ansiballz._extensions._debugpy.Options
Debugger options for debugpy.
funclib.ansible.module_utils._internal._ansiballz._extensions._debugpy.run(args:dict[str, t.Any]) -> None
Enable remote debugging.
funclib.ansible.module_utils._internal._ansiballz._extensions._pydevd.run(args:dict[str, t.Any]) -> None
Enable remote debugging.
funclib.ansible.module_utils._internal._dataclass_validation.register_type(target_type:type) -> str
Register the target type and return the local name.
funclib.ansible.module_utils._internal._dataclass_validation.validate_value(target_name:str, target_ref:str, target_type:type) -> None
Generate code to validate the specified value.
classlib.ansible.module_utils._internal._datatag.AnsibleDatatagBase
Base class for data tagging tag types.
classlib.ansible.module_utils._internal._datatag.AnsibleSerializableEnum
Base class for serializable enumerations.
classlib.ansible.module_utils._internal._datatag.AnsibleTagHelper
Utility methods for working with Ansible data tags.
methodlib.ansible.module_utils._internal._datatag.AnsibleTagHelper.base_type(type_or_value:t.Any) -> type
Return the friendly type of the given type or value.
funclib.ansible.module_utils._internal._event_utils.format_event_brief_message(event:_messages.Event) -> str
Format an event into a brief message.
classlib.ansible.module_utils._internal._messages.EventChain
A chain used to link one event to another.
classlib.ansible.module_utils._internal._messages.PluginInfo
Information about a loaded plugin.
classlib.ansible.module_utils._internal._messages.PluginType
Enum of Ansible plugin types.
funclib.ansible.module_utils._internal._no_six.deprecate(importable_name:str, module_name:str, *deprecated_args) -> object
Inject import-time deprecation warnings.
classlib.ansible.module_utils._internal._traceback.TracebackEvent
The events for which tracebacks can be enabled.
funclib.ansible.module_utils._internal._validation.validate_collection_name(collection_name:object, name:str='collection_name') -> None
Validate a collection name.
funclib.ansible.module_utils._internal.get_controller_serialize_map() -> dict[type, t.Callable]
Called to augment serialization maps.
funclib.ansible.module_utils.api.rate_limit(rate=None, rate_limit=None)
rate limiting decorator
funclib.ansible.module_utils.api.retry(retries=None, retry_pause=1)
Retry decorator
classlib.ansible.module_utils.common.arg_spec.ValidationResult
Result of argument spec validation.
classlib.ansible.module_utils.common.collections.ImmutableDict
Dictionary that cannot be updated
funclib.ansible.module_utils.common.collections.is_iterable(seq:_c.Iterable, include_strings:bool=False) -> bool
Identify whether the input is an iterable.
funclib.ansible.module_utils.common.collections.is_sequence(seq:_c.Iterable, include_strings:bool=False) -> bool
Identify whether the input is a sequence.
funclib.ansible.module_utils.common.collections.is_string(seq:_c.Iterable) -> bool
Identify whether the input has a string-like type (including bytes).
funclib.ansible.module_utils.common.dict_transformations.dict_merge(a, b)
recursively merges dicts.
funclib.ansible.module_utils.common.json.get_decoder(profile:str | _types.ModuleType) -> type[_stdlib_json.JSONDecoder]
Return a `JSONDecoder` for the given `profile`.
funclib.ansible.module_utils.common.json.get_encoder(profile:str | _types.ModuleType) -> type[_stdlib_json.JSONEncoder]
Return a `JSONEncoder` for the given `profile`.
funclib.ansible.module_utils.common.network.to_bits(val)
converts a netmask to bits
funclib.ansible.module_utils.common.network.to_masklen(val)
converts a netmask to a masklen
funclib.ansible.module_utils.common.network.to_netmask(val)
converts a masklen to a netmask
funclib.ansible.module_utils.common.text.formatters.lenient_lowercase(lst)
Lowercase elements of a list.
funclib.ansible.module_utils.common.validation.check_type_raw(value)
Returns the raw value
funclib.ansible.module_utils.common.warnings.error_as_warning(msg:str | None, exception:BaseException, *help_text:str | None=None, *obj:object=None) -> None
Display an exception as a warning.
funclib.ansible.module_utils.common.warnings.warn(warning:str, *help_text:str | None=None, *obj:object | None=None) -> None
Record a warning to be returned with the module result.
classlib.ansible.module_utils.compat.version.LooseVersion
Version numbering for anarchists and software realists.
classlib.ansible.module_utils.compat.version.Version
Abstract base class for version numbering classes.
classlib.ansible.module_utils.distro._distro.LinuxDistribution
Provides information about a OS distribution.
methodlib.ansible.module_utils.distro._distro.LinuxDistribution.build_number(best:bool=False) -> str
Return the build number of the current distribution.
methodlib.ansible.module_utils.distro._distro.LinuxDistribution.codename() -> str
Return the codename of the OS distribution.
methodlib.ansible.module_utils.distro._distro.LinuxDistribution.name(pretty:bool=False) -> str
Return the name of the OS distribution, as a string.
methodlib.ansible.module_utils.distro._distro.LinuxDistribution.oslevel_info() -> str
Return AIX' oslevel command output.
methodlib.ansible.module_utils.distro._distro.LinuxDistribution.version(pretty:bool=False, best:bool=False) -> str
Return the version of the OS distribution, as a string.
classlib.ansible.module_utils.distro._distro.cached_property
A version of @property which caches the value.
funclib.ansible.module_utils.distro._distro.linux_distribution(full_distribution_name:bool=True) -> Tuple[str, str, str]
..
classlib.ansible.module_utils.errors.AliasError
Error handling aliases
classlib.ansible.module_utils.errors.AnsibleFallbackNotFound
Fallback validator was not found
classlib.ansible.module_utils.errors.AnsibleValidationError
Single argument spec validation error
classlib.ansible.module_utils.errors.AnsibleValidationErrorMultiple
Multiple argument spec validation errors
methodlib.ansible.module_utils.errors.AnsibleValidationErrorMultiple.append(error)
Append a new error to ``self.errors``.
classlib.ansible.module_utils.errors.ArgumentTypeError
Error with parameter type
classlib.ansible.module_utils.errors.ArgumentValueError
Error with parameter value
classlib.ansible.module_utils.errors.DeprecationError
Error processing parameter deprecations
classlib.ansible.module_utils.errors.ElementError
Error when validating elements
classlib.ansible.module_utils.errors.MutuallyExclusiveError
Mutually exclusive parameters were supplied
classlib.ansible.module_utils.errors.NoLogError
Error converting no_log values
classlib.ansible.module_utils.errors.RequiredDefaultError
A required parameter was assigned a default value
classlib.ansible.module_utils.errors.RequiredError
Missing a required parameter
classlib.ansible.module_utils.errors.RequiredIfError
Error with conditionally required parameters
classlib.ansible.module_utils.errors.RequiredOneOfError
Error with parameters where at least one is required
classlib.ansible.module_utils.errors.RequiredTogetherError
Error with parameters that are required together
classlib.ansible.module_utils.errors.SubParameterTypeError
Incorrect type for subparameter
classlib.ansible.module_utils.errors.UnsupportedError
Unsupported parameters were supplied
classlib.ansible.module_utils.facts.hardware.aix.AIXHardware
AIX-specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.darwin.DarwinHardware
Darwin-specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.freebsd.FreeBSDHardware
FreeBSD-specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.hpux.HPUXHardware
HP-UX-specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.hurd.HurdHardware
GNU Hurd specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.linux.LinuxHardware
Linux-specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.netbsd.NetBSDHardware
NetBSD-specific subclass of Hardware.
classlib.ansible.module_utils.facts.hardware.openbsd.OpenBSDHardware
OpenBSD-specific subclass of Hardware.
classlib.ansible.module_utils.facts.network.aix.AIXNetwork
This is the AIX Network Class.
classlib.ansible.module_utils.facts.network.base.Network
This is a generic Network subclass of Facts.
classlib.ansible.module_utils.facts.network.darwin.DarwinNetwork
This is the Mac macOS Darwin Network Class.
classlib.ansible.module_utils.facts.network.dragonfly.DragonFlyNetwork
This is the DragonFly Network Class.
classlib.ansible.module_utils.facts.network.freebsd.FreeBSDNetwork
This is the FreeBSD Network Class.
classlib.ansible.module_utils.facts.network.hpux.HPUXNetwork
HP-UX-specific subclass of Network.
classlib.ansible.module_utils.facts.network.hurd.HurdPfinetNetwork
This is a GNU Hurd specific subclass of Network.
classlib.ansible.module_utils.facts.network.linux.LinuxNetwork
This is a Linux-specific subclass of Network.
classlib.ansible.module_utils.facts.network.netbsd.NetBSDNetwork
This is the NetBSD Network Class.
classlib.ansible.module_utils.facts.network.openbsd.OpenBSDNetwork
This is the OpenBSD Network Class.
classlib.ansible.module_utils.facts.network.sunos.SunOSNetwork
This is the SunOS Network Class.
funclib.ansible.module_utils.facts.utils.get_file_lines(path, strip=True, line_sep=None)
get list of lines from file
classlib.ansible.module_utils.facts.virtual.base.Virtual
This is a generic Virtual subclass of Facts.
classlib.ansible.module_utils.facts.virtual.freebsd.FreeBSDVirtual
This is a FreeBSD-specific subclass of Virtual.
classlib.ansible.module_utils.facts.virtual.hpux.HPUXVirtual
This is a HP-UX specific subclass of Virtual.
classlib.ansible.module_utils.facts.virtual.linux.LinuxVirtual
This is a Linux-specific subclass of Virtual.
classlib.ansible.module_utils.facts.virtual.openbsd.OpenBSDVirtual
This is a OpenBSD-specific subclass of Virtual.
classlib.ansible.module_utils.facts.virtual.sunos.SunOSVirtual
This is a SunOS-specific subclass of Virtual.
funclib.ansible.module_utils.six.add_move(move)
Add an item to six.moves.
funclib.ansible.module_utils.six.ensure_str(s, encoding='utf-8', errors='strict')
Coerce *s* to `str`.
funclib.ansible.module_utils.six.ensure_text(s, encoding='utf-8', errors='strict')
Coerce *s* to six.text_type.
funclib.ansible.module_utils.six.exec_(_code_, _globs_=None, _locs_=None)
Execute code in a namespace.
funclib.ansible.module_utils.six.remove_move(name)
Remove item from six.moves.
classlib.ansible.module_utils.urls.ConnectionError
Failed to connect to the server
classlib.ansible.module_utils.urls.MissingModuleError
Failed to import 3rd party module required by the caller
classlib.ansible.module_utils.urls.MultipartProtocol
Protocol for multipart form-data generators.
methodlib.ansible.module_utils.urls.MultipartProtocol.add(name:bytes, filename:bytes | None=None, filepath:bytes | None=None, content:bytes | None=None, cte:_CTE | None=None, ct:bytes=_DEFAULT_MIME_TYPE) -> None
Add a field to the multipart body.
methodlib.ansible.module_utils.urls.MultipartProtocol.as_bytes() -> bytes
Return all multipart content as bytes.
methodlib.ansible.module_utils.urls.MultipartProtocol.content_type() -> str
Content-Type header value including boundary.
classlib.ansible.module_utils.urls.ProxyError
Failure to connect because of a proxy
methodlib.ansible.module_utils.urls.Request.delete(url, **kwargs)
Sends a DELETE request.
methodlib.ansible.module_utils.urls.Request.get(url, **kwargs)
Sends a GET request.
methodlib.ansible.module_utils.urls.Request.head(url, **kwargs)
Sends a HEAD request.
methodlib.ansible.module_utils.urls.Request.options(url, **kwargs)
Sends a OPTIONS request.
methodlib.ansible.module_utils.urls.Request.patch(url, data=None, **kwargs)
Sends a PATCH request.
methodlib.ansible.module_utils.urls.Request.post(url, data=None, **kwargs)
Sends a POST request.
methodlib.ansible.module_utils.urls.Request.put(url, data=None, **kwargs)
Sends a PUT request.
classlib.ansible.module_utils.urls.UnixHTTPConnection
Handles http requests to a unix socket file
classlib.ansible.module_utils.urls.UnixHTTPHandler
Handler for Unix urls
funclib.ansible.module_utils.urls.get_user_agent()
Returns a user agent used by open_url
funclib.ansible.modules.apt.get_cache_mtime()
Return mtime of a valid apt cache file.
funclib.ansible.modules.apt.mark_installed(m:AnsibleModule, packages:list[str], manual:bool) -> None
Mark packages as manually or automatically installed.
classlib.ansible.modules.dnf.DnfModule
DNF Ansible module back-end implementation
funclib.ansible.modules.file.get_state(path)
Find out current state
funclib.ansible.modules.find.agefilter(st, now, age, timestamp)
filter files older than age
funclib.ansible.modules.find.pfilter(f, patterns=None, excludes=None, use_regex=False)
filter using glob patterns
funclib.ansible.modules.find.sizefilter(st, size)
filter files greater than size
funclib.ansible.modules.git.git_version(git_path, module)
return the installed version of git
funclib.ansible.modules.git.head_splitter(headfile, remote, module=None, fail_on_error=False)
Extract the head reference
funclib.ansible.modules.git.set_remote_url(git_path, module, repo, dest, remote)
updates repo from remote sources
classlib.ansible.modules.group.AIX
This is a AIX Group manipulation class.
classlib.ansible.modules.group.DarwinGroup
This is a Mac macOS Darwin Group manipulation class.
classlib.ansible.modules.group.DragonFlyBsdGroup
This is a DragonFlyBSD Group manipulation class.
classlib.ansible.modules.group.FreeBsdGroup
This is a FreeBSD Group manipulation class.
classlib.ansible.modules.group.Linux
This is a Linux Group manipulation class.
classlib.ansible.modules.group.NetBsdGroup
This is a NetBSD Group manipulation class.
classlib.ansible.modules.group.OpenBsdGroup
This is a OpenBSD Group manipulation class.
classlib.ansible.modules.group.SunOS
This is a SunOS Group manipulation class.
classlib.ansible.modules.hostname.DarwinStrategy
This is a macOS hostname manipulation strategy class.
funclib.ansible.modules.known_hosts.enforce_state(module, params)
Add or remove key.
funclib.ansible.modules.mount_facts.gen_mounts_from_stdout(stdout:str) -> t.Iterable[MountInfo]
List mount dictionaries from mount stdout.
funclib.ansible.modules.mount_facts.get_argument_spec()
Helper returning the argument spec.
funclib.ansible.modules.mount_facts.get_device_by_uuid(module:AnsibleModule, uuid:str) -> str | None
Get device information by UUID.
funclib.ansible.modules.mount_facts.get_partition_uuid(module:AnsibleModule, partname:str) -> str | None
Get the UUID of a partition by its name.
funclib.ansible.modules.mount_facts.get_sources(module:AnsibleModule) -> list[str]
Return a list of filenames from the requested sources.
funclib.ansible.modules.mount_facts.list_uuids_linux() -> list[str]
List UUIDs from the system.
funclib.ansible.modules.mount_facts.run_lsblk(module:AnsibleModule) -> list[list[str]]
Return device, UUID pairs from lsblk.
funclib.ansible.modules.mount_facts.run_mount_bin(module:AnsibleModule, mount_bin:str) -> str
Execute the specified mount binary with optional timeout.
classlib.ansible.modules.pip.Package
Python distribution package metadata wrapper.
classlib.ansible.modules.rpm_key.LibRPM
Wrapper for librpm PGP key functions.
funclib.ansible.modules.rpm_key.is_pubkey(string:str) -> bool
Verifies if string is a pubkey
funclib.ansible.modules.unarchive.crc32(path, buffer_size)
Return a CRC32 checksum of a file
classlib.ansible.modules.user.AIX
This is a AIX User manipulation class.
classlib.ansible.modules.user.Alpine
This is the Alpine User manipulation class.
classlib.ansible.modules.user.DarwinUser
This is a Darwin macOS User manipulation class.
methodlib.ansible.modules.user.DarwinUser.remove_user()
Delete SELF.NAME.
classlib.ansible.modules.user.HPUX
This is a HP-UX User manipulation class.
classlib.ansible.modules.user.NetBSDUser
This is a NetBSD User manipulation class.
classlib.ansible.modules.user.OpenBSDUser
This is a OpenBSD User manipulation class.
funclib.ansible.parsing.utils.jsonify.jsonify(result, format=False)
Format JSON output.
classlib.ansible.parsing.vault.VaultHelper
Vault specific utility methods.
classlib.ansible.parsing.vault.VaultSecret
Opaque/abstract objects for a single vault secret.
methodlib.ansible.parsing.vault.VaultSecret.bytes()
The secret as a bytestring.
classlib.ansible.parsing.vault.VaultSecretsContext
Provides context-style access to vault secrets.
methodlib.ansible.playbook.play.Play.argument_spec() -> dict
Retrieve the argument spec if one is configured.
methodlib.ansible.playbook.play.Play.get_name()
return the name of the Play
methodlib.ansible.playbook.task.Task.get_name(include_role_fqcn=True)
return the name of the task
classlib.ansible.plugins.action.fail.ActionModule
Fail with custom message
methodlib.ansible.plugins.action.fetch.ActionModule.run(tmp=None, task_vars=None)
handler for fetch operations
classlib.ansible.plugins.action.group_by.ActionModule
Create inventory groups based on variables
methodlib.ansible.plugins.action.pause.ActionModule.run(tmp=None, task_vars=None)
run the pause action module
methodlib.ansible.plugins.action.script.ActionModule.run(tmp:str | None=None, task_vars:dict[str, _t.Any] | None=None) -> dict[str, _t.Any]
handler for file transfer operations
classlib.ansible.plugins.action.validate_argument_spec.ActionModule
Validate an arg spec
classlib.ansible.plugins.cache.BaseFileCacheModule
A caching module backed by file based storage.
classlib.ansible.plugins.cache.CachePluginAdjudicator
Batch update wrapper around a cache plugin.
classlib.ansible.plugins.cache.jsonfile.CacheModule
A caching module backed by json files.
classlib.ansible.plugins.callback.CallbackBase
This is a base ansible callback class that does nothing.
methodlib.ansible.plugins.callback.CallbackBase.v2_runner_on_failed(result:CallbackTaskResult, ignore_errors:bool=False) -> None
Process results of a failed task.
methodlib.ansible.plugins.callback.CallbackBase.v2_runner_on_ok(result:CallbackTaskResult) -> None
Process results of a successful task.
methodlib.ansible.plugins.callback.CallbackBase.v2_runner_on_skipped(result:CallbackTaskResult) -> None
Process results of a skipped task.
classlib.ansible.plugins.callback.junit.HostData
Data about an individual host.
classlib.ansible.plugins.callback.junit.TaskData
Data about an individual task.
classlib.ansible.plugins.cliconf.CliconfBase
A base class for implementing cli connections ..
classlib.ansible.plugins.connection.ConnectionBase
A base class for connections to contain common code.
methodlib.ansible.plugins.connection.ConnectionBase.close() -> None
Terminate the connection
methodlib.ansible.plugins.connection.ConnectionBase.exec_command(cmd:str, in_data:bytes | None=None, sudoable:bool=True) -> tuple[int, bytes, bytes]
Run a command on the remote host.
methodlib.ansible.plugins.connection.ConnectionBase.put_file(in_path:str, out_path:str) -> None
Transfer a file from local to remote
classlib.ansible.plugins.connection.NetworkConnectionBase
A base class for network-style connections.
methodlib.ansible.plugins.connection.NetworkConnectionBase.fetch_file(in_path:str, out_path:str) -> None
Fetch a file from remote to local
methodlib.ansible.plugins.connection.NetworkConnectionBase.put_file(in_path:str, out_path:str) -> None
Transfer a file from local to remote
methodlib.ansible.plugins.connection.NetworkConnectionBase.reset() -> None
Reset the connection
classlib.ansible.plugins.connection.local.Connection
Local based connections
methodlib.ansible.plugins.connection.local.Connection.close() -> None
terminate the connection; nothing to do here
methodlib.ansible.plugins.connection.local.Connection.exec_command(cmd:str, in_data:bytes | None=None, sudoable:bool=True) -> tuple[int, bytes, bytes]
run a command on the local host
methodlib.ansible.plugins.connection.local.Connection.fetch_file(in_path:str, out_path:str) -> None
fetch a file from local to local -- for compatibility
methodlib.ansible.plugins.connection.local.Connection.put_file(in_path:str, out_path:str) -> None
transfer a file from local to local
classlib.ansible.plugins.connection.ssh.AnsibleControlPersistBrokenPipeError
ControlPersist broken pipe
classlib.ansible.plugins.connection.ssh.Connection
ssh based connections
methodlib.ansible.plugins.connection.ssh.Connection.exec_command(cmd:str, in_data:bytes | None=None, sudoable:bool=True) -> tuple[int, bytes, bytes]
run a command on the remote host
methodlib.ansible.plugins.connection.ssh.Connection.fetch_file(in_path:str, out_path:str) -> tuple[int, bytes, bytes]
fetch a file from remote to local
methodlib.ansible.plugins.connection.ssh.Connection.put_file(in_path:str, out_path:str) -> tuple[int, bytes, bytes]
transfer a file from local to remote
classlib.ansible.plugins.connection.winrm.Connection
WinRM connections over HTTP/HTTPS.
classlib.ansible.plugins.filter.core.FilterModule
Ansible core jinja2 filters
funclib.ansible.plugins.filter.core.from_json(a, profile:str | None=None, **kwargs) -> t.Any
Deserialize JSON with an optional decoder profile.
funclib.ansible.plugins.filter.core.mandatory(a:object, msg:str | None=None) -> object
Make a variable mandatory.
funclib.ansible.plugins.filter.core.strftime(string_format:str, second:float | None=None, utc:bool=False) -> str
return a date string using string.
funclib.ansible.plugins.filter.core.ternary(value, true_val, false_val, none_val=None)
value ?
funclib.ansible.plugins.filter.core.to_bool(value:object) -> bool
Convert well-known input values to a boolean value.
funclib.ansible.plugins.filter.core.to_json(a, profile:str | None=None, vault_to_text:t.Any=..., preprocess_unsafe:t.Any=..., **kwargs) -> str
Serialize as JSON with an optional encoder profile.
funclib.ansible.plugins.filter.core.to_nice_yaml(a, indent=4, *default_flow_style=False, *_args, **kwargs) -> str
Serialize input as verbose multi-line YAML.
funclib.ansible.plugins.filter.core.to_yaml(a, *default_flow_style:bool | None=None, *vault_behavior:str | None=None, *_args, **kwargs) -> str
Serialize input as terse flow-style YAML.
classlib.ansible.plugins.filter.encryption.FilterModule
Ansible vault jinja2 filters
classlib.ansible.plugins.filter.mathstuff.FilterModule
Ansible math jinja2 filters
classlib.ansible.plugins.filter.urls.FilterModule
Ansible core jinja2 filters
classlib.ansible.plugins.filter.urlsplit.FilterModule
URI filter
classlib.ansible.plugins.inventory.BaseFileInventoryPlugin
Parses a File based Inventory Source
classlib.ansible.plugins.inventory.BaseInventoryPlugin
Parses an Inventory Source
classlib.ansible.plugins.inventory.Cacheable
Mixin for inventory plugins which support caching.
methodlib.ansible.plugins.loader.PluginLoader.has_plugin(name:str, collection_list:list[str] | None=None) -> bool
Checks if a plugin named name exists
classlib.ansible.plugins.netconf.NetconfBase
A base class for implementing Netconf connections ..
methodlib.ansible.plugins.strategy.Debugger.do_EOF(args)
Quit
methodlib.ansible.plugins.strategy.Debugger.do_continue(args)
Continue to next result
methodlib.ansible.plugins.strategy.Debugger.do_pprint(args)
Pretty Print
methodlib.ansible.plugins.strategy.Debugger.do_quit(args)
Quit
methodlib.ansible.plugins.strategy.Debugger.do_redo(args)
Schedule task for re-execution.
classlib.ansible.plugins.strategy.NextAction
The next action after an interpreter's exit.
classlib.ansible.plugins.terminal.TerminalBase
A base class for implementing cli connections ..
classlib.ansible.plugins.vars.BaseVarsPlugin
Loads variables for groups and/or hosts
methodlib.ansible.plugins.vars.BaseVarsPlugin.get_vars(loader, path, entities)
Gets variables.
classlib.ansible.template.Templar
Primary public API container for Ansible's template engine.
methodlib.ansible.template.Templar.basedir() -> str
The basedir from DataLoader.
methodlib.ansible.template.Templar.do_template(data:_t.Any, preserve_trailing_newlines:bool=True, escape_backslashes:bool=True, fail_on_undefined:bool=True, overrides:dict[str, _t.Any] | None=None, disable_lookups:bool=_UNSET, convert_data:bool=_UNSET) -> _t.Any
Deprecated.
methodlib.ansible.template.Templar.environment() -> _environment.Environment
Deprecated.
funclib.ansible.template.trust_as_template(value:T) -> T
Returns `value` tagged as trusted for templating.
classlib.ansible.utils._junit_xml.TestCase
An individual test case.
methodlib.ansible.utils._junit_xml.TestCase.get_xml_element() -> ET.Element
Return an XML element representing this instance.
methodlib.ansible.utils._junit_xml.TestCase.is_error() -> bool
True if the test case contains error info.
methodlib.ansible.utils._junit_xml.TestCase.is_failure() -> bool
True if the test case contains failure info.
methodlib.ansible.utils._junit_xml.TestCase.is_skipped() -> bool
True if the test case was skipped.
classlib.ansible.utils._junit_xml.TestError
Error info for a test case.
methodlib.ansible.utils._junit_xml.TestError.tag() -> str
Tag name for the XML element created by this result type.
classlib.ansible.utils._junit_xml.TestFailure
Failure info for a test case.
classlib.ansible.utils._junit_xml.TestResult
Base class for the result of a test case.
methodlib.ansible.utils._junit_xml.TestResult.get_attributes() -> dict[str, str]
Return a dictionary of attributes for this instance.
methodlib.ansible.utils._junit_xml.TestResult.get_xml_element() -> ET.Element
Return an XML element representing this instance.
methodlib.ansible.utils._junit_xml.TestResult.tag() -> str
Tag name for the XML element created by this result type.
classlib.ansible.utils._junit_xml.TestSuite
A collection of test cases.
methodlib.ansible.utils._junit_xml.TestSuite.disabled() -> int
The number of disabled test cases.
methodlib.ansible.utils._junit_xml.TestSuite.errors() -> int
The number of test cases containing error info.
methodlib.ansible.utils._junit_xml.TestSuite.failures() -> int
The number of test cases containing failure info.
methodlib.ansible.utils._junit_xml.TestSuite.get_xml_element() -> ET.Element
Return an XML element representing this instance.
methodlib.ansible.utils._junit_xml.TestSuite.skipped() -> int
The number of test cases containing skipped info.
methodlib.ansible.utils._junit_xml.TestSuite.tests() -> int
The number of test cases.
methodlib.ansible.utils._junit_xml.TestSuite.time() -> decimal.Decimal
The total time from all test cases.
classlib.ansible.utils._junit_xml.TestSuites
A collection of test suites.
methodlib.ansible.utils._junit_xml.TestSuites.disabled() -> int
The number of disabled test cases.
methodlib.ansible.utils._junit_xml.TestSuites.errors() -> int
The number of test cases containing error info.
methodlib.ansible.utils._junit_xml.TestSuites.failures() -> int
The number of test cases containing failure info.
methodlib.ansible.utils._junit_xml.TestSuites.get_xml_element() -> ET.Element
Return an XML element representing this instance.
methodlib.ansible.utils._junit_xml.TestSuites.tests() -> int
The number of test cases.
methodlib.ansible.utils._junit_xml.TestSuites.time() -> decimal.Decimal
The total time from all test cases.
funclib.ansible.utils.color.colorize(lead, num, color)
Print 'lead' = 'num' in 'color'
funclib.ansible.utils.color.stringc(text, color, wrap_nonvisible_chars=False)
String in color.
classlib.ansible.utils.context_objects.GlobalCLIArgs
Globally hold a parsed copy of cli arguments.
methodlib.ansible.utils.display.Display.error(msg:str | BaseException, wrap_text:bool=True, stderr:bool=True) -> None
Display an error message.
methodlib.ansible.utils.display.Display.error_as_warning(msg:str | None, exception:BaseException, *help_text:str | None=None, *obj:t.Any=None) -> None
Display an exception as a warning.
methodlib.ansible.utils.display.Display.warning(msg:str, formatted:bool=False, *help_text:str | None=None, *obj:t.Any=None) -> None
Display a warning message.
funclib.ansible.utils.display.setraw(fd:int, when:int=termios.TCSAFLUSH) -> None
Put terminal into a raw mode.
funclib.ansible.utils.vars.isidentifier(ident)
Determine if string is valid identifier.
funclib.ansible.utils.vars.transform_to_native_types(value:object, redact:bool=True) -> t.Any
Recursively transform the given value to Python native types.
funclib.ansible.vars.clean.namespace_facts(facts:Mapping[str, object]) -> dict[str, object]
return all facts inside 'ansible_facts' w/o an ansible_ prefix
funclib.ansible.vars.manager.VariableManager.groups_inventory()
gets group vars from inventory
classpackaging.cli-doc.build.ActionDoc
Documentation for an action.
funcpackaging.cli-doc.build.build_json(output_file:pathlib.Path) -> None
Build JSON documentation for ansible-core CLI programs.
funcpackaging.cli-doc.build.build_man(output_dir:pathlib.Path, template_file:pathlib.Path) -> None
Build man pages for ansible-core CLI programs.
funcpackaging.cli-doc.build.build_rst(output_dir:pathlib.Path, template_file:pathlib.Path) -> None
Build RST documentation for ansible-core CLI programs.
funcpackaging.cli-doc.build.collect_programs() -> dict[str, dict[str, t.Any]]
Return information about CLI programs.
funcpackaging.cli-doc.build.generate_options_docs(source_file:pathlib.Path, cli_bin_name_list:list[str]) -> tuple[str, dict[str, t.Any]]
Generate doc structure from CLI module options.
funcpackaging.cli-doc.build.generate_rst(template_file:pathlib.Path) -> dict[str, str]
Generate RST pages using the provided template.
funcpackaging.cli-doc.build.get_action_docs(parser:argparse.ArgumentParser) -> list[ActionDoc]
Get action documentation from the given argument parser.
funcpackaging.cli-doc.build.main() -> None
Main program entry point.
classpackaging.release.ApplicationError
A fatal application error which will be shown without a traceback.
classpackaging.release.CalledProcessError
Results from a failed process.
classpackaging.release.CommandFramework
Simple command line framework inspired by nox.
methodpackaging.release.CommandFramework.main() -> None
Main program entry point.
methodpackaging.release.CommandFramework.run(*args:t.Callable[..., None], **kwargs) -> None
Run the specified command(s), using any provided internal args.
classpackaging.release.CompletedProcess
Results from a completed process.
classpackaging.release.Display
Display interface for sending output to the console.
methodpackaging.release.Display.fatal(message:t.Any) -> None
Print a fatal message to the console.
methodpackaging.release.Display.show(message:t.Any, color:str | None=None) -> None
Print a message to the console.
methodpackaging.release.Display.warning(message:t.Any) -> None
Print a warning message to the console.
classpackaging.release.GitHubRelease
Details required to create a GitHub release.
classpackaging.release.GitState
Details about the state of the git repository.
classpackaging.release.PullRequest
Details required to create a pull request.
classpackaging.release.ReleaseArtifact
Information about a release artifact on PyPI.
classpackaging.release.Remote
Details about a git remote.

About this data

These signatures were extracted from the public source of ansible/ansible using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries