All Classes and Interfaces

Class
Description
Abstract class for all function calls in salt.
Implements basic listener bookkeeping for EventStream.
Base class for all target types
Strict null rejecting primitive type adapters.
Representation of applications statistics.
Representation of args and kwargs.
Json TypeAdapter for Arguments class.
Simple abstraction over async http operations needed by the salt client.
Datatype holding data for authentication which can either be password based or token based.
Salt authentication modules.
A class representing the batch parameter.
Helper class for building a Batch.
Represents an event fired when a batch job starts.
Data object of the batch started event
salt.modules.beacons
Status result of many beacon functions
Represents an event fired by beacons
Interface for all function calls in salt.
Represents a change from some old value to a new one.
Possible values for the client parameter in salt netapi calls.
Utilities for SaltClient.
salt.modules.cmdmod
Result structure as returned by cmd.exec_code_all, cmd.run_all, cmd.script to be parsed from event data.
Adapt a homogeneous collection of objects.
Adapter for the Collections.
Target for specifying minions by compound expression.
Returns configuration information from minions.
Data field of a WheelResult.
TypeAdapter for date representation received from the API (which represents it as a (floating) number of seconds since the Epoch).
Base class for all grain and pillar target types
Represents an event fired by engines
salt.modules.event
salt.runners.event
Parse events into objects.
Defines a client notification interface for events stream.
Represents a container of listener to Event; for each message a bunch of EventListener will be recalled and notified with it.
Basic operations on files and directories on minions
File module result object
Like java.util.function.Function but can throw SaltException
Salt error when trying to execute a function that does not exist
Catch all error that contains only a error messages.
salt.modules.git
Result structure as returned by git status.
Target for specifying minions by glob pattern.
salt.modules.grains
Matcher based on salt grains
Matcher based on salt grains
The type of hash based on Python hashlib - only always supported types.
AsyncHttpClient implemented with Apache's HttpAsyncClient.
Helpers for creating an async http client
Representation of HTTP server statistics.
Target for specifying minions by IP CIDR.
Representation of job return events fired each time a minion returns data for a job.
Data object of the job return event
salt.runners.jobs
Information about a salt job as returned by 'jobs.list_job'
Result entry of jobs.list_jobs
Parser for Salt API responses.
Json parsing error that contains the rest of the json which could not be parsed.
salt.wheel.key
Matching key fingerprints as returned by "key.finger".
Salt keys information.
Salt keys as returned by "key.list_all".
A key pair as returned by "key.gen" or "key.gen_accept".
Result of calling a execution module function asynchronously.
Class representing a function call of a salt execution module.
Adapter to convert an ISO formatted string to LocalDateTime
salt.modules.locate Module for using the mlocate utilities.
All possible options for "locate" method.
Locate module result object
salt.runners.manage
salt.modules.match
Exception to be thrown in case of a websocket message exceeding the configurable maximum message length.
salt.modules.minion https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.minion.html
Target for specifying a list of minions.
salt.wheel.minions
Represents an event fired when a minion connects to the salt master
Error that happens if a modules is not supported
result of a module.run in a state file
salt.modules.network
Network interface as returned by "network.interfaces".
Network interface (IPv6) as returned by "network.interfaces".
Network interface as returned by "network.interfaces".
Target for referencing a nodegroup.
salt.modules.openscap
openscap.xccdf result.
TypeAdaptorFactory creating TypeAdapters for Optional
Exception to be thrown in case of problems parsing service responses.
Datatype for holding all data needed for password authentication
Information about a pattern as returned by "pkg.list_patterns".
Matcher based on salt pillar with glob matching
Matcher based on salt pillar without glob matching
Matcher based on salt pillar with regular expression matching
salt.modules.pkg
Information about a package as returned by pkg.info_installed and pkg.info_available
Package dictionary as returned by "pkg.file_dict".
Information about a package as returned by "pkg.search".
Target for specifying minions by range expression.
Target for specifying minions by regular expression.
Representation of request statistics.
Representation of call results for a single minion implemented as a wrapper around Xor.
Represents an event containing the result of some function call
TypeAdapterFactory for creating type adapters for parsing wrapped Result<SSHResult> objects.
TypeAdapterFactory for creating type adapters for parsing Result objects.
Wrapper object representing a "ret" element to be parsed from event data.
Represents a Salt API result.
Result of calling a runner module function asynchronously.
Class representing a function call of a salt runner module.
Representation of job return events fired each time a minion returns data for a job.
Data object of the job return event
Salt API client.
Interface for all salt related errors
Utils for deriving SaltError based on the salt text output.
Exception to be thrown in case of problems with Salt.
Salt SSH configuration with a builder class.
Builder class to create configurations for Salt SSH.
Interface for salt ssh specific errors
Salt SSH utility class with shared methods.
Exception for when a user is logged in but not allowed access to the requested resource.
salt.modules.saltutil
Info about a running job on a minion
Represents a salt version
salt.modules.schedule
Common result structure for scheduling functions
Common class representing a scheduled job.
Representation of server thread statistics.
salt.modules.smbios
Holds the information returned by smbios.records
The type of the dmi records.
Wrapper class for salt-ssh raw calls results.
Wrapper class for salt-ssh results.
Target interface for specifying a group of minions.
StartDate is a convenience wrapper allowing for parsing of StartDate in the timezone appropriate to a given master.
Json adapter to handle the Job.StartTime date format given by netapi
salt.modules.state
Result type for state.apply
Result structure as returned by state.apply to be parsed from event data.
Representation of CherryPy server statistics.
Json TypeAdapter for the Stats object received from the API.
salt.modules.status
salt.modules.system https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.system.html
Target interface for specifying a group of minions.
Possible values for the tgt_type parameter in salt netapi calls.
salt.modules.test
Availability report of all execution modules
Version report of dependent and system software
salt.modules.timezone https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.timezone.html
Token containing authentication data.
salt.modules.transactional_update https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.transactional_update.html
Event stream implementation based on a ClientEndpoint WebSocket.
Result of calling a wheel module function asynchronously.
Class representing a function call of a salt wheel module.
Wrapper around the wheel functions return type.
Right biased disjunction mainly based on the Xor type from scala cats library.
Left branch of the Xor
Right branch of the Xor
TypeAdaptorFactory creating TypeAdapters for Xor
Adapter to convert an ISO formatted string to ZonedDateTime
salt.modules.zypper https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.zypper.html
The product information as returned by listProducts().